RangePropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<RangeVO<T>>
- - dk.heick.properties.types.RangePropertyType<T>

Type Parameters:: T - which must implement Comparable of type T.

All Implemented Interfaces:: MarkerSubPropertyType, Serializable

public class RangePropertyType<T extends Comparable<T>>
extends PropertyType<RangeVO<T>>
implements MarkerSubPropertyType

PropertyType that validates to a string value to an RangeVO of type T.
Type T must extends Comparable<T>.

A range is defined with a FROM and a TO value, seperated by a divider.
Example:

2-8
11 mb - 3.5 gb
2008-11-28;2020-11-29

IMPORTANT: Choose your divider well so it dosnt conflict with the String version of the type. The default divder is ";".
There must be two tokens only.
The FROM token must be less than or equal to the TO token.

Constructor Example			Comments
Property<RangeVO<Integer>> P_MY_INT_RANGE = new Property<RangeVO<Integer>>("p.property.name",new RangePropertyType<Integer>(new IntegerPropertyType()));			A RangePropertyType where FROM and TO is of type Integer, with no default value and ";" as default divider.
Property<RangeVO<Date>> P_MY_DATE_RANGE = new Property<RangeVO<Date>>("p.property.name",new RangePropertyType<Date>(new DateTimePropertyType(),"-"));			A RangePropertyType where FROM and TO is of type Date, with no default value and "-" as divider
Type of value(s)	Examples	Result	Comments
Valid	1-3	new RangeVO<Integer>(new IntegerPropertyType(),1,3,"-")	Validate successfully.
Invalid		`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	cow	`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	«empty string»	`null`
Invalid	«empty string after trim»	`null`
Invalid	`null`	`defaultValue` OR `null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.7
Author:: Frederik Heick
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_DIVIDER
The default divider ";".

static String TYPE
The type name string constant of BooleanPropertyType.

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DIVIDER` The default divider ";".
`static String`	`TYPE` The type name string constant of BooleanPropertyType.

Constructor Summary

Constructors
Constructor and Description
`RangePropertyType()` Constructor where divider is set to ";" and default value is `null`.
`RangePropertyType(PropertyType<T> rangeType)` Constructor where divider is set to ";" and default value is `null`.
`RangePropertyType(PropertyType<T> rangeType, RangeVO<T> defaultValue)` Constructor where divider is set to ";".
`RangePropertyType(PropertyType<T> rangeType, RangeVO<T> defaultValue, String divider)` Constructor.
`RangePropertyType(PropertyType<T> rangeType, String divider)` Constructor where default value is `null`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDivider()` The divider
`PropertyType<T>`	`getRangeType()` Gets the RangeType which return type T for the FROM and TO values.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`void`	`setDivider(String divider)` Sets the divider.
`void`	`setRangeType(PropertyType<T> rangeType)` Sets the range type.
`void`	`validateConstraints(String propertyName)` A PropertyType can have some constraints here is where they are validated.
`RangeVO<T>`	`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
```
    The type name string constant of BooleanPropertyType.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DIVIDER
```
public static final String DEFAULT_DIVIDER
```
    The default divider ";".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RangePropertyType
```
public RangePropertyType()
```
    Constructor where divider is set to ";" and default value is null.
    There is NO rangeType set, this MUST be set later and before validation, otherwise "validateConstraints" will thrown an exception.
  - RangePropertyType
```
public RangePropertyType(PropertyType<T> rangeType)
```
    Constructor where divider is set to ";" and default value is null.
    
    Parameters:
    
    rangeType - an instance of a PropertyType of type T.
  - RangePropertyType
```
public RangePropertyType(PropertyType<T> rangeType,
                         RangeVO<T> defaultValue)
```
    Constructor where divider is set to ";".
    
    Parameters:
    
    rangeType - an instance of a PropertyType of type T.
    
    defaultValue - default value returned if property value is undefined.
  - RangePropertyType
```
public RangePropertyType(PropertyType<T> rangeType,
                         String divider)
```
    Constructor where default value is null.
    
    Parameters:
    
    rangeType -
    
    divider - the divider of the two string tokens. Be aware that it do not conflict with the string version of the type T. Must be not null and none empty.
  - RangePropertyType
```
public RangePropertyType(PropertyType<T> rangeType,
                         RangeVO<T> defaultValue,
                         String divider)
```
    Constructor.
    
    Parameters:
    
    rangeType - an instance of a PropertyType of type T.
    
    defaultValue - defaultValue default value returned if property value is undefined.
    
    divider - the divider of the two string tokens. Be aware that it do not conflict with the string version of the type T. Must be not null and none empty.
- Method Detail
  - getDivider
```
public String getDivider()
```
    The divider
    
    Returns:
    
    the divider of the two tokens.
  - setDivider
```
public void setDivider(String divider)
```
    Sets the divider.
    
    Parameters:
    
    divider - a new divider string. Must be not null and none empty.
  - getRangeType
```
public PropertyType<T> getRangeType()
```
    Gets the RangeType which return type T for the FROM and TO values.
    
    Returns:
    
    the range type.
  - setRangeType
```
public void setRangeType(PropertyType<T> rangeType)
```
    Sets the range type.
    
    Parameters:
    
    rangeType - a new range type of type T.
  - 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<RangeVO<T extends Comparable<T>>>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - validateValue
```
public RangeVO<T> 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<RangeVO<T extends Comparable<T>>>
    
    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<RangeVO<T extends Comparable<T>>> 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()

Class RangePropertyType<T extends Comparable<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

TYPE

DEFAULT_DIVIDER

Constructor Detail

RangePropertyType

RangePropertyType

RangePropertyType

RangePropertyType

RangePropertyType

Method Detail

getDivider

setDivider

getRangeType

setRangeType

getRestrictions

validateValue

validateConstraints