dk.heick.properties.types

Class StringPropertyType

java.lang.Object

dk.heick.properties.PropertyType<String>

dk.heick.properties.types.StringPropertyType

All Implemented Interfaces:

Serializable

public class StringPropertyType
extends PropertyType<String>

PropertyType that validates to a string value by the attributes provided in the constructor.

Constructor Example			Comments
Property<String> A_PROPERTY = new Property<String>("name", new StringPropertyType());			Default value is null.
Property<String> A_PROPERTY = new Property<String>("name", new StringPropertyType("def"));			Default value is def.
Property<String> A_PROPERTY = new Property<String>("name", new StringPropertyType(80));			Default value is null. Max length is 80.
Property<String> A_PROPERTY = new Property<String>("name", new StringPropertyType("def",80));			Default value is def.Max length is 80.
Property<String> A_PROPERTY = new Property<String>("name", new StringPropertyType(5,69));			Default value is null. Min length is 5, max length is 69.
Property<String> A_PROPERTY = new Property<String>("name", new StringPropertyType("def",5,69));			Default value is def. Min length is 5, max length is 69.
Type of value(s)	Examples	Result	Comments
Valid	cow	new String("cow")	Validate successfully. The string value is trimmed and lower cased before conversion.
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:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StringPropertyType() Creates a string property type.
StringPropertyType(int maxLength) Creates a string property type.
StringPropertyType(Integer minLength, Integer maxLength) Creates a string property type.
StringPropertyType(Pattern pattern) Creates a string property type.
StringPropertyType(String defaultValue) Creates a string property type.
StringPropertyType(String defaultValue, int maxLength) Creates a string property type.
StringPropertyType(String defaultValue, Integer minLength, Integer maxLength) Creates a string property type.
StringPropertyType(String defaultValue, Integer minLength, Integer maxLength, Pattern pattern) Creates a string property type.

Method Summary

Modifier and Type	Method and Description
Integer	getMaxLength() The maximum length of the string.
Integer	getMinLength() The minimum length of the string.
Pattern	getPattern() Gets the regular expression pattern which the string shall validates to.
String	getPatternString() Gets the pattern string if any,
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
boolean	isUseMaxLength() Determines if there is maximum length restrictions on the string.
boolean	isUseMinLength() Determines if there is minimum length restrictions on the string.
void	setMaxLength(Integer maxLength) Sets the max length of the string.
void	setMinLength(Integer minLength) Sets the min length of the string.
void	setPattern(Pattern pattern) Set the pattern which the string shall validates to.
void	setPatternString(String patternString) Sets a pattern string which the string shall validates to.
String	toString(String propertyName, String t) Converts a typed to the string representation.
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, 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 StringPropertyType.

See Also:

Constant Field Values

Constructor Detail

StringPropertyType

public StringPropertyType()

Creates a string property type. Default value is null and no minimum or maximum length restrictions og no pattern restrictions.

StringPropertyType

public StringPropertyType(Pattern pattern)

Creates a string property type. Default value is null and no minimum or maximum length restrictions.

Parameters:

pattern - the regular expression pattern which the string must match. If null, it is ignored.

StringPropertyType

public StringPropertyType(String defaultValue)

Creates a string property type. No minimum or maximum length restrictions.

Parameters:

defaultValue - default value returned if property value is undefined.

StringPropertyType

public StringPropertyType(int maxLength)

Creates a string property type. Where the default value is null and no minimum length restrictions.

Parameters:

maxLength -

StringPropertyType

public StringPropertyType(String defaultValue,
                          int maxLength)

Creates a string property type. Where the default value is null and no minimum length restrictions. The pattern is default null.

Parameters:

defaultValue - the default value if the value do not parse validation.

maxLength - the maximum length of the string (inclusive). Input null for no maximum length restrictions.

StringPropertyType

public StringPropertyType(Integer minLength,
                          Integer maxLength)

Creates a string property type. Where the default value is null. The pattern is default null.

Parameters:

minLength - the minimum length of the string (inclusive). Input null for no minimum length restrictions.

maxLength - the maximum length of the string (inclusive). Input null for no maximum length restrictions.

StringPropertyType

public StringPropertyType(String defaultValue,
                          Integer minLength,
                          Integer maxLength)

Creates a string property type.

Parameters:

defaultValue - the default value if the value do not parse validation.

minLength - the minimum length of the string (inclusive). Input null for no minimum length restrictions.

maxLength - the maximum length of the string (inclusive). Input null for no maximum length restrictions.

StringPropertyType

public StringPropertyType(String defaultValue,
                          Integer minLength,
                          Integer maxLength,
                          Pattern pattern)

Creates a string property type.

Parameters:

defaultValue - the default value if the value do not parse validation.

minLength - the minimum length of the string (inclusive). Input null for no minimum length restrictions.

maxLength - the maximum length of the string (inclusive). Input null for no maximum length restrictions.

pattern - the regular expression pattern which the string must match. If null, it is ignored.

Method Detail

toString

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

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)

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

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.

isUseMaxLength

public boolean isUseMaxLength()

Determines if there is maximum length restrictions on the string.

Returns:

true if there are maximum length restrictions, otherwise false.

isUseMinLength

public boolean isUseMinLength()

Determines if there is minimum length restrictions on the string.

Returns:

true if there are minimum length restrictions, otherwise false.

getMaxLength

public Integer getMaxLength()

The maximum length of the string.

Returns:

the maximum length in characters of the string (inclusive), if null no restrictions is enforced.

getMinLength

public Integer getMinLength()

The minimum length of the string.

Returns:

the minimum length in characters of the string (inclusive), if null no restrictions is enforced.

setMinLength

public void setMinLength(Integer minLength)

Sets the min length of the string. (inclusive), if null no restrictions is enforced.

Parameters:

minLength - the min length of the string. (inclusive), if null no restrictions is enforced.

setMaxLength

public void setMaxLength(Integer maxLength)

Sets the max length of the string. (inclusive), if null no restrictions is enforced.

Parameters:

maxLength - the max length of the string. (inclusive), if null no restrictions is enforced.

getPattern

public Pattern getPattern()

Gets the regular expression pattern which the string shall validates to.

Returns:

the pattern, if none than null is returned.

setPattern

public void setPattern(Pattern pattern)

Set the pattern which the string shall validates to.

Parameters:

pattern - the pattern, if null than no pattern is enforced.

setPatternString

public void setPatternString(String patternString)
                      throws PropertyException

Sets a pattern string which the string shall validates to.

Parameters:

patternString - the pattern string

Throws:

PropertyException - if the pattern string is not valid.

getPatternString

public String getPatternString()

Gets the pattern string if any,

Returns:

the pattern string, if none is defined, than null is returned.