dk.heick.properties.types

Class ClassnamePropertyType

java.lang.Object

dk.heick.properties.PropertyType<Class<?>>

dk.heick.properties.types.ClassnamePropertyType

All Implemented Interfaces:

Serializable

public class ClassnamePropertyType
extends PropertyType<Class<?>>

PropertyType that validates to a class value.
This type convert and validates a string to a java.lang.Class.
The string value is trimmed before conversion.
This has InitializationPriority value "1000", initialized before other types with lower priority.

This value must a be class that exists in classpath.

Their can be options that the class:

• must extend a certain class
• implement one or more interfaces before being a valid type

Constructor Example			Comments
Property<Class<?>> A_PROPERTY = new Property<Class<?>>("name", new ClassnamePropertyType());			No default value, must not extend any class or implements any interfaces.
Property<Class<?>> A_PROPERTY = new Property<Class<?>>("name", new ClassnamePropertyType(null,A.class,new Class[]{I1.class,I2.class}));			No default value. Must extends class "A" and implement interface "I1" and "I2
Property<Class<?>> A_PROPERTY = new Property<Class<?>>("name", new ClassnamePropertyType(D.class,A.class,new Class[]{I1.class,I2.class}));			Default value is class "D". Must extends class "A" and implement interface "I1" and "I2
Type of value(s)	Examples	Result	Comments
Valid	dk.heick.properties.types.helpers.classname.B	Class of "dk.heick.properties.types.helpers.classname.B"	Validate successfully.
Valid	dk.heick.properties.types.helpers.classname.C	Class of "dk.heick.properties.types.helpers.classname.C"	Validate successfully.
Invalid	dk.heick.properties.types.helpers.classname.Idontexists	null	Validate will throw an exception. The resulting value is 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:

Class.forName(String), 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
ClassnamePropertyType() Default constructor.
ClassnamePropertyType(Class<?> defaultValue) Constructor with default value.
ClassnamePropertyType(Class<?> defaultValue, Class<?> mustExtend) Constructor with default value and class extends.
ClassnamePropertyType(Class<?> defaultValue, Class<?> mustExtend, Class<?> mustImplement) Constructor with default value class extends and one class implementation.
ClassnamePropertyType(Class<?> defaultValue, Class<?> mustExtend, Class<?>[] mustImplements) Constructor with default value class extends and one class implementations.

Method Summary

Modifier and Type	Method and Description
Class<?>	getMustExtend() The class which the property value must extend.
Class<?>[]	getMustImplement() The interfaces which the property value must implement.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
void	setMustExtend(Class<?> mustExtend)
void	setMustImplement(Class<?>[] mustImplement)
String	toString(String propertyName, Class<?> t) Converts a typed to the string representation.
Class<?>	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

ClassnamePropertyType

public ClassnamePropertyType()

Default constructor. With no default value, shall not extend any class, shall not implement any interfaces. The only requirement is that class exists in classpath.

ClassnamePropertyType

public ClassnamePropertyType(Class<?> defaultValue)

Constructor with default value. Shall not extend any class, shall not implement any interfaces.

Parameters:

defaultValue - the class returned if the property value is not valid.

ClassnamePropertyType

public ClassnamePropertyType(Class<?> defaultValue,
                             Class<?> mustExtend)

Constructor with default value and class extends. Shall not implement any interfaces.

Parameters:

defaultValue - default value returned if property value is undefined.

mustExtend - the property value must extends this class.

ClassnamePropertyType

public ClassnamePropertyType(Class<?> defaultValue,
                             Class<?> mustExtend,
                             Class<?> mustImplement)

Constructor with default value class extends and one class implementation.

Parameters:

defaultValue - default value returned if property value is undefined.

mustExtend - the property value must extends this class.

mustImplement - the property value must implement this interface.

ClassnamePropertyType

public ClassnamePropertyType(Class<?> defaultValue,
                             Class<?> mustExtend,
                             Class<?>[] mustImplements)

Constructor with default value class extends and one class implementations.

Parameters:

defaultValue - default value returned if property value is undefined.

mustExtend - the property value must extends this class.

mustImplements - the property value must implement these interfaces.

Method Detail

getMustExtend

public Class<?> getMustExtend()

The class which the property value must extend.

Returns:

the class the property value must extend, if no class defined null is returned.

setMustExtend

public void setMustExtend(Class<?> mustExtend)

getMustImplement

public Class<?>[] getMustImplement()

The interfaces which the property value must implement.

Returns:

a list of interfaces the property value must implement, if no interfaces defined an empty array is returned.

toString

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

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)

setMustImplement

public void setMustImplement(Class<?>[] mustImplement)

validateValue

public Class<?> 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<Class<?>>

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<Class<?>>

Returns:

the restrictions of the PropertyType as a list of strings.