dk.heick.properties.types

Class RegularExpressionPropertyType

java.lang.Object

dk.heick.properties.PropertyType<String>

dk.heick.properties.types.RegularExpressionPropertyType

All Implemented Interfaces:

Serializable

public class RegularExpressionPropertyType
extends PropertyType<String>

PropertyType that validates to a string value against a regular expression.

Constructor Example			Comments
Property<Date> A_PROPERTY = new Property<Date>("name", new RegularExpressionPropertyType("[bcr]at"));			Creates RegularExpressionPropertyType with which validates the pattern "[bcr]at". No default value.
Property<Date> A_PROPERTY = new Property<Date>("name", new RegularExpressionPropertyType("[bcr]at","cow"));			Creates RegularExpressionPropertyType with which validates the pattern "[bcr]at". With default value "cow".
Type of value(s)	Examples	Result	Comments
Valid	bat	bat	Validate successfully. With pattern "[bcr]at".
Valid	rat	rat	Validate successfully. With pattern "[bcr]at".
Invalid	horse	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	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.1

Author:

Frederik Heick

See Also:

Pattern, StringPropertyType, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Type name of the propertytype 'RegularExpression'.

Constructor Summary

Constructors

Constructor and Description
RegularExpressionPropertyType(String pattern) Creates a property that parses a regular expression.
RegularExpressionPropertyType(String pattern, String defaultValue) Creates a property that parses a regular expression.

Method Summary

Modifier and Type	Method and Description
String	getPattern() The regular expression pattern to be compiled
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
void	setPattern(String pattern)
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
String	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

Type name of the propertytype 'RegularExpression'.

See Also:

Constant Field Values

Constructor Detail

RegularExpressionPropertyType

public RegularExpressionPropertyType(String pattern)

Creates a property that parses a regular expression.
Default value is null.

Parameters:

pattern - The expression to be compiled

See Also:

Pattern.compile(String)

RegularExpressionPropertyType

public RegularExpressionPropertyType(String pattern,
                                     String defaultValue)

Creates a property that parses a regular expression.

Parameters:

pattern - The expression to be compiled

defaultValue - default value returned if property value is undefined.

See Also:

Pattern.compile(String)

Method Detail

getPattern

public String getPattern()

The regular expression pattern to be compiled

Returns:

regular expression pattern.

setPattern

public void setPattern(String pattern)

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

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

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

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