dk.heick.properties.derived

Class DerivedPropertyType<T>

java.lang.Object

dk.heick.properties.PropertyType<T>

dk.heick.properties.derived.DerivedPropertyType<T>

Type Parameters:

T - the resulting type.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CertificateKeyStoredPropertyType, CertificateSignedFilePropertyType, DerivedFromSinglePropertyType, DerivedFromTypePropertyType, KeySignedFilePropertyType, KeyStoreFilePropertyType

public abstract class DerivedPropertyType<T>
extends PropertyType<T>

An abstract and readonly PropertyType, where the resulting type is dependent on other Property values. One or many, will be initialize last by the PropertyInitializationPriorityComparator.

Since:

1.9

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DerivedPropertyType(String typeName, Integer minDerivedFrom, Integer maxDerivedFrom, Property<?>... derivedFrom) Constructor.
DerivedPropertyType(String typeName, Integer derivedFromCount, Property<?>... derivedFrom) Constructor.
DerivedPropertyType(String typeName, Property<?>... derivedFrom) Constructor.
DerivedPropertyType(String typeName, Property<?> derivedFromType) Constructs a DerivedPropertyType where the type only has one Property it derives from and default value is null.
DerivedPropertyType(String typeName, Property<?> derivedFromType, T defaultValue) Constructs a DerivedPropertyType where the type only has one Property it derives from.
DerivedPropertyType(String typeName, T defaultValue, Integer minDerivedFrom, Integer maxDerivedFrom, Property<?>... derivedFrom) Constructor.
DerivedPropertyType(String typeName, T defaultValue, Integer derivedFromCount, Property<?>... derivedFrom) Constructor.
DerivedPropertyType(String typeName, T defaultValue, Property<?>... derivedFrom) Constructor.

Method Summary

Modifier and Type	Method and Description
Property<?>[]	getDerivedFrom() Gets the array of Property's which this PropertyType is dependent on.
int	getDerivedFromCount() Gets the number of dependent Property which is provided.
Property<?>	getDerivedFromProperty(int index) Gets a specific dependent Property in the array.
List<String>	getDerivedFromRestrictions() Return a list of all the restrictions the DerivedPropertyType has.
abstract List<String>	getDerivedToRestrictions() Gets a detailed description of the "Derived->TO->PropertyType" with any constraints that might influence the validation. Without any futher description of of the properties it is derived from, this is taken care of in the method "getDerivedFromRestrictions".
Integer	getMaxDerivedFrom() Gets the maximum number of dependent Property which is allowed.
Integer	getMinDerivedFrom() Gets the minimum number of dependent Property which is required.
List<String>	getRestrictions() A list of first "getDerivedToRestrictions" then "getDerivedFromRestrictions".
protected boolean	isMinAndMaxTheSame()
boolean	isUseMaxDerivedFrom() Is maximum limit used.
boolean	isUseMinDerivedFrom() Is minimum limit used.
void	validateConstraints(String propertyName) Validates the DerivedPropertyType.
abstract T	validateDerivedValue(String propertyName) Should convert the dependent Properties to the type T.
T	validateValue(String propertyName, String value) This is the normal PropertyType validation method, which is overridden an calls validateDerivedValue(name), from where the implementation must take the provided properties and convert them into the appropiate type T.

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

Constructor Detail

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           Property<?>... derivedFrom)
                    throws NullPointerException

Constructor. Where default value is null, and minDerivedFrom is 1, and maxDerivedFrom is null.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

derivedFrom - an array of other Property's, at least one must be provided.

Throws:

NullPointerException - if typeName is null.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           Integer derivedFromCount,
                           Property<?>... derivedFrom)
                    throws NullPointerException

Constructor. Where default value is null, and minDerivedFrom and maxDerivedFrom is the same.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

derivedFromCount - the number for both tt>minDerivedFrom and maxDerivedFrom. If null or -1 this is ignored.

derivedFrom - an array of other Property's, at least one must be provided.

Throws:

NullPointerException - if typeName is null.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           T defaultValue,
                           Property<?>... derivedFrom)
                    throws NullPointerException

Constructor. Where minDerivedFrom is 1, and maxDerivedFrom is null.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

defaultValue - a default value of type T.

derivedFrom - an array of other Property's, at least one must be provided.

Throws:

NullPointerException - if typeName is null.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           T defaultValue,
                           Integer derivedFromCount,
                           Property<?>... derivedFrom)
                    throws NullPointerException

Constructor. Where default value is null, and minDerivedFrom and maxDerivedFrom is the same.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

defaultValue - a default value of type T.

derivedFromCount - the number for both minDerivedFrom and maxDerivedFrom. If null or -1 this is ignored.

derivedFrom - an array of other Property's, at least one must be provided.

Throws:

NullPointerException - if typeName is null.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           Integer minDerivedFrom,
                           Integer maxDerivedFrom,
                           Property<?>... derivedFrom)
                    throws NullPointerException

Constructor. Where default value is null.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

minDerivedFrom - the minimum number of dependent Property's which must be provided in the "derivedFrom" array. If null or -1 this is ignored.

maxDerivedFrom - the maximum number of dependent Property's which must be provided in the "derivedFrom" array. If null or -1 this is ignored.

derivedFrom - an array of other Property's, at least one must be provided.

Throws:

NullPointerException - if typeName is null.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           T defaultValue,
                           Integer minDerivedFrom,
                           Integer maxDerivedFrom,
                           Property<?>... derivedFrom)
                    throws NullPointerException

Constructor.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

defaultValue - a default value of type T.

minDerivedFrom - the minimum number of dependent Property's which must be provided in the "derivedFrom" array. If null or -1 this is ignored.

maxDerivedFrom - the maximum number of dependent Property's which must be provided in the "derivedFrom" array. If null or -1 this is ignored.

derivedFrom - an array of other Property's, at least one must be provided.

Throws:

NullPointerException - if typeName is null.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           Property<?> derivedFromType)

Constructs a DerivedPropertyType where the type only has one Property it derives from and default value is null.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

derivedFromType - the Property which the DerivedPropertyType is derived from.

DerivedPropertyType

public DerivedPropertyType(String typeName,
                           Property<?> derivedFromType,
                           T defaultValue)

Constructs a DerivedPropertyType where the type only has one Property it derives from.

Parameters:

typeName - a short name of the the resulting type. Example "Text from file", "PublicKey from file", "XML from URL".

derivedFromType - the Property which the DerivedPropertyType is derived from.

defaultValue - the default value of the DerivedPropertyType.

Method Detail

getDerivedFrom

public final Property<?>[] getDerivedFrom()

Gets the array of Property's which this PropertyType is dependent on.

Returns:

an Property array.

getMinDerivedFrom

public final Integer getMinDerivedFrom()

Gets the minimum number of dependent Property which is required.

Returns:

the minimum number of dependent Property which is required, if null or -1 this means no limit. Though at least one must be provided.

getMaxDerivedFrom

public final Integer getMaxDerivedFrom()

Gets the maximum number of dependent Property which is allowed.

Returns:

the maximum number of dependent Property which is allowed, if null or -1 this means no limit.

getDerivedFromCount

public final int getDerivedFromCount()

Gets the number of dependent Property which is provided.

Returns:

the number of dependent Property's.

isUseMinDerivedFrom

public final boolean isUseMinDerivedFrom()

Is minimum limit used.

Returns:

true if value is not null and greater than -1, otherwise false.

isUseMaxDerivedFrom

public final boolean isUseMaxDerivedFrom()

Is maximum limit used.

Returns:

true if value is not null and greater than -1, otherwise false.

getDerivedFromProperty

public final Property<?> getDerivedFromProperty(int index)
                                         throws ArrayIndexOutOfBoundsException

Gets a specific dependent Property in the array.

Parameters:

index - the index in the dependent Property array.

Returns:

the dependent Property at the index.

Throws:

ArrayIndexOutOfBoundsException - if the index is outside array bounds.

isMinAndMaxTheSame

protected final boolean isMinAndMaxTheSame()

getRestrictions

public final List<String> getRestrictions()

A list of first "getDerivedToRestrictions" then "getDerivedFromRestrictions".

Specified by:

getRestrictions in class PropertyType<T>

Returns:

the restrictions of the PropertyType as a list of strings.

getDerivedToRestrictions

public abstract List<String> getDerivedToRestrictions()

Gets a detailed description of the "Derived->TO->PropertyType" with any constraints that might influence the validation.
Without any futher description of of the properties it is derived from, this is taken care of in the method "getDerivedFromRestrictions". 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.

getDerivedFromRestrictions

public final List<String> getDerivedFromRestrictions()

Return a list of all the restrictions the DerivedPropertyType has.
How many properties it is dependent on, and their individual restrictions.
Can be used in classes which extends this class. *

Returns:

the restrictions as a UnmodifiableList

See Also:

StringList

validateValue

public final T validateValue(String propertyName,
                             String value)
                      throws PropertyException

This is the normal PropertyType validation method, which is overridden an calls validateDerivedValue(name), from where the implementation must take the provided properties and convert them into the appropiate type T. The value String is not used.

Specified by:

validateValue in class PropertyType<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.

See Also:

validateDerivedValue(String)

validateDerivedValue

public abstract T validateDerivedValue(String propertyName)
                                throws PropertyException

Should convert the dependent Properties to the type T.

Parameters:

propertyName - the name of derived Property

Returns:

the type T from the property dependencies.

Throws:

PropertyException - if it could not be converted into type T.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Validates the DerivedPropertyType. Will throw an PropertyException if:

• The typename is null.
• The typename is empty, after trim.
• The array of derivedFrom is null.
• The array of derivedFrom has the length 0.
• One of the derivedFrom property is null.
• One of the derivedFrom property is invalid.
• Below the required of derivedFrom properties.
• Above the allowed of derivedFrom properties

Overrides:

validateConstraints in class PropertyType<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()