dk.heick.properties.types.interfaces

Interface Range<T extends Comparable<T>>

All Known Implementing Classes:

BigDecimalPropertyType, BigIntegerPropertyType, ByteSizePropertyType, DateTimePropertyType, DoublePropertyType, IntegerPropertyType, LongPropertyType, TimeSpanPropertyType, TimeUnitPropertyType

public interface Range<T extends Comparable<T>>

Interface to used with PropertyTypes which has a min and max range, must extend Comparable<T>.
Using the RangeUtils, makes it easy to implement.

Since:

2.0

Author:

Frederik Heick

See Also:

RangeUtils.validateIsInRange(String, Range, Comparable), RangeUtils.validateMinMaxValues(String, Range, Comparable)

Method Summary

Modifier and Type	Method and Description
T	getMaxValue() The maximum value (inclusive)
T	getMinValue() The minimum value (inclusive)
boolean	isUseMaxValue() If there is a maximum limit.
boolean	isUseMinValue() If there is a minimum limit.
void	setMaxValue(T maxValue) Sets the maximum limit (inclusive).
void	setMinValue(T minValue) Sets the minimum limit (inclusive).
void	validateIsInRange(String propertyName, T value) Validates that a value is inside the valid range of min and max value if defined.
void	validateMinMaxValues(String propertyName) Validates that minValue is less or equal to maxValue, must be called by validateConstraints, and if there is a default value that is inside the valid range.

Method Detail

getMinValue

T getMinValue()

The minimum value (inclusive)

Returns:

the minimum value, if null than no minimum limit.

getMaxValue

T getMaxValue()

The maximum value (inclusive)

Returns:

the maximum value, if null than no minimum limit.

setMinValue

void setMinValue(T minValue)

Sets the minimum limit (inclusive).

Parameters:

minValue - the minimum limit, if null than no limit.

setMaxValue

void setMaxValue(T maxValue)

Sets the maximum limit (inclusive).

Parameters:

maxValue - the maximum limit, if null than no limit.

isUseMinValue

boolean isUseMinValue()

If there is a minimum limit.

Returns:

true if getMinValue() differs from null, otherwise false.

isUseMaxValue

boolean isUseMaxValue()

If there is a maximum limit.

Returns:

true if getMaxValue() differs from null, otherwise false.

validateMinMaxValues

void validateMinMaxValues(String propertyName)
                   throws PropertyException

Validates that minValue is less or equal to maxValue, must be called by validateConstraints, and if there is a default value that is inside the valid range.

Parameters:

propertyName - the name of the property.

Throws:

PropertyException - if minValue is greather than maxValue.

See Also:

PropertyType.validateConstraints(String)

validateIsInRange

void validateIsInRange(String propertyName,
                       T value)
                throws PropertyException

Validates that a value is inside the valid range of min and max value if defined.

Parameters:

propertyName - the property

value - the value

Throws:

PropertyException - if minValue is not null and value is less than, or maxValue is not null and value is greather than.

See Also:

PropertyType.validateValue(String, String)