dk.heick.properties.types

Class EnumPropertyType<T extends Enum<T>>

java.lang.Object

dk.heick.properties.PropertyType<T>

dk.heick.properties.types.EnumPropertyType<T>

Type Parameters:

T - which must extend a enum type.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EnvironmentPropertyType, MonthPropertyType, TimeUnitPropertyType, WeekdayPropertyType

public class EnumPropertyType<T extends Enum<T>>
extends PropertyType<T>

PropertyType that validates to a string value to an Enum type constant.
Can parse the class of any Enum type.
When parsing the value to a Enum instance, the class will see if all the Names in the Enum are either all upper case, lower case or neither,
and transform the value accordingly before trying to convert into an Enum instance.

Constructor Example			Comments
Property<MyColors> P_ENUM_MYCOLORS = new Property<MyColors>("p.property.name",new EnumPropertyType<MyColors>(MyColors.class));			Enum type of class "MyColors", with no default value.
Property<MyColors> P_ENUM_MYCOLORS = new Property<MyColors>("p.property.name",new EnumPropertyType<MyColors>(MyColors.class,MyColors.blue));			Enum type of class "MyColors", with default value "MyColors.blue".
Type of value(s)	Examples	Result	Comments
Valid	blue	MyColors.blue	Validate successfully.
Invalid		null	Validate will throw an exception. The resulting value is null.
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.1

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of EnumPropertyType<T>.

Constructor Summary

Constructors

Constructor and Description
EnumPropertyType(Class<T> enumClazz) Creates a class which can parse a string value (the name of the enum constant) into a Enum constant instance.
EnumPropertyType(Class<T> enumClazz, T defaultValue) Creates a class which can parse a string value (the name of the enum constant) into a Enum constant instance.

Method Summary

Modifier and Type	Method and Description
Class<? extends Enum<T>>	getEnumClazz() The Enum class.
T[]	getEnumConstants() Gets the constants which the Enum class gave have.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
boolean	isAllLowercased() Determines of the Name constants of the Enum class is all upper case.
boolean	isAllUppercased() Determines of the Name constants of the Enum class is all lower case.
void	setEnumClazz(Class<? extends Enum<T>> enumClazz) Sets the Enum class to be used.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
T	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 EnumPropertyType<T>.

See Also:

Constant Field Values

Constructor Detail

EnumPropertyType

public EnumPropertyType(Class<T> enumClazz)
                 throws NullPointerException

Creates a class which can parse a string value (the name of the enum constant) into a Enum constant instance.
The default value is null.

Parameters:

enumClazz - the Enum class

Throws:

NullPointerException - if enumClazz is null.

EnumPropertyType

public EnumPropertyType(Class<T> enumClazz,
                        T defaultValue)
                 throws NullPointerException

Creates a class which can parse a string value (the name of the enum constant) into a Enum constant instance.

Parameters:

enumClazz - the Enum class

defaultValue - default value returned if property value is undefined.

Throws:

NullPointerException - if enumClazz is null.

Method Detail

getEnumClazz

public Class<? extends Enum<T>> getEnumClazz()

The Enum class.

Returns:

the Enum class.

setEnumClazz

public void setEnumClazz(Class<? extends Enum<T>> enumClazz)

Sets the Enum class to be used.

Parameters:

enumClazz - the enum class.

getEnumConstants

public T[] getEnumConstants()

Gets the constants which the Enum class gave have.

Returns:

the Enum constants.

validateValue

public T 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<T extends Enum<T>>

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<T extends Enum<T>>

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()

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<T extends Enum<T>>

Returns:

the restrictions of the PropertyType as a list of strings.

isAllLowercased

public boolean isAllLowercased()

Determines of the Name constants of the Enum class is all upper case.

Returns:

true if all the name of the Enum class is upper case, otherwise false.

isAllUppercased

public boolean isAllUppercased()

Determines of the Name constants of the Enum class is all lower case.

Returns:

true if all the name of the Enum class is lower case, otherwise false.