]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.application/src/org/simantics/application/arguments/IArgumentValidator.java
ebe0272be0e13b13a2a8d649e91a4945e90cb580
[simantics/platform.git] / bundles / org.simantics.application / src / org / simantics / application / arguments / IArgumentValidator.java
1 /*******************************************************************************\r
2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
3  * in Industry THTH ry.\r
4  * All rights reserved. This program and the accompanying materials\r
5  * are made available under the terms of the Eclipse Public License v1.0\r
6  * which accompanies this distribution, and is available at\r
7  * http://www.eclipse.org/legal/epl-v10.html\r
8  *\r
9  * Contributors:\r
10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
11  *******************************************************************************/\r
12 package org.simantics.application.arguments;\r
13 \r
14 public interface IArgumentValidator<T> {\r
15 \r
16     /**\r
17      * Validates the given argument. Returns an error message to display if the\r
18      * new text is invalid. Returns <code>null</code> if there is no error.\r
19      * Note that the empty string is not treated the same as <code>null</code>;\r
20      * it indicates an error state but with no message to display.\r
21      * \r
22      * @param newText the text to check for validity\r
23      * \r
24      * @return an error message or <code>null</code> if no error\r
25      */\r
26     public String isValid(T newText);\r
27 \r
28 }\r