dk.heick.properties.types

Class BigDecimalPropertyType

java.lang.Object

dk.heick.properties.PropertyType<BigDecimal>

dk.heick.properties.types.BigDecimalPropertyType

All Implemented Interfaces:

Range<BigDecimal>, Serializable

public class BigDecimalPropertyType
extends PropertyType<BigDecimal>
implements Range<BigDecimal>

PropertyType that validates to a BigDecimal value.
This type convert and validates a string to a java.math.BigDecimal.
The string value is trimmed before conversion.
Constraints can be set for minimum and maximum value.
Any string value which parses the method new BigDecimal(value);.

Constructor Example			Comments
Property<BigDecimal> A_PROPERTY = new Property<BigDecimal>("name", new BigDecimalPropertyType());			No default value, no minimum or maximum constraints.
Property<BigDecimal> A_PROPERTY = new Property<BigDecimal>("name", new BigDecimalPropertyType(new BigDecimal("-987654321987654321000000000.1234")));			Default value is "-987654321987654321000000000.1234", no minimum or maximum constraints.
Property<BigDecimal> A_PROPERTY = new Property<BigDecimal>("name", new BigDecimalPropertyType(new BigDecimal("187654321987654321000000000.1234"), new BigDecimal("99987654321987654321000000000.1234")));			No default value,minimum is "187654321987654321000000000.1234" and maximum is "99987654321987654321000000000", both inclusive..
Property<BigDecimal> A_PROPERTY = new Property<BigDecimal>("name", new BigDecimalPropertyType(new BigDecimal("487654321987654321000000000.1234"), new BigDecimal("187654321987654321000000000.1234"), new BigDecimal("99987654321987654321000000000.1234")));			Default value is "487654321987654321000000000.1234",minimum is "187654321987654321000000000.1234" and maximum is "99987654321987654321000000000.1234", both inclusive.
Type of value(s)	Examples	Result	Comments
Valid	-987654321987654321000000000.1234	new BigDecimal(-987654321987654321000000000.1234)	Validate successfully.
Valid	187654321987654321000000000.1234	new BigDecimal(187654321987654321000000000.1234)	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	3.23	null
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

2.0

Author:

Frederik Heick

See Also:

BigDecimal.BigDecimal(String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of BigDecimalPropertyType

Constructor Summary

Constructors

Constructor and Description
BigDecimalPropertyType() Default constructor, no minimum, maximum or default value.
BigDecimalPropertyType(BigDecimal defaultValue) Constructor with default value.
BigDecimalPropertyType(BigDecimal minValue, BigDecimal maxValue) Constructor with minimum and maximum value.
BigDecimalPropertyType(BigDecimal defaultValue, BigDecimal minValue, BigDecimal maxValue) Constructor with minimum, maximum and default value.

Method Summary

Modifier and Type	Method and Description
BigDecimal	getMaxValue() Gets the max value (inclusive) a value may be.
BigDecimal	getMinValue() Gets the min value (inclusive) a value may be.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
boolean	isUseMaxValue() Determines if max value restriction is used.
boolean	isUseMinValue() Determines if min value restriction is used.
void	setMaxValue(BigDecimal maxValue) Sets the max value (inclusive) a value may be.
void	setMinValue(BigDecimal minValue) Sets the min value (inclusive) a value may be.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
void	validateIsInRange(String propertyName, BigDecimal 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.
BigDecimal	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

The type name string constant of BigDecimalPropertyType

See Also:

Constant Field Values

Constructor Detail

BigDecimalPropertyType

public BigDecimalPropertyType()

Default constructor, no minimum, maximum or default value.

BigDecimalPropertyType

public BigDecimalPropertyType(BigDecimal defaultValue)

Constructor with default value.

Parameters:

defaultValue - default value returned if property value is undefined.

BigDecimalPropertyType

public BigDecimalPropertyType(BigDecimal defaultValue,
                              BigDecimal minValue,
                              BigDecimal maxValue)

Constructor with minimum, maximum and default value.

Parameters:

defaultValue - default value returned if property value is undefined, if is null than it means no default value.

minValue - minimum value, inclusive, if is null than it means no default value.

maxValue - maximum value, inclusive, if is null than it means no default value.

BigDecimalPropertyType

public BigDecimalPropertyType(BigDecimal minValue,
                              BigDecimal maxValue)

Constructor with minimum and maximum value.

Parameters:

minValue - minimum value, inclusive.

maxValue - maximum value, inclusive.

Method Detail

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<BigDecimal>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public BigDecimal validateValue(String propertyName,
                                String value)
                         throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<BigDecimal>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from class: PropertyType

A PropertyType can have some constraints here is where they are validated.
The constraints of a PropertyType is always assumed to be valid, but what if they are not.
Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
This is the method where we validate the constraints of a PropertyType before any value is actually validated.
Any many cases this will not be nessecary.
This method is call in Property.validate();

Overrides:

validateConstraints in class PropertyType<BigDecimal>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()

validateIsInRange

public void validateIsInRange(String propertyName,
                              BigDecimal value)
                       throws PropertyException

Description copied from interface: Range

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

Specified by:

validateIsInRange in interface Range<BigDecimal>

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)

validateMinMaxValues

public void validateMinMaxValues(String propertyName)
                          throws PropertyException

Description copied from interface: Range

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.

Specified by:

validateMinMaxValues in interface Range<BigDecimal>

Parameters:

propertyName - the name of the property.

Throws:

PropertyException - if minValue is greather than maxValue.

See Also:

PropertyType.validateConstraints(String)

getMaxValue

public BigDecimal getMaxValue()

Gets the max value (inclusive) a value may be.

Specified by:

getMaxValue in interface Range<BigDecimal>

Returns:

the max value.

getMinValue

public BigDecimal getMinValue()

Gets the min value (inclusive) a value may be.

Specified by:

getMinValue in interface Range<BigDecimal>

Returns:

the min value.

setMinValue

public void setMinValue(BigDecimal minValue)

Sets the min value (inclusive) a value may be. Must be less or equal max value if max value is defined.

Specified by:

setMinValue in interface Range<BigDecimal>

Parameters:

minValue - the min value.

setMaxValue

public void setMaxValue(BigDecimal maxValue)

Sets the max value (inclusive) a value may be. Must be greater or equal min value if min value is defined.

Specified by:

setMaxValue in interface Range<BigDecimal>

Parameters:

maxValue - the max value.

isUseMinValue

public boolean isUseMinValue()

Determines if min value restriction is used.

Specified by:

isUseMinValue in interface Range<BigDecimal>

Returns:

true if min value is not null, otherwise false.

isUseMaxValue

public boolean isUseMaxValue()

Determines if max value restriction is used.

Specified by:

isUseMaxValue in interface Range<BigDecimal>

Returns:

true if max value is not null, otherwise false.