dk.heick.properties.types

Class BooleanPropertyType

java.lang.Object

dk.heick.properties.PropertyType<Boolean>

dk.heick.properties.types.BooleanPropertyType

All Implemented Interfaces:

Serializable

public class BooleanPropertyType
extends PropertyType<Boolean>

PropertyType that validates to a boolean value.
This type convert and validates a string to a java.lang.Boolean.
The string value is trimmed and lower cased before conversion.

Constructor Example			Comments
Property<Boolean> A_PROPERTY = new Property<Boolean>("name", new BooleanPropertyType());			Default value is null.
Property<Boolean> A_PROPERTY = new Property<Boolean>("name", new BooleanPropertyType(true));			Default value is true.
Type of value(s)	Examples	Result	Comments
Valid	true	true	Validate successfully. The string value is trimmed and lower cased before conversion.
Valid	t	true
Valid	on	true
Valid	yes	true
Valid	false	false
Valid	f	false
Valid	off	false
Valid	no	false
Invalid	cow	null	Validate will throw an exception. The resulting value is 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:

1.0

Author:

Frederik Heick

See Also:

Boolean, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BooleanPropertyType() Constructor, sets the default value to null.
BooleanPropertyType(Boolean defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
Boolean	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, validateConstraints, 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 BooleanPropertyType.

See Also:

Constant Field Values

Constructor Detail

BooleanPropertyType

public BooleanPropertyType()

Constructor, sets the default value to null.

BooleanPropertyType

public BooleanPropertyType(Boolean defaultValue)

Constructor. Sets the default value.

Parameters:

defaultValue - default value returned if property value is undefined.

Method Detail

validateValue

public Boolean 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<Boolean>

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.

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<Boolean>

Returns:

the restrictions of the PropertyType as a list of strings.