rescuecore2.config

Class AbstractValueConstraint

java.lang.Object

rescuecore2.config.AbstractValueConstraint

All Implemented Interfaces:

ConfigConstraint, ValueConstraint

Direct Known Subclasses:

ClassNameSetValueConstraint, ClassNameValueConstraint, DiscreteValueConstraint, FloatValueConstraint, IntegerValueConstraint

public abstract class AbstractValueConstraint
extends java.lang.Object
implements ValueConstraint

Abstract base class for value constraints.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	key The key this constraint refers to.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractValueConstraint(java.lang.String key) Construct an AbstractConstrainedConfigValue.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Get the key this restraint refers to.
java.util.Set<java.lang.String>	getKeys() Get the set of keys this constriant applies to.
boolean	isViolated(Config config) Check if this constraint has been violated.
boolean	undefinedIsValid() Find out if an undefined value is counted as valid or invalid.

Methods inherited from class java.lang.Object

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

Methods inherited from interface rescuecore2.config.ValueConstraint

isValid

Methods inherited from interface rescuecore2.config.ConfigConstraint

getDescription

Field Detail

key

protected final java.lang.String key

The key this constraint refers to.

Constructor Detail

AbstractValueConstraint

protected AbstractValueConstraint(java.lang.String key)

Construct an AbstractConstrainedConfigValue.

Parameters:

key - The key this constraint applies to.

Method Detail

isViolated

public final boolean isViolated(Config config)

Description copied from interface: ConfigConstraint

Check if this constraint has been violated.

Specified by:

isViolated in interface ConfigConstraint

Parameters:

config - The Config object.

Returns:

True iff the constraint has been violated.

getKey

public final java.lang.String getKey()

Description copied from interface: ValueConstraint

Get the key this restraint refers to.

Specified by:

getKey in interface ValueConstraint

Returns:

The config key.

getKeys

public final java.util.Set<java.lang.String> getKeys()

Description copied from interface: ConfigConstraint

Get the set of keys this constriant applies to.

Specified by:

getKeys in interface ConfigConstraint

Returns:

The set of relevant keys.

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

Returns:

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