dk.heick.properties.types.derived

Class ImageFromURLPropertyType

java.lang.Object

dk.heick.properties.PropertyType<T>

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

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

dk.heick.properties.types.derived.ImageFromURLPropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class ImageFromURLPropertyType
extends DerivedFromSinglePropertyType<URL,BufferedImage>
implements MarkerPathPropertyType

Loads an Image from an URL where the path is provided from another Property.

Example:

    Property<URL> URL_PROPERTY = new Property<File>("url.property", new URLPropertyType());
    Property<BufferedImage> IMAGE_PROPERTY new Property<BufferedImage>("app.my.image.stream",new ImageFromURLPropertyType(URL_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 ImageFromUrl implementation.

Constructor Summary

Constructors

Constructor and Description
ImageFromURLPropertyType(Property<URL> derivedFromUrl) Constructor where default value is null.
ImageFromURLPropertyType(Property<URL> derivedFromUrl, 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 ImageIO via an URL.

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

See Also:

Constant Field Values

Constructor Detail

ImageFromURLPropertyType

public ImageFromURLPropertyType(Property<URL> derivedFromUrl)

Constructor where default value is null.

Parameters:

derivedFromUrl - the Property which provides the URL path.

ImageFromURLPropertyType

public ImageFromURLPropertyType(Property<URL> derivedFromUrl,
                                BufferedImage defaultValue)

Constructor.

Parameters:

derivedFromUrl - the Property which provides the URL 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 ImageIO via an URL.

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

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