dk.heick.properties.types

Class CharsetPropertyType

java.lang.Object

dk.heick.properties.PropertyType<Charset>

dk.heick.properties.types.CharsetPropertyType

All Implemented Interfaces:

Serializable

public class CharsetPropertyType
extends PropertyType<Charset>

PropertyType that validates to a Charset value.
This type convert and validates a string to a java.nio.charset.Charset, but remember it validates against the charsets that the VM knows.
The string value is trimmed and uppercased before conversion.

Constructor Example			Comments
Property<Charset> A_PROPERTY = new Property<Charset>("name", new CharsetPropertyType());			Creates CharsetPropertyType with no default value.
Property<Charset> A_PROPERTY = new Property<Charset>("name", new CharsetPropertyType(Charset.forName("ISO-8859-1")));			Default value is Charset.forName("ISO-8859-1").
Type of value(s)	Examples	Result	Comments
Valid	ISO-8859-1	Charset.forName("ISO-8859-1")	Validate successfully.
Valid	UTF-16	new Charset.forName("UTF-16")	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.4

Author:

Frederik Heick

See Also:

Charset, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CharsetPropertyType() Constructor, sets the default value to null.
CharsetPropertyType(Charset defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
static String[]	getAvailableCharsetNames() Available Charset names supported by VM instance.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
Charset	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 CharsetPropertyType.

See Also:

Constant Field Values

Constructor Detail

CharsetPropertyType

public CharsetPropertyType()

Constructor, sets the default value to null.

CharsetPropertyType

public CharsetPropertyType(Charset defaultValue)

Constructor.

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

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

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.

getAvailableCharsetNames

public static String[] getAvailableCharsetNames()

Available Charset names supported by VM instance.

Returns:

A list of the valid Charset names with is supported by the VM instance.