dk.heick.properties.types.derived

Class BytesFromFilePropertyType

java.lang.Object

dk.heick.properties.PropertyType<T>

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

dk.heick.properties.derived.DerivedFromSinglePropertyType<File,byte[]>

dk.heick.properties.types.derived.BytesFromFilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class BytesFromFilePropertyType
extends DerivedFromSinglePropertyType<File,byte[]>
implements MarkerPathPropertyType

Loads a file into a byte array, where the file derives from a property which returns a File.
Example:

                Property<File> FILE_PROPERTY = new Property<File>("app.my.byte.file",new FilePropertyType());
                Property<byte[]> BYTE_PROPERTY new Property<byte[]>("app.my.byte.stream",new BytesFromFilePropertyType(FILE_PROPERTY));
 

Since:

1.9

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of ByteFromFile implementation.

Constructor Summary

Constructors

Constructor and Description
BytesFromFilePropertyType(Property<File> derivedFromFile) Loads a property value into a byte array, derived from a File.

Method Summary

Modifier and Type	Method and Description
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".
void	validateConstraints(String propertyName) No constraints
byte[]	validateDerivedValue(String propertyName) Using the FileUtils.loadAsBytes(String,File) to load bytes.

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

getDerivedFromProperty, getDerivedFromPropertyValue

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

Field Detail

TYPE

public static final String TYPE

The type name string constant of ByteFromFile implementation.

See Also:

Constant Field Values

Constructor Detail

BytesFromFilePropertyType

public BytesFromFilePropertyType(Property<File> derivedFromFile)

Loads a property value into a byte array, derived from a File.

Parameters:

derivedFromFile - derivedFromFile the Property which defines the file to load from.

Method Detail

getDerivedToRestrictions

public List<String> getDerivedToRestrictions()

Description copied from class: DerivedPropertyType

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.

Specified by:

getDerivedToRestrictions in class DerivedPropertyType<byte[]>

Returns:

the restrictions of the PropertyType as a list of strings.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

No constraints

Overrides:

validateConstraints in class DerivedPropertyType<byte[]>

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()

validateDerivedValue

public byte[] validateDerivedValue(String propertyName)
                            throws PropertyException

Using the FileUtils.loadAsBytes(String,File) to load bytes.

Specified by:

validateDerivedValue in class DerivedPropertyType<byte[]>

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:

FileUtils.loadAsBytes(String, File)