TimeSpanPropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<TimeSpan>
- - dk.heick.properties.types.TimeSpanPropertyType

All Implemented Interfaces:: Range<TimeSpan>, Serializable

public class TimeSpanPropertyType
extends PropertyType<TimeSpan>
implements Range<TimeSpan>

PropertyType that validates to a dk.heick.properties.types.custom.TimeSpan value.
The string space seperated list of tokens, which sums up to a milliseconds long value.
Please see TimeSpan API for the text format of a Timespan.
There is a lot of predefined timespans in the TimeSpan class.

This type convert and validates a string to a dk.heick.properties.types.custom.TimeSpan.

Constructor Example			Comments
Property<Timespan> A_PROPERTY = new Property<Timespan>("name", new TimespanPropertyType());			Creates TimespanPropertyType with no default value.
Property<Timespan> A_PROPERTY = new Property<Timespan>("name", new TimespanPropertyType(TimeSpan.DAYS_21));			Creates TimespanPropertyType with default value "TimeSpan.DAYS_21".
Type of value(s)	Examples	Result	Comments
Valid	41y 84d 4h 48m 3s	new TimeSpan(41,0,0,84,4,48,3,0)	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	`null`	`defaultValue` OR `null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.9
Author:: Frederik Heick
See Also:: TimeSpan, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE
The type name string constant of TimespanPropertyType.

Fields
Modifier and Type	Field and Description
`static String`	`TYPE` The type name string constant of TimespanPropertyType.

Constructor Summary

Constructors
Constructor and Description
`TimeSpanPropertyType()` Constructor where the defaultValue, minValue and maxValue is `null`.
`TimeSpanPropertyType(TimeSpan defaultValue)` Constructor where minValue and maxValue is `null`.
`TimeSpanPropertyType(TimeSpan minValue, TimeSpan maxValue)` Constructor where the default value is `null`.
`TimeSpanPropertyType(TimeSpan defaultValue, TimeSpan minValue, TimeSpan maxValue)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeSpan`	`getMaxValue()` Gets the max value (inclusive) a value may be.
`TimeSpan`	`getMinValue()` Gets the min value (inclusive) a value may be.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`boolean`	`isUseMaxValue()` Determines if max value restriction is used.
`boolean`	`isUseMinValue()` Determines if min value restriction is used.
`void`	`setMaxValue(TimeSpan maxValue)` Sets the max value (inclusive) a value may be.
`void`	`setMinValue(TimeSpan minValue)` Sets the min value (inclusive) a value may be.
`String`	`toString(String propertyName, TimeSpan t)` Returns a parseable Timespan text value.
`void`	`validateConstraints(String propertyName)` A PropertyType can have some constraints here is where they are validated.
`void`	`validateIsInRange(String propertyName, TimeSpan value)` Validates that a value is inside the valid range of min and max value if defined.
`void`	`validateMinMaxValues(String propertyName)` Validates that `minValue` is less or equal to `maxValue, must be called by validateConstraints, and if there is a default value that is inside the valid range.`
`TimeSpan`	`validateValue(String propertyName, String value)` Parses the text using the `TimeSpan.parse(String)` and if the result is inside valid min and max values.

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 TimespanPropertyType.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TimeSpanPropertyType
```
public TimeSpanPropertyType()
```
    Constructor where the defaultValue, minValue and maxValue is null.
  - TimeSpanPropertyType
```
public TimeSpanPropertyType(TimeSpan defaultValue)
```
    Constructor where minValue and maxValue is null.
    
    Parameters:
    
    defaultValue - the default TimeSpan value.
  - TimeSpanPropertyType
```
public TimeSpanPropertyType(TimeSpan minValue,
                            TimeSpan maxValue)
```
    Constructor where the default value is null.
    
    Parameters:
    
    minValue - the minimum Timespan value (inclusive), if null than no minimum limit.
    
    maxValue - the maximum Timespan value (inclusive), if null than no maximum limit.
    
    Since:
    
    2.0
  - TimeSpanPropertyType
```
public TimeSpanPropertyType(TimeSpan defaultValue,
                            TimeSpan minValue,
                            TimeSpan maxValue)
```
    Constructor
    
    Parameters:
    
    defaultValue - the default TimeSpan value.
    
    minValue - the minimum Timespan value (inclusive), if null than no minimum limit.
    
    maxValue - the maximum Timespan value (inclusive), if null than no maximum limit.
    
    Since:
    
    2.0
- Method Detail
  - getMaxValue
```
public TimeSpan getMaxValue()
```
    Gets the max value (inclusive) a value may be.
    
    Specified by:
    
    getMaxValue in interface Range<TimeSpan>
    
    Returns:
    
    the max value.
  - getMinValue
```
public TimeSpan getMinValue()
```
    Gets the min value (inclusive) a value may be.
    
    Specified by:
    
    getMinValue in interface Range<TimeSpan>
    
    Returns:
    
    the min value.
    
    Since:
    
    2.0
  - setMinValue
```
public void setMinValue(TimeSpan minValue)
```
    Sets the min value (inclusive) a value may be. Must be less or equal max value if max value is defined.
    
    Specified by:
    
    setMinValue in interface Range<TimeSpan>
    
    Parameters:
    
    minValue - the min value.
    
    Since:
    
    2.0
  - setMaxValue
```
public void setMaxValue(TimeSpan maxValue)
```
    Sets the max value (inclusive) a value may be. Must be greater or equal min value if min value is defined.
    
    Specified by:
    
    setMaxValue in interface Range<TimeSpan>
    
    Parameters:
    
    maxValue - the max value.
    
    Since:
    
    2.0
  - isUseMinValue
```
public boolean isUseMinValue()
```
    Determines if min value restriction is used.
    
    Specified by:
    
    isUseMinValue in interface Range<TimeSpan>
    
    Returns:
    
    true if min value is not null, otherwise false.
    
    Since:
    
    2.0
  - isUseMaxValue
```
public boolean isUseMaxValue()
```
    Determines if max value restriction is used.
    
    Specified by:
    
    isUseMaxValue in interface Range<TimeSpan>
    
    Returns:
    
    true if max value is not null, otherwise false.
    
    Since:
    
    2.0
  - 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<TimeSpan>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - validateValue
```
public TimeSpan validateValue(String propertyName,
                              String value)
                       throws PropertyException
```
    Parses the text using the TimeSpan.parse(String) and if the result is inside valid min and max values.
    
    Specified by:
    
    validateValue in class PropertyType<TimeSpan>
    
    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.
    
    See Also:
    
    TimeSpan.parse(String)
  - toString
```
public String toString(String propertyName,
                       TimeSpan t)
                throws PropertyException
```
    Returns a parseable Timespan text value.
    
    Overrides:
    
    toString in class PropertyType<TimeSpan>
    
    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:
    
    TimeSpan.getParsableText()
  - 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<TimeSpan> 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()
  validateIsInRange public void validateIsInRange(String propertyName, TimeSpan value) throws PropertyException Description copied from interface: Range Validates that a value is inside the valid range of min and max value if defined. Specified by: validateIsInRange in interface Range<TimeSpan> Parameters: propertyName - the property value - the value Throws: PropertyException - if minValue is not null and value is less than, or maxValue is not null and value is greather than. See Also: PropertyType.validateValue(String, String) validateMinMaxValues public void validateMinMaxValues(String propertyName) throws PropertyException Description copied from interface: Range Validates that minValue is less or equal to maxValue, must be called by validateConstraints, and if there is a default value that is inside the valid range. Specified by: validateMinMaxValues in interface Range<TimeSpan> Parameters: propertyName - the name of the property. Throws: PropertyException - if minValue is greather than maxValue. See Also: PropertyType.validateConstraints(String)

Class TimeSpanPropertyType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

TYPE

Constructor Detail

TimeSpanPropertyType

TimeSpanPropertyType

TimeSpanPropertyType

TimeSpanPropertyType

Method Detail

getMaxValue

getMinValue

setMinValue

setMaxValue

isUseMinValue

isUseMaxValue

getRestrictions

validateValue

toString

validateConstraints

validateIsInRange

validateMinMaxValues