dk.heick.properties.types

Class LocalePropertyType

java.lang.Object

dk.heick.properties.PropertyType<Locale>

dk.heick.properties.types.LocalePropertyType

All Implemented Interfaces:

Serializable

public class LocalePropertyType
extends PropertyType<Locale>

PropertyType that validates to a Locale value.
This type convert and validates a string to a java.util.Locale.

Constructor Example			Comments
Property<Locale> A_PROPERTY = new Property<Locale>("name", new LocalePropertyType());			Creates LocalePropertyType with no default value.
Property<Locale> A_PROPERTY = new Property<Locale>("name", new LocalePropertyType(Locale.ENGLISH));			Creates LocalePropertyType with default value "Locale.ENGLISH".
Type of value(s)	Examples	Result	Comments
Valid	da_DK	new Locale("da","DK")	Validate successfully.
Valid	us	new Locale("us")	Validate successfully.
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.2

Author:

Frederik Heick

See Also:

Locale, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
LocalePropertyType() Default constructor, with null as default value.
LocalePropertyType(Locale 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.
String	toString(String propertyName, Locale t) Converts a typed to the string representation.
Locale	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, 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 ClassnamePropertyType.

See Also:

Constant Field Values

Constructor Detail

LocalePropertyType

public LocalePropertyType()

Default constructor, with null as default value.

LocalePropertyType

public LocalePropertyType(Locale defaultValue)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

Method Detail

toString

public String toString(String propertyName,
                       Locale t)
                throws PropertyException

Description copied from class: PropertyType

Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule.

Overrides:

toString in class PropertyType<Locale>

Parameters:

propertyName - the name of the property used for logging purposes.

t - the type T.

Returns:

The string representation of the type.

Throws:

PropertyException - if conversion failed in validation.

See Also:

PropertyType.validate(String, String)

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

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

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.