dk.heick.properties.types.derived

Class ImageFromFilePropertyType

java.lang.Object

dk.heick.properties.PropertyType<T>

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

dk.heick.properties.derived.DerivedFromSinglePropertyType<File,BufferedImage>

dk.heick.properties.types.derived.ImageFromFilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class ImageFromFilePropertyType
extends DerivedFromSinglePropertyType<File,BufferedImage>
implements MarkerPathPropertyType

Loads an BufferedImage from a File where the path is provided from another Property.
Example:

                Property<File> FILE_PROPERTY = new Property<File>("app.my.byte.file",new FilePropertyType());
                Property<BufferedImage> IMAGE_PROPERTY new Property<BufferedImage>("app.my.image.stream",new ImageFromFilePropertyType(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 ImageFromFile implementation.

Constructor Summary

Constructors

Constructor and Description
ImageFromFilePropertyType(Property<File> derivedFromFile) Constructor where default value is null.
ImageFromFilePropertyType(Property<File> derivedFromFile, BufferedImage defaultValue) Constructor.

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.
BufferedImage	validateDerivedValue(String propertyName) Loads a BufferedImage from a file

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 ImageFromFile implementation.

See Also:

Constant Field Values

Constructor Detail

ImageFromFilePropertyType

public ImageFromFilePropertyType(Property<File> derivedFromFile)

Constructor where default value is null.

Parameters:

derivedFromFile - the Property which provides the file path.

ImageFromFilePropertyType

public ImageFromFilePropertyType(Property<File> derivedFromFile,
                                 BufferedImage defaultValue)

Constructor.

Parameters:

derivedFromFile - the Property which provides the file path.

defaultValue - the default value of the BufferedImage.

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<BufferedImage>

Returns:

the restrictions of the PropertyType as a list of strings.

validateDerivedValue

public BufferedImage validateDerivedValue(String propertyName)
                                   throws PropertyException

Loads a BufferedImage from a file

Specified by:

validateDerivedValue in class DerivedPropertyType<BufferedImage>

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:

ImageIO.read(File)

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

No constraints.

Overrides:

validateConstraints in class DerivedPropertyType<BufferedImage>

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