Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / element / handler / Validator.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Validator.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Validator.java
new file mode 100644 (file)
index 0000000..6726188
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Validator.java
@@ -0,0 +1,51 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.g2d.element.handler;\r
+\r
+import java.util.Collection;\r
+\r
+import org.simantics.g2d.canvas.ICanvasContext;\r
+import org.simantics.g2d.element.IElement;\r
+\r
+/**\r
+ * This interface is implemented by all element contributions that\r
+ * have fields to be validated. \r
+ * \r
+ * @author Toni Kalajainen\r
+ */\r
+public interface Validator extends ElementHandler {\r
+       \r
+       public interface Suggestion {\r
+               String  getMessage(IElement e, ICanvasContext ctx);\r
+               /**\r
+                * \r
+                * @param e\r
+                * @param ctx\r
+                * @return\r
+                */\r
+               boolean fix(IElement e, ICanvasContext ctx);\r
+       }\r
+       \r
+       public interface Issue {\r
+               String  getMessage(IElement e, ICanvasContext ctx);\r
+               /**\r
+                * \r
+                * @param e\r
+                * @param ctx\r
+                * @param suggestionList instances are should be static, shareable \r
+                */\r
+               void    addSuggestions(IElement e, ICanvasContext ctx, Collection<Suggestion> suggestionList);\r
+       }\r
+               \r
+       void validate(IElement e, ICanvasContext ctx, Collection<Issue> lst);   \r
+\r
+}\r