dk.heick.properties.types

Class Point3DPropertyType

java.lang.Object

dk.heick.properties.PropertyType<Point3D>

dk.heick.properties.types.Point3DPropertyType

All Implemented Interfaces:

Serializable

public class Point3DPropertyType
extends PropertyType<Point3D>

PropertyType that validates to a dk.heick.properties.types.custom.Point3D value.
The string must contain two double and/or integer values seperated by a ",".
The Point3D contains the most common operations which exists on a point.

Constructor Example			Comments
Property<Point3D> A_PROPERTY = new Property<Point3D>("name", new Point3DPropertyType());			Creates Point3DPropertyType with no default value.
Property<Point3D> A_PROPERTY = new Property<Point3D>("name", new Point3DPropertyType(new Point3D(-3.5,999,22,0.554));			Creates Point3DPropertyType with a a default value .
Type of value(s)	Examples	Result	Comments
Valid	3,4,5	new Point3D(3,4,5)	Validate successfully.
Valid	-3.453E-23,99.88,0.0007	new Point3D(-3.453E-23,99.88,0.0007)	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	555,33,666,333,333	null

Since:

1.6

Author:

Frederik Heick

See Also:

Point3D, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of Point3D.
static char	VALUE_SEPERATOR The char which seperates the two integer values.

Constructor Summary

Constructors

Constructor and Description
Point3DPropertyType() Default constructor, no default value.
Point3DPropertyType(double x, double y, double z) Constructor with default x,y,z values.
Point3DPropertyType(Point3D defaultValue) Constructor with default value.

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	toString(String propertyName, Point3D t) Converts a typed to the string representation.
Point3D	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, 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 Point3D.

See Also:

Constant Field Values

VALUE_SEPERATOR

public static final char VALUE_SEPERATOR

The char which seperates the two integer values. Using the character ','.

See Also:

Constant Field Values

Constructor Detail

Point3DPropertyType

public Point3DPropertyType()

Default constructor, no default value.

Point3DPropertyType

public Point3DPropertyType(Point3D defaultValue)

Constructor with default value.

Parameters:

defaultValue - defaultValue default value returned if property value is undefined.

Point3DPropertyType

public Point3DPropertyType(double x,
                           double y,
                           double z)

Constructor with default x,y,z values.

Parameters:

x - default x value.

y - default y value.

z - default z value.

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

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

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.

toString

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

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)