dk.heick.properties.types

Class TimeZonePropertyType

java.lang.Object

dk.heick.properties.PropertyType<TimeZone>

dk.heick.properties.types.TimeZonePropertyType

All Implemented Interfaces:

Serializable

public class TimeZonePropertyType
extends PropertyType<TimeZone>

PropertyType that validates to a TimeZone value.
This type convert and validates a string to a java.util.TimeZone.
The string value is trimmed before conversion.


IMPORTANT NOTE: The TimeZone class is heavily synchronized, so I would recommend to make a clone of the object when using it.

Constructor Example			Comments
Property<TimeZone> A_PROPERTY = new Property<TimeZone>("name", new TimeZonePropertyType());			No default value.
Property<TimeZone> A_PROPERTY = new Property<TimeZone>("name", new TimeZonePropertyType(TimeZone.getTimeZone("GMT"));			Default value is GMT timezone.
Type of value(s)	Examples	Result	Comments
Valid	Europe/Copenhagen	TimeZone.getTimeZone("Europe/Copenhagen")	Validate successfully.
Valid	Europe/Copenhagen	TimeZone.getTimeZone("Europe/Copenhagen")	Validate successfully.
Valid	America/Los_Angeles	TimeZone.getTimeZone("America/Los_Angeles")	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	horse	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.5

Author:

Frederik Heick

See Also:

TimeZone, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TimeZone	DEFAULT_TIMEZONE
static String	DEFAULT_TIMEZONE_ID
static String	TYPE The type name string constant of TimeZonePropertyType

Constructor Summary

Constructors

Constructor and Description
TimeZonePropertyType() Returns TimeZonePropertyType where the default value is null.
TimeZonePropertyType(TimeZone defaultValue) Returns TimeZonePropertyType with default value.

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, TimeZone t) Converts a typed to the string representation.
TimeZone	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 TimeZonePropertyType

See Also:

Constant Field Values

DEFAULT_TIMEZONE_ID

public static final String DEFAULT_TIMEZONE_ID

See Also:

Constant Field Values

DEFAULT_TIMEZONE

public static final TimeZone DEFAULT_TIMEZONE

Constructor Detail

TimeZonePropertyType

public TimeZonePropertyType()

Returns TimeZonePropertyType where the default value is null.

TimeZonePropertyType

public TimeZonePropertyType(TimeZone defaultValue)

Returns TimeZonePropertyType with default value.

Parameters:

defaultValue - default value returned if property value is undefined.

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

Returns:

the restrictions of the PropertyType as a list of strings.

toString

public String toString(String propertyName,
                       TimeZone 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<TimeZone>

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)

validateValue

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

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.