rescuecore2.config

Interface ConfigConstraint

All Known Subinterfaces:

ValueConstraint

All Known Implementing Classes:

AbstractValueConstraint, ClassNameSetValueConstraint, ClassNameValueConstraint, DiscreteValueConstraint, FloatValueConstraint, IntegerValueConstraint

public interface ConfigConstraint

Interface for specifying constraints on a Config.

Method Summary

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

Method Detail

isViolated

boolean isViolated(Config config)

Check if this constraint has been violated.

Parameters:

config - The Config object.

Returns:

True iff the constraint has been violated.

getDescription

java.lang.String getDescription()

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

Returns:

A description of the constraint.

getKeys

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

Get the set of keys this constriant applies to.

Returns:

The set of relevant keys.