rescuecore2.config

Interface ValueConstraint

All Superinterfaces:

ConfigConstraint

All Known Implementing Classes:

AbstractValueConstraint, ClassNameSetValueConstraint, ClassNameValueConstraint, DiscreteValueConstraint, FloatValueConstraint, IntegerValueConstraint

public interface ValueConstraint
extends ConfigConstraint

Interface for specifying constraints on a config value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Get the key this restraint refers to.
boolean	isValid(java.lang.String value, Config config) Check if a value is valid.
boolean	undefinedIsValid() Find out if an undefined value is counted as valid or invalid.

Methods inherited from interface rescuecore2.config.ConfigConstraint

getDescription, getKeys, isViolated

Method Detail

getKey

java.lang.String getKey()

Get the key this restraint refers to.

Returns:

The config key.

isValid

boolean isValid(java.lang.String value,
                Config config)

Check if a value is valid.

Parameters:

value - The value to check.

config - The Config object.

Returns:

True iff the value is valid.

undefinedIsValid

boolean undefinedIsValid()

Find out if an undefined value is counted as valid or invalid.

Returns:

True if an undefined value should be treated as valid, false if invalid.