dk.heick.properties.types

Class URIPropertyType

java.lang.Object

dk.heick.properties.PropertyType<URI>

dk.heick.properties.types.URIPropertyType

All Implemented Interfaces:

Serializable

public class URIPropertyType
extends PropertyType<URI>

PropertyType that validates to a URI value.
This type convert and validates a string to a java.net.URI.
Constraints can be set for valid scheme(s).
Any string value which parses the method new URI(string) and make a regular expression check.

Constructor Example			Comments
Property<URI> A_PROPERTY = new Property<URI>("name", new URIPropertyType());			Creates URIPropertyType with no default value and no protocol restrictions.
Property<URI> A_PROPERTY = new Property<URI>("name", new URIPropertyType("http"));			Creates URIPropertyType with no default value and the protocol must be "http".
Property<URI> A_PROPERTY = new Property<URI>("name", new URIPropertyType(new URI("http://www.jp.dk"),"http"));			Creates URIPropertyType with default value "http://www.jp.dk" and the protocol must be "http".
Property<URI> A_PROPERTY = new Property<URI>("name", new URIPropertyType(new String[]{"ldap","ldaps"}));			Creates URIPropertyType with no default value and the protocol must be either "ldap" or "ldaps".
Property<URI> A_PROPERTY = new Property<URI>("name", new URIPropertyType(new URI("http://www.jp.dk"),new String[]{"http","ftp"}));			Creates URIPropertyType with default value "http://www.jp.dk" and the protocol must be either "http" or "ftp".
Type of value(s)	Examples	Result	Comments
Valid	http://www.cnn.com	new URI("http://www.cnn.com")	Validate successfully.
Valid	ldaps://aserver.test.det.rm.com:636	new URI("ldaps://aserver.test.det.rm.com:636")	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	10.0.0.1	null	Validate will throw an exception. The resulting value is null. No Protocol.
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.3

Author:

Frederik Heick

See Also:

URI, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGEX_URI The regular expression use to validate the URI with.
static String	TYPE The type name string constant of URIPropertyType.

Constructor Summary

Constructors

Constructor and Description
URIPropertyType() Default constructor, no default value and no schemes constraints.
URIPropertyType(String scheme) Constructor with scheme constraint.
URIPropertyType(String[] schemes) Constructor.
URIPropertyType(URI defaultValue) Constructor.
URIPropertyType(URI defaultValue, String scheme) Constructor.
URIPropertyType(URI defaultValue, String[] schemes) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
String[]	getSchemes() Gets the valid schemas
void	setSchema(String schema) Sets the valid schema.
void	setSchemes(String[] schemes) Sets the valid schemas.
URI	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 URIPropertyType.

See Also:

Constant Field Values

REGEX_URI

public static final String REGEX_URI

The regular expression use to validate the URI with.

See Also:

Constant Field Values

Constructor Detail

URIPropertyType

public URIPropertyType()

Default constructor, no default value and no schemes constraints.

URIPropertyType

public URIPropertyType(String scheme)

Constructor with scheme constraint.

Parameters:

scheme - the scheme the URI must start with, not case sensitive.

URIPropertyType

public URIPropertyType(URI defaultValue)

Constructor. No scheme constraints.

Parameters:

defaultValue - default value returned if property value is undefined.

URIPropertyType

public URIPropertyType(URI defaultValue,
                       String scheme)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

scheme - the scheme the URI must start with, not case sensitive.

URIPropertyType

public URIPropertyType(String[] schemes)

Constructor.

Parameters:

schemes - the schemes the URI must start with, not case sensitive.

URIPropertyType

public URIPropertyType(URI defaultValue,
                       String[] schemes)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

schemes - the schemes the URI must start with, not case sensitive.

Method Detail

getSchemes

public String[] getSchemes()

Gets the valid schemas

Returns:

the valid schemas, if null or empty, no restrictions on schemas.

setSchemes

public void setSchemes(String[] schemes)

Sets the valid schemas.

Parameters:

schemes - the schemas which the URL must start with one of them, not case sensitive. If null or empty, schemas will not be used in the validation.

setSchema

public void setSchema(String schema)

Sets the valid schema.

Parameters:

schema - the schema which the URL must start with, not case sensitive. If null or empty, schema will not be used in the validation.

validateValue

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

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

Returns:

the restrictions of the PropertyType as a list of strings.