Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.application / src / org / simantics / application / arguments / IArgumentValidator.java

diff --git a/bundles/org.simantics.application/src/org/simantics/application/arguments/IArgumentValidator.java b/bundles/org.simantics.application/src/org/simantics/application/arguments/IArgumentValidator.java
new file mode 100644 (file)
index 0000000..ebe0272
--- /dev/null
+++ b/bundles/org.simantics.application/src/org/simantics/application/arguments/IArgumentValidator.java
@@ -0,0 +1,28 @@
+/*******************************************************************************\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.application.arguments;\r
+\r
+public interface IArgumentValidator<T> {\r
+\r
+    /**\r
+     * Validates the given argument. Returns an error message to display if the\r
+     * new text is invalid. Returns <code>null</code> if there is no error.\r
+     * Note that the empty string is not treated the same as <code>null</code>;\r
+     * it indicates an error state but with no message to display.\r
+     * \r
+     * @param newText the text to check for validity\r
+     * \r
+     * @return an error message or <code>null</code> if no error\r
+     */\r
+    public String isValid(T newText);\r
+\r
+}\r