dk.heick.properties.derived

Class DerivedFromTypePropertyType<K,T>

java.lang.Object

dk.heick.properties.PropertyType<T>

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

dk.heick.properties.derived.DerivedFromTypePropertyType<K,T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileDerivedPropertyType, URLDerivedPropertyType

public class DerivedFromTypePropertyType<K,T>
extends DerivedPropertyType<T>

A convenience implementation of DerivedPropertyType where it is dependent on one property, and has an implementation which can convert it.
Where type K is the resulting type of the derivedFrom Property<K>, and type <T> is the resulting type of this PropertyType.
This requires an implementation of TypeFromGeneric<K,T>.

Since:

1.9

Author:

Frederik Heick

See Also:

TypeFromGeneric, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DerivedFromTypePropertyType(Property<K> derivedFromType, TypeFromGeneric<K,T> fromType) Constructor where defaultValue is null.
DerivedFromTypePropertyType(Property<K> derivedFromType, TypeFromGeneric<K,T> fromType, T defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
Property<K>	getDerivedFromType() Gets the one Property which this PropertyType is dependent on.
K	getDerivedFromValue() Gets the value K of the dependent property.
List<String>	getDerivedToRestrictions() Gets the restrictions from the "FromType", than adds the default value description.
TypeFromGeneric<K,T>	getFromType() Gets the implementation of TypeFromGeneric.
void	validateConstraints(String propertyName) Validates the DerivedFromTypePropertyType.
T	validateDerivedValue(String propertyName) Use the TypeFromGeneric#fromType method to convert the value to type T.

Methods inherited from class dk.heick.properties.derived.DerivedPropertyType

getDerivedFrom, getDerivedFromCount, getDerivedFromProperty, getDerivedFromRestrictions, getMaxDerivedFrom, getMinDerivedFrom, getRestrictions, isMinAndMaxTheSame, isUseMaxDerivedFrom, isUseMinDerivedFrom, validateValue

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

DerivedFromTypePropertyType

public DerivedFromTypePropertyType(Property<K> derivedFromType,
                                   TypeFromGeneric<K,T> fromType)
                            throws NullPointerException

Constructor where defaultValue is null.

Parameters:

derivedFromType - the one Property which this type is derived from.

fromType - the implementation of TypeFromGeneric which can convert the one Property to the type T.

Throws:

NullPointerException - if fromType is null.

DerivedFromTypePropertyType

public DerivedFromTypePropertyType(Property<K> derivedFromType,
                                   TypeFromGeneric<K,T> fromType,
                                   T defaultValue)
                            throws NullPointerException

Constructor.

Parameters:

derivedFromType - the one Property which this type is derived from.

fromType - the implementation of TypeFromGeneric which can convert the one Property to the type T.

defaultValue - a default value of type T.

Throws:

NullPointerException - if fromType is null.

Method Detail

getDerivedFromType

public final Property<K> getDerivedFromType()

Gets the one Property which this PropertyType is dependent on. This is of type K.

Returns:

the dependent Property with type K.

getDerivedFromValue

public final K getDerivedFromValue()

Gets the value K of the dependent property.

Returns:

the value of the one dependent Property.

validateDerivedValue

public final T validateDerivedValue(String propertyName)
                             throws PropertyException

Use the TypeFromGeneric#fromType method to convert the value to type T.

Specified by:

validateDerivedValue in class DerivedPropertyType<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.

See Also:

TypeFromGeneric.fromType(String, Object)

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Validates the DerivedFromTypePropertyType. Will throw an PropertyException if:

• DerivedPropertyType.validateConstraints() fails.
• FromType instance is null.
• FromType.validateConstraints() fails.
• DerivedFromType().validate() fails.

Overrides:

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

getDerivedToRestrictions

public List<String> getDerivedToRestrictions()

Gets the restrictions from the "FromType", than adds the default value description.
The individual restriction for the Property (K) is listed in the DerivedPropertyType.getDerivedFromRestrictions().

Specified by:

getDerivedToRestrictions in class DerivedPropertyType<T>

Returns:

the restrictions of the PropertyType as a list of strings.

See Also:

TypeFromGeneric.getRestrictions(), DerivedPropertyType.getDerivedFromRestrictions()

getFromType

public TypeFromGeneric<K,T> getFromType()

Gets the implementation of TypeFromGeneric.

Returns:

the fromType