Package org.esa.snap.core.param.validators

Class StringArrayValidator

java.lang.Object
org.esa.snap.core.param.AbstractParamValidator
org.esa.snap.core.param.validators.StringArrayValidator
All Implemented Interfaces:
ParamValidator
public class StringArrayValidator extends AbstractParamValidator

  • Constructor Details

    • StringArrayValidator

      public StringArrayValidator()

  • Method Details

    • parse

      public Object parse(Parameter parameter, String text) throws ParamParseException
      Description copied from interface: ParamValidator
      Converts the given text into a value taking the given parameter information into account.
      Parameters:
      parameter - the parameter, must not be null
      text - the text to be converted into a value, must not be null
      Returns:
      the value represented by the text
      Throws:
      ParamParseException

    • format

      public String format(Parameter parameter, Object value) throws ParamFormatException
      Returns the given string array value as a string, according to the rules of the parameter. If the value is null and null value is allowed, this method returns an empty string, otherwise a ParamFormatException will be thrown.
      Parameters:
      parameter - the parameter which contains the rules to format
      value - the value to format
      Returns:
      the value as string or an empty string.
      Throws:
      ParamFormatException - if the value is null and null value is not allowed or the value is not an instance of String[].

    • validate

      public void validate(Parameter parameter, Object value) throws ParamValidateException
      Description copied from interface: ParamValidator
      Tests if the given value passes all constraints given in the supplied parameter information. The value can also be null since parameters can be allowed to have the value 'null'.
      Parameters:
      parameter - the parameter, must not be null
      value - the value to be tested, can be null
      Throws:
      ParamValidateException

    • validateThatValueIsAnAllowedEmptyValue

      protected void validateThatValueIsAnAllowedEmptyValue(Parameter parameter, Object value) throws ParamValidateException
      Throws:
      ParamValidateException

    • equalValues

      public boolean equalValues(Parameter parameter, Object value1, Object value2)
      Description copied from interface: ParamValidator
      Tests if the given two values are equal taking the given parameter information into account.
      Specified by:
      equalValues in interface ParamValidator
      Overrides:
      equalValues in class AbstractParamValidator
      Parameters:
      parameter - the parameter, must not be null
      value1 - the first value, can be null
      value2 - the second value, can also be null
      Returns:
      true if the value are equal, false otherwise

    • getValueSetIndices

      public int[] getValueSetIndices(Parameter parameter)

    • castToStringArray

      protected static String[] castToStringArray(Object value)

    • getValueSetIndex

      protected static int getValueSetIndex(String[] valueSet, String value, boolean caseSensitive)