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

Class BooleanValidator

java.lang.Object

org.esa.snap.core.param.AbstractParamValidator

org.esa.snap.core.param.validators.BooleanValidator

All Implemented Interfaces:

ParamValidator

public class BooleanValidator
extends AbstractParamValidator

Field Summary

Fields

Modifier and Type	Field	Description
static String	FALSE_STRING
static String	TRUE_STRING

Fields inherited from class org.esa.snap.core.param.AbstractParamValidator

_logger

Constructor Summary

Constructors

Constructor	Description
BooleanValidator()

Method Summary

Modifier and Type	Method	Description
protected static Boolean	castToBoolean(Object value)
String	format(Parameter parameter, Object value)	Returns the given Boolean value as a string, according to the rules of the given parameter.
Object	parse(Parameter parameter, String text)	Converts the given text into a value taking the given parameter information into account.
void	validate(Parameter parameter, Object value)	Tests if the given value passes all constraints given in the supplied parameter information.

Methods inherited from class org.esa.snap.core.param.AbstractParamValidator

equalValues, isAllowedNullText, isAllowedNullValue, isValueContainedInValueSet, validateThatNullValueIsAllowed, validateThatValueIsInValueSet, validateThatValuesAreInValueSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRUE_STRING

public static final String TRUE_STRING

See Also:

Constant Field Values

FALSE_STRING

public static final String FALSE_STRING

See Also:

Constant Field Values

Constructor Detail

BooleanValidator

public BooleanValidator()

Method Detail

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 Boolean value as a string, according to the rules of the given 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 Boolean.

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

castToBoolean

protected static Boolean castToBoolean(Object value)