PropertyType (JHPropertiesTyped

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

Type Parameters:

T - the type which which can convert a string to.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BigDecimalPropertyType, BigIntegerPropertyType, BooleanPropertyType, ByteSizePropertyType, CharsetPropertyType, ClassnamePropertyType, ColorPropertyType, ConnectionUrlPropertyType, CountryPropertyType, DateFormatPropertyType, DateTimePropertyType, DecimalFormatPropertyType, DerivedPropertyType, DirectoryPropertyType, DoublePropertyType, EmailPropertyType, EnumPropertyType, FilenameFilterPropertyType, FilePropertyType, FileStructurePropertyType, FontPropertyType, HourIntervalsPropertyType, InetAddressPropertyType, IntegerPropertyType, IP4AddressPropertyType, IPRangePropertyType, LatLngPropertyType, LdapNamePropertyType, ListKeyValuePropertyType, ListPropertyType, LocalePropertyType, LongPropertyType, MimeTypePropertyType, PasswordPropertyType, Point2DPropertyType, Point3DPropertyType, ProxyPropertyType, RangePropertyType, RegularExpressionPropertyType, SequencePropertyType, StringPropertiesPropertyType, StringPropertyType, TimeSpanPropertyType, TimeZonePropertyType, URIPropertyType, URLPropertyType, VersionPropertyType
```
public abstract class PropertyType<T>
extends Object
implements Serializable
```
The abstract property type.
Each property instance have separate instance of their respectable propertyType.
A propertyType holds a typed value T.
The typed value is cache (if the option is set).

Since:

1.0

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PropertyType(String typeName, T defaultValue)
Constructs a PropertyType

Constructors
Constructor and Description
`PropertyType(String typeName, T defaultValue)` Constructs a PropertyType

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Two property types are equal if their `getDescription` are equal.
`T`	`getDefaultValue()` The default <T> typed value
`String`	`getDefaultValueAsString()`
`String`	`getDefaultValueDescription()` Gets the description of the default value.
`String`	`getDescription()` Gets a description of the PropertyType which is a string version of the restrictions with a "\n" as new line divider.
`String`	`getDescription(String newLineDivider)` Gets a description of the PropertyType which is a string version of the restrictions.
`int`	`getInitializationPriority()` The priority order in which the a PropertyType is initialized Default is 99.
`PropertyIO`	`getIo()` Gets the PropertyIO assigned to the propertyType.
`org.apache.commons.logging.Log`	`getLogger()` Gets the logger.
`abstract List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`String`	`getTypeName()` Gets the type name of the PropertyType.
`boolean`	`hasDefaultValue()` Determines if the PropertyType has a defaultValue.
`boolean`	`isDefaultValueValid()` Determines if the default value for a PropertyType parses its own validation.
`protected String`	`postGetValueProcessing(String propertyName, String value, boolean propertyReadonly)` Special method invoke by the `Property.getValue()`, to gives the ability to post processed the loaded value.
`void`	`setDefaultValue(T defaultValue)` Setting the default value <T> typed value
`void`	`setInitializationPriority(int initializationPriority)` Sets the initialization priority.
`void`	`setIo(PropertyIO io)` Set/assign the PropertyIO to the proprerty type.
`void`	`setTypedValue(String propertyName, T t)` Sets/writes the types value to the PropertyIO.
`protected void`	`setTypeName(String typeName)`
`String`	`toString(String propertyName, T t)` Converts a typed to the string representation.
`T`	`toType(String propertyName, String value)` Gets the converted typed value, its presumed that a the properties already has been validated.
`T`	`validate(String propertyName, String value)` Validates the `constraints` and `value` of the PropertyType and returns the value as the defined type.
`void`	`validateConstraints(String propertyName)` A PropertyType can have some constraints here is where they are validated.
`protected void`	`validateNullType(String propertyName, Object value)` Helper method, to validate if a type T is null, and throwing a exception if that is the case.
`abstract T`	`validateValue(String propertyName, String value)` Converts the string representation of to a typed value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PropertyType
```
public PropertyType(String typeName,
                    T defaultValue)
             throws NullPointerException
```
    Constructs a PropertyType
    
    Parameters:
    
    typeName - the short name if the PropertyType.
    
    defaultValue - value returned if property value is undefined.
    
    Throws:
    
    NullPointerException - if the typeName is null.
- Method Detail
  - getDefaultValue
```
public final T getDefaultValue()
```
    The default <T> typed value
    
    Returns:
    
    the default if any, otherwise null.
  - setDefaultValue
```
public final void setDefaultValue(T defaultValue)
```
    Setting the default value <T> typed value
    
    Parameters:
    
    defaultValue - the default value. Setting null means no default value is set.
  - hasDefaultValue
```
public final boolean hasDefaultValue()
```
    Determines if the PropertyType has a defaultValue.
    
    Returns:
    
    true if the defaultValue is different from null, otherwise false.
  - getTypeName
```
public final String getTypeName()
```
    Gets the type name of the PropertyType.
    
    Returns:
    
    the typename.
  - setTypeName
```
protected final void setTypeName(String typeName)
```
  - getDescription
```
public final String getDescription()
```
    Gets a description of the PropertyType which is a string version of the restrictions with a "\n" as new line divider.
    
    Returns:
    
    the description of the propertyType.
    
    See Also:
    
    StringUtils.asString(List)
  - getDescription
```
public final String getDescription(String newLineDivider)
```
    Gets a description of the PropertyType which is a string version of the restrictions.
    
    Parameters:
    
    newLineDivider - the string your want as a new line divider.
    
    Returns:
    
    the description of the propertyType.
    
    See Also:
    
    StringUtils.asString(List, String)
  - getRestrictions
```
public abstract List<String> getRestrictions()
```
    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.
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - toString
```
public String toString(String propertyName,
                       T t)
                throws PropertyException
```
    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.
    
    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:
    
    validate(String, String)
  - validateConstraints
```
public void validateConstraints(String propertyName)
                         throws PropertyException
```
    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(); 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. Since: 1.7 See Also: Property.validate()
  validate public final T validate(String propertyName, String value) throws PropertyException Validates the constraints and value of the PropertyType and returns the value as the defined type. 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. Since: 1.7 validateValue public abstract T validateValue(String propertyName, String value) throws PropertyException 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. 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. Since: 1.7 toType public final T toType(String propertyName, String value) Gets the converted typed value, its presumed that a the properties already has been validated. If PropertyIO is using cache, the value is stored in the PropertyIO's typed cache. Parameters: propertyName - the name of the property used for logging purposes. value - a proper converted type, otherwise return null. Returns: a proper converted type, otherwise return null. setTypedValue public final void setTypedValue(String propertyName, T t) throws PropertyException Sets/writes the types value to the PropertyIO. If the PropertyIO is not null and the the PropertyIO is using caching, the method "storeTypedValue(name,t)" is called. Parameters: propertyName - the name of the property used for logging purposes. t - the typed value. Throws: PropertyException - if PropertyIO.setValue(String,String) fails or the toString(String, Object) fails. validateNullType protected final void validateNullType(String propertyName, Object value) throws PropertyException Helper method, to validate if a type T is null, and throwing a exception if that is the case. Parameters: propertyName - the name of the property used for logging purposes. value - the typed value t. Throws: PropertyException - if t is null. getIo public final PropertyIO getIo() Gets the PropertyIO assigned to the propertyType. Returns: the propertyIO. setIo public final void setIo(PropertyIO io) Set/assign the PropertyIO to the proprerty type. Parameters: io - the PropertyIO getDefaultValueDescription public String getDefaultValueDescription() Gets the description of the default value. Returns: description "Use default value [<DefaultValueAsString()>] if value is undefined" , if defaultValue is null, then "Use default value [null] if value is undefined". See Also: toString(String, Object) getDefaultValueAsString public String getDefaultValueAsString() throws PropertyException Throws: PropertyException isDefaultValueValid public boolean isDefaultValueValid() Determines if the default value for a PropertyType parses its own validation. Returns: true if the default value is valid or null, otherwise false. equals public boolean equals(Object obj) Two property types are equal if their getDescription are equal. Overrides: equals in class Object getLogger public final org.apache.commons.logging.Log getLogger() Gets the logger. Returns: the commons logger postGetValueProcessing protected String postGetValueProcessing(String propertyName, String value, boolean propertyReadonly) Special method invoke by the Property.getValue(), to gives the ability to post processed the loaded value. This is currently only used be the PasswordPropertyType to autoEncrypt passwords. This method is empty per default and just returns value unmodified. This is a method the specific PropertyTypes can choose to override or not. Parameters: propertyName - the name of the Property used for logging value - the value. propertyReadonly - if the the property is readonly or not. Returns: The modified value. Remember it still has to pass the validation method. getInitializationPriority public final int getInitializationPriority() The priority order in which the a PropertyType is initialized Default is 99. A list of Property's, will be sorted after "PropertyType.getInitializationPriority()" and the highest number is initialized first. This is a way to control, that fx. drivers are loaded before database connection urls is verified. Returns: the number which prioritize the initlization. setInitializationPriority public final void setInitializationPriority(int initializationPriority) Sets the initialization priority. The highest number is initialized first. Parameters: initializationPriority - the priority of the initialization.

Class PropertyType<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyType

Method Detail

getDefaultValue

setDefaultValue

hasDefaultValue

getTypeName

setTypeName

getDescription

getDescription

getRestrictions

toString

validateConstraints

validate

validateValue

toType

setTypedValue

validateNullType

getIo

setIo

getDefaultValueDescription

getDefaultValueAsString

isDefaultValueValid

equals

getLogger

postGetValueProcessing

getInitializationPriority

setInitializationPriority