bundles/org.simantics.application/src/org/simantics/application/arguments/IArgumentValidator.java

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