rescuecore2.config

Class ClassNameValueConstraint

java.lang.Object

rescuecore2.config.AbstractValueConstraint

rescuecore2.config.ClassNameValueConstraint

All Implemented Interfaces:

ConfigConstraint, ValueConstraint

public class ClassNameValueConstraint
extends AbstractValueConstraint

A config value constraint that requires the value to be a valid class name.

Field Summary

Fields inherited from class rescuecore2.config.AbstractValueConstraint

key

Constructor Summary

Constructors

Constructor and Description
ClassNameValueConstraint(java.lang.String key) Construct a ClassNameConstrainedConfigValue that does not require the value to be a particular class.
ClassNameValueConstraint(java.lang.String key, java.lang.Class<?> required) Construct a ClassNameConstrainedConfigValue that requires the value 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.

Methods inherited from class rescuecore2.config.AbstractValueConstraint

getKey, getKeys, isViolated, undefinedIsValid

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassNameValueConstraint

public ClassNameValueConstraint(java.lang.String key)

Construct a ClassNameConstrainedConfigValue that does not require the value to be a particular class.

Parameters:

key - The key this constraint applies to.

ClassNameValueConstraint

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

Construct a ClassNameConstrainedConfigValue that requires the value 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.