rescuecore2.config

Class FloatValueConstraint

java.lang.Object

rescuecore2.config.AbstractValueConstraint

rescuecore2.config.FloatValueConstraint

All Implemented Interfaces:

ConfigConstraint, ValueConstraint

public class FloatValueConstraint
extends AbstractValueConstraint

A floating-point number constraint on a config value.

Field Summary

Fields inherited from class rescuecore2.config.AbstractValueConstraint

key

Constructor Summary

Constructors

Constructor and Description
FloatValueConstraint(java.lang.String key) Construct a FloatConstrainedConfigValue that has no minimum or maximum.
FloatValueConstraint(java.lang.String key, double min, double max) Construct a FloatConstrainedConfigValue that has a particular range.

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

FloatValueConstraint

public FloatValueConstraint(java.lang.String key)

Construct a FloatConstrainedConfigValue that has no minimum or maximum.

Parameters:

key - The key this constraint applies to.

FloatValueConstraint

public FloatValueConstraint(java.lang.String key,
                            double min,
                            double max)

Construct a FloatConstrainedConfigValue that has a particular range.

Parameters:

key - The key this constraint applies to.

min - The minimum value of the config entry.

max - The maximum value of the config entry.

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.