dk.heick.properties.derived

Interface TypeFromGeneric<K,T>

Type Parameters:

K - the object typed K which can can be converted to the type T.

T - the result type T.

All Known Implementing Classes:

KeyMultiLineValuesFromTextFile, KeyValuesFromTextFile, TypeListFromTextFile

public interface TypeFromGeneric<K,T>

The generic interface which can convert from one type to another type.

Since:

1.9

Author:

Frederik Heick

Method Summary

Modifier and Type	Method and Description
T	fromType(String propertyName, K from) The method which converts K to the type T.
org.apache.commons.logging.Log	getLogger() Gets a logger.
List<String>	getRestrictions() Gets a detailed description of the TypeFromGeneric with any constraints that might influence the validation.
String	getTypeName() The simpel short name.
void	validateConstraints(String propertyName) Validates the constraints for the type.

Method Detail

fromType

T fromType(String propertyName,
           K from)
    throws PropertyException

The method which converts K to the type T.

Parameters:

propertyName - the name of the property, this is Derived Property, not the Property which supplies the import for the type conversion.

from - the type K

Returns:

to the type T

Throws:

PropertyException - if the conversion could not be performed.

getTypeName

String getTypeName()

The simpel short name. as "PublicKey from File"

Returns:

the short identifing type name.

validateConstraints

void validateConstraints(String propertyName)
                  throws PropertyException

Validates the constraints for the type.

Parameters:

propertyName - the name of the property which validates the constraints, this is Derived Property, not the Property which supplies the import for the type conversion.

Throws:

PropertyException - if the constraints do not hold.

getRestrictions

List<String> getRestrictions()

Gets a detailed description of the TypeFromGeneric 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.
Do NOT need to include the Property it is dependent on, since DerivedFromTypePropertyType will ensure that this is included.

Returns:

the restictions as a list of Strings, please as unmodifiable.

See Also:

StringList, StringList.asUnmodifiableList()

getLogger

org.apache.commons.logging.Log getLogger()

Gets a logger.

Returns:

a logger