dk.heick.properties.types

Class HourIntervalsPropertyType

java.lang.Object

dk.heick.properties.PropertyType<HourIntervalsVO>

dk.heick.properties.types.HourIntervalsPropertyType

All Implemented Interfaces:

Serializable

public class HourIntervalsPropertyType
extends PropertyType<HourIntervalsVO>

PropertyType that validates to a HourIntervalsVO value.
This is a list of hour intervals, like '9-11;15-16;20-22.
This can be use schedule processes that may only run in certain hourly intervals during the day.
The rules are:

• Legal values for both "from" and "to" is "0<= hour <= 24".
• The "from" value must less than "to" value.
• The "to" value from the previous pair must be less or equal to the "from" value in the next pair.

Examples:

• 0-2
• 22-24
• 4-6;16-19

Constructor Example			Comments
Property<HourIntervalsVO> A_PROPERTY = new Property<HourIntervalsVO>("name", new HourIntervalsPropertyType());			Creates HourIntervalsPropertyType with no default value.
Property<HourIntervalsVO> A_PROPERTY = new Property<HourIntervalsVO>("name", new HourIntervalsPropertyType(myDefaultHoursInstance));			Creates HourIntervalsPropertyType with default value in the object instance "myDefaultHoursInstance".
Type of value(s)	Examples	Result	Comments
Valid	0-2	-	Validate successfully.
Valid	4-6;16-19;22-24	-	Validate successfully.
Valid	4-6;16-19	-	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	20-22;13-15	null
Invalid	x4-29	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:

HourIntervalsVO, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOUR_DIVIDER The string that divides the hour values.
static String	INTERVAL_DIVIDER The string that divides the intervals.
static String	TYPE The type name string constant of HourIntervalsPropertyType.

Constructor Summary

Constructors

Constructor and Description
HourIntervalsPropertyType() Default constructor, no default value.
HourIntervalsPropertyType(HourIntervalsVO 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.
HourIntervalsVO	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 HourIntervalsPropertyType.

See Also:

Constant Field Values

INTERVAL_DIVIDER

public static final String INTERVAL_DIVIDER

The string that divides the intervals. Default ';'.

See Also:

Constant Field Values

HOUR_DIVIDER

public static final String HOUR_DIVIDER

The string that divides the hour values. Default '-'.

See Also:

Constant Field Values

Constructor Detail

HourIntervalsPropertyType

public HourIntervalsPropertyType()

Default constructor, no default value.

HourIntervalsPropertyType

public HourIntervalsPropertyType(HourIntervalsVO defaultValue)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

Method Detail

validateValue

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

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

Returns:

the restrictions of the PropertyType as a list of strings.