dk.heick.properties.types

Class StringPropertiesPropertyType

java.lang.Object

dk.heick.properties.PropertyType<Properties>

dk.heick.properties.types.StringPropertiesPropertyType

All Implemented Interfaces:

Serializable

public class StringPropertiesPropertyType
extends PropertyType<Properties>

This type convert and validates a string to a java.util.Properties.
This string value contains a list of name value pairs. Where each pair is separated by a divider and
the individual name value pair is split by another divider.
The pivotal point is that both side of the name value pair is of type string and can be accessed through the
properties object instance. Their can be constraints to the class:

• override the element divider string
• override the name value divider string
• the minimum elements their must be in the list for it passes validation. (inclusive).
• the maximum elements their is allowed to be in the list for it to pass validation. (inclusive).

Example: A=Horse;B=Cow;C=Pig

Constructor Example			Comments
Property<Properties> A_PROPERTY = new Property<Properties>("name", new StringPropertiesPropertyType());			Default constructor, with default element divider, default name/value divider, null as default value, and no element count restrictions.
Property<Properties> A_PROPERTY = new Property<Properties>("name", new StringPropertiesPropertyType(",","#"));			Constructor, with element divider "," , name/value divider "#", null as default value, and no element count restrictions.
Property<Properties> A_PROPERTY = new Property<Properties>("name", new StringPropertiesPropertyType(";","=",3,9));			Constructor, with element divider ";" , name/value divider ",", null as default value, and with minumum 3 and maximum 9 elements.
Property<Properties> A_PROPERTY = new Property<Properties>("name", new StringPropertiesPropertyType(3,9));			Default constructor, with default element divider, default name/value divider, null as default value, and with minumum 3 and maximum 9 elements.
Property<Properties> A_PROPERTY = new Property<Properties>("name", new StringPropertiesPropertyType(3));			Default constructor, with default element divider, default name/value divider, null as default value, and with minumum 3 elements and no maximum restrictions.
Type of value(s)	Examples	Result	Comments
Valid	A=Horse;B=Cow;C=Donkey	new Properties(); with "A=Horse;B=Cow;C=Donkey"	Validate successfully.
Valid	«empty string»	new Properties();
Valid	«empty string after trim»	new Properties();
Invalid	cow	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise 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:

String, Properties, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ELEMENT_DIVIDER The default string that divides elements [;]
static String	DEFAULT_NAME_VALUE_DIVIDER The default string that divides name value pairs [=]
static String	TYPE The type name string constant of StringPropertiesPropertyType.

Constructor Summary

Constructors

Constructor and Description
StringPropertiesPropertyType() Default constructor, with default element divider, default name/value divider, null as default value, and no element count restrictions.
StringPropertiesPropertyType(Integer minNumberOfElements) Default constructor, the default element is a null, with default element divider, default name/value divider, null as default value, and no maximum element count restrictions.
StringPropertiesPropertyType(Integer minNumberOfElements, Integer maxNumberOfElements) Constructor, with all optional elements, the default element is a null, and dividers uses defaults.
StringPropertiesPropertyType(Properties defaultValue) Default constructor, with default element divider, default name/value divider and no element count restrictions.
StringPropertiesPropertyType(Properties defaultValue, Integer minNumberOfElements) Default constructor, with default element divider, default name/value divider and no maximum element count restrictions.
StringPropertiesPropertyType(Properties defaultValue, Integer minNumberOfElements, Integer maxNumberOfElements) Default constructor, with default element divider, default name/value divider.
StringPropertiesPropertyType(Properties defaultValue, String elementDivider, String nameValueDivider, Integer minNumberOfElements, Integer maxNumberOfElements) Main constructor, with all optional elements, the default element is a empty Properties instance.
StringPropertiesPropertyType(String elementDivider) Constructor, with default name/value divider, null as default value, and no element count restrictions.
StringPropertiesPropertyType(String elementDivider, String nameValueDivider) Constructor, with null as default value, and no element count restrictions.
StringPropertiesPropertyType(String elementDivider, String nameValueDivider, Integer minNumberOfElements) Constructor, with null as default value, and no maximum element count restrictions.

Method Summary

Modifier and Type	Method and Description
String	getElementDivider() Element divider
Integer	getMaxNumberOfElements() Maximum element count
Integer	getMinNumberOfElements() Minimum element count
String	getNameValueDivider() NameValue divider.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
boolean	isUseMaxNumberOfElements() If there are any maximum element count restrictions.
boolean	isUseMinNumberOfElements() If there are any minimum element count restrictions.
void	setElementDivider(String elementDivider)
void	setMaxNumberOfElements(Integer maxNumberOfElements)
void	setMinNumberOfElements(Integer minNumberOfElements)
void	setNameValueDivider(String nameValueDivider)
String	toString(String propertyName, Properties t) Converts a typed to the string representation.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
Properties	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, 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 StringPropertiesPropertyType.

See Also:

Constant Field Values

DEFAULT_ELEMENT_DIVIDER

public static final String DEFAULT_ELEMENT_DIVIDER

The default string that divides elements [;]

See Also:

Constant Field Values

DEFAULT_NAME_VALUE_DIVIDER

public static final String DEFAULT_NAME_VALUE_DIVIDER

The default string that divides name value pairs [=]

See Also:

Constant Field Values

Constructor Detail

StringPropertiesPropertyType

public StringPropertiesPropertyType()

Default constructor, with default element divider, default name/value divider, null as default value, and no element count restrictions.

StringPropertiesPropertyType

public StringPropertiesPropertyType(Properties defaultValue)

Default constructor, with default element divider, default name/value divider and no element count restrictions.

Parameters:

defaultValue - default value returned if property value is undefined.

StringPropertiesPropertyType

public StringPropertiesPropertyType(Properties defaultValue,
                                    Integer minNumberOfElements)

Default constructor, with default element divider, default name/value divider and no maximum element count restrictions.

Parameters:

defaultValue - default value returned if property value is undefined.

minNumberOfElements - the minimum number of elements allowed (inclusive), if null no minimum elements count restrictions.

StringPropertiesPropertyType

public StringPropertiesPropertyType(Properties defaultValue,
                                    Integer minNumberOfElements,
                                    Integer maxNumberOfElements)

Default constructor, with default element divider, default name/value divider.

Parameters:

defaultValue - default value returned if property value is undefined.

minNumberOfElements - the minimum number of elements allowed (inclusive), if null no minimum elements count restrictions.

maxNumberOfElements - the maximum number of elements allowed (inclusive), if null no maximum elements count restrictions.

StringPropertiesPropertyType

public StringPropertiesPropertyType(String elementDivider)

Constructor, with default name/value divider, null as default value, and no element count restrictions.

Parameters:

elementDivider - the string that divides the elements.

StringPropertiesPropertyType

public StringPropertiesPropertyType(String elementDivider,
                                    String nameValueDivider)

Constructor, with null as default value, and no element count restrictions.

Parameters:

elementDivider - the string that divides the elements.

nameValueDivider - the string that divide the individual name value pairs.

StringPropertiesPropertyType

public StringPropertiesPropertyType(String elementDivider,
                                    String nameValueDivider,
                                    Integer minNumberOfElements)

Constructor, with null as default value, and no maximum element count restrictions.

Parameters:

elementDivider - the string that divides the elements in the name value pair.

nameValueDivider - the string that divides the individual name value pairs.

minNumberOfElements - the minimum number of elements allowed (inclusive), if null no minimum elements count restrictions.

StringPropertiesPropertyType

public StringPropertiesPropertyType(Integer minNumberOfElements)

Default constructor, the default element is a null, with default element divider, default name/value divider, null as default value, and no maximum element count restrictions.

Parameters:

minNumberOfElements - the minimum number of elements allowed (inclusive), if null no minimum elements count restrictions.

StringPropertiesPropertyType

public StringPropertiesPropertyType(Integer minNumberOfElements,
                                    Integer maxNumberOfElements)

Constructor, with all optional elements, the default element is a null, and dividers uses defaults.

Parameters:

minNumberOfElements - the minimum number of elements allowed (inclusive), if null no minimum elements count restrictions.

maxNumberOfElements - the maximum number of elements allowed (inclusive), if null no maximum elements count restrictions.

StringPropertiesPropertyType

public StringPropertiesPropertyType(Properties defaultValue,
                                    String elementDivider,
                                    String nameValueDivider,
                                    Integer minNumberOfElements,
                                    Integer maxNumberOfElements)

Main constructor, with all optional elements, the default element is a empty Properties instance.

Parameters:

defaultValue - default value returned if property value is undefined.

elementDivider - the string that divides the elements in the name value pair.

nameValueDivider - the string that divides the individual name value pairs.

minNumberOfElements - the minimum number of elements allowed (inclusive).

maxNumberOfElements - the maximum number of elements allowed (inclusive).

Method Detail

getElementDivider

public String getElementDivider()

Element divider

Returns:

the string used to divide up elements.

getNameValueDivider

public String getNameValueDivider()

NameValue divider.

Returns:

the string use to divide up name value pair

getMinNumberOfElements

public Integer getMinNumberOfElements()

Minimum element count

Returns:

the minimum count of elements allowed (inclusive), if null no minimum elements count restrictions.

getMaxNumberOfElements

public Integer getMaxNumberOfElements()

Maximum element count

Returns:

the maximum count of elements allowed (inclusive), if null no maximum elements count restrictions.

isUseMinNumberOfElements

public boolean isUseMinNumberOfElements()

If there are any minimum element count restrictions.

Returns:

true if getMinNumberOfElements() differs from null, otherwise false.

isUseMaxNumberOfElements

public boolean isUseMaxNumberOfElements()

If there are any maximum element count restrictions.

Returns:

true if getMaxNumberOfElements() differs from null, otherwise false.

setElementDivider

public void setElementDivider(String elementDivider)

setMaxNumberOfElements

public void setMaxNumberOfElements(Integer maxNumberOfElements)

setMinNumberOfElements

public void setMinNumberOfElements(Integer minNumberOfElements)

setNameValueDivider

public void setNameValueDivider(String nameValueDivider)

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

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

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

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

toString

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

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)