rescuecore2.config

Class ClassNameSetValueConstraint

java.lang.Object

rescuecore2.config.AbstractValueConstraint

rescuecore2.config.ClassNameSetValueConstraint

All Implemented Interfaces:

ConfigConstraint, ValueConstraint

public class ClassNameSetValueConstraint
extends AbstractValueConstraint

A config value constraint that requires the value to be a list of valid class names.

Field Summary

Fields inherited from class rescuecore2.config.AbstractValueConstraint

key

Constructor Summary

Constructors

Constructor and Description
ClassNameSetValueConstraint(java.lang.String key) Construct a ClassNameSetValueConstraint that does not require the values to be a particular class.
ClassNameSetValueConstraint(java.lang.String key, java.lang.Class<?> required) Construct a ClassNameSetValueConstraint that requires the values to be a particular class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get a description of this constraint suitable for use in tooltips.
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 class rescuecore2.config.AbstractValueConstraint

getKey, getKeys, isViolated

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassNameSetValueConstraint

public ClassNameSetValueConstraint(java.lang.String key)

Construct a ClassNameSetValueConstraint that does not require the values to be a particular class.

Parameters:

key - The key this constraint applies to.

ClassNameSetValueConstraint

public ClassNameSetValueConstraint(java.lang.String key,
                                   java.lang.Class<?> required)

Construct a ClassNameSetValueConstraint that requires the values to be a particular class.

Parameters:

key - The key this constraint applies to.

required - The required class.

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: ConfigConstraint

Get a description of this constraint suitable for use in tooltips.

Returns:

A description of the constraint.

isValid

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

Description copied from interface: ValueConstraint

Check if a value is valid.

Parameters:

value - The value to check.

config - The Config object.

Returns:

True iff the value is valid.

undefinedIsValid

public boolean undefinedIsValid()

Description copied from interface: ValueConstraint

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

Specified by:

undefinedIsValid in interface ValueConstraint

Overrides:

undefinedIsValid in class AbstractValueConstraint

Returns:

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