dk.heick.properties.types.derived

Class TextFromFilePropertyType

java.lang.Object

dk.heick.properties.PropertyType<T>

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

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

dk.heick.properties.types.derived.TextFromFilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class TextFromFilePropertyType
extends DerivedFromSinglePropertyType<File,String>
implements MarkerPathPropertyType

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

 Property<File> FILE_PROPERTY = new Property<File>("file.property", new FilePropertyType(new File("c:\temp\test.htm"));
 Property<String> A_PROPERTY= new Property<String>("name", new TextFromFilePropertyType(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 TextFromFile implementation.

Constructor Summary

Constructors

Constructor and Description
TextFromFilePropertyType(Property<File> derivedFromFile) Loads a property value into a String, derived from a File using the Charset.defaultCharset() encoding.
TextFromFilePropertyType(Property<File> derivedFromFile, Charset encoding) Loads a property value into a String, derived from a File.
TextFromFilePropertyType(Property<File> derivedFromFile, Charset encoding, String defaultValue) Loads a property value into a String, derived from a File.
TextFromFilePropertyType(Property<File> derivedFromFile, String encoding) Loads a property value into a String, derived from a File.
TextFromFilePropertyType(Property<File> derivedFromFile, String encoding, String defaultValue) Loads a property value into a String, 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".
String	getEncoding()
void	validateConstraints(String propertyName) Validates the TextFromFile type constraints.
String	validateDerivedValue(String propertyName) Loads the file with the FileUtils.

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

See Also:

Constant Field Values

Constructor Detail

TextFromFilePropertyType

public TextFromFilePropertyType(Property<File> derivedFromFile,
                                String encoding)

Loads a property value into a String, derived from a File.

Parameters:

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

encoding - the encoding of the file, where the encoding is parsed as a string.

TextFromFilePropertyType

public TextFromFilePropertyType(Property<File> derivedFromFile,
                                Charset encoding)
                         throws NullPointerException

Loads a property value into a String, derived from a File.

Parameters:

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

encoding - the encoding of the file, where the encoding is parsed as a Charset.

Throws:

NullPointerException - if encoding is null. *

See Also:

StandardCharsets

TextFromFilePropertyType

public TextFromFilePropertyType(Property<File> derivedFromFile)

Loads a property value into a String, derived from a File using the Charset.defaultCharset() encoding.

Parameters:

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

See Also:

Charset.defaultCharset()

TextFromFilePropertyType

public TextFromFilePropertyType(Property<File> derivedFromFile,
                                String encoding,
                                String defaultValue)

Loads a property value into a String, derived from a File.

Parameters:

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

encoding - the encoding of the file, where the encoding is parsed as a string.

TextFromFilePropertyType

public TextFromFilePropertyType(Property<File> derivedFromFile,
                                Charset encoding,
                                String defaultValue)
                         throws NullPointerException

Loads a property value into a String, derived from a File.

Parameters:

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

encoding - the encoding of the file, where the encoding is parsed as a Charset.

Throws:

NullPointerException - if encoding is null.

See Also:

StandardCharsets

Method Detail

getEncoding

public String getEncoding()

Returns:

the encoding

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateDerivedValue

public String validateDerivedValue(String propertyName)
                            throws PropertyException

Loads the file with the FileUtils.

Specified by:

validateDerivedValue in class DerivedPropertyType<String>

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.loadAsString(String, File, String)

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Validates the TextFromFile type constraints. Will throw an PropertyException if:

• Encoding for TextFromFile is null.
• Encoding for TextFromFile is empty.
• Unknown CharsetName encoding.
• Unsupported Charset encoding.

Overrides:

validateConstraints in class DerivedPropertyType<String>

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