dk.heick.properties.types

Class FilePropertyType

java.lang.Object

dk.heick.properties.PropertyType<File>

dk.heick.properties.types.FilePropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class FilePropertyType
extends PropertyType<File>
implements MarkerPathPropertyType

PropertyType that validates to a file value of type file.
This type convert and validates a string to a java.io.File. Which must be of type file.
Options can be set if the file must exists.

Constructor Example			Comments
Property<File> A_PROPERTY = new Property<File>("name", new FilePropertyType());			No default value, with DefaultFileValidator().
Property<File> A_PROPERTY = new Property<File>("name", new FilePropertyType(new File("c:\temp\test.htm"));			Default value is "new File("c:/temp/test.htm")", with DefaultFileValidator.
Property<File> A_PROPERTY = new Property<File>("name", new FilePropertyType(new File(new DefaultXmlFileValidator()));			No default value, with DefaultXmlFileValidator.
Property<File> A_PROPERTY = new Property<File>("name", new FilePropertyType(new File("c:\temp\test.htm"),new DefaultXmlFileValidator()));			Default value is "new File("c:/temp/test.htm")", "new DefaultDirectoryValidator()".
Property<File> A_PROPERTY = new Property<File>("name", new FilePropertyType(new File("c:\temp\test.htm"),new DefaultFileValidator(true,true,false,AcceptFileType.BOTH)));			Default value is "new File("c:/temp/test.htm")", with "new DefaultFileValidator(true,true,false,AcceptFileType.BOTH)".
Type of value(s)	Examples	Result	Comments
Valid	c:/temp/cow.txt	new File("c:/file/cow.txt")	Validate successfully.
Invalid	idontexists.txt	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.0

Author:

Frederik Heick

See Also:

File, DefaultFileValidator, DefaultXmlFileValidator, File.isFile(), File.exists(), Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FilePropertyType() Constructor, sets the default value to null and no args instance of DefaultFileValidator.
FilePropertyType(File defaultValue) Constructor, sets the default value and no args instance of DefaultFileValidator.
FilePropertyType(File defaultValue, FileValidator fileValidator) Constructor.
FilePropertyType(FileValidator fileValidator) Constructor, sets the default value to null.

Method Summary

Modifier and Type	Method and Description
FileValidator	getFileValidator() The file validator instance
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
void	setFileValidator(FileValidator fileValidator) Sets the file validator for the FilePropertyType.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
File	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

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 FilePropertyType.

See Also:

Constant Field Values

Constructor Detail

FilePropertyType

public FilePropertyType()

Constructor, sets the default value to null and no args instance of DefaultFileValidator.

• mustExists = true
• readable = true
• writable = false
• acceptFileType = AcceptFileType.FILE

FilePropertyType

public FilePropertyType(File defaultValue)

Constructor, sets the default value and no args instance of DefaultFileValidator.

• mustExists = true
• readable = true
• writable = false
• acceptFileType = AcceptFileType.FILE

Parameters:

defaultValue - default value returned if property value is undefined.

FilePropertyType

public FilePropertyType(FileValidator fileValidator)

Constructor, sets the default value to null.

Parameters:

fileValidator - instance of FileValidator, this may not be null. Will use DefaultFileValidator if it is null.

See Also:

DefaultFileValidator

FilePropertyType

public FilePropertyType(File defaultValue,
                        FileValidator fileValidator)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

fileValidator - instance of FileValidator, this may not be null. Will use DefaultFileValidator if it is null.

See Also:

DefaultFileValidator

Method Detail

getFileValidator

public FileValidator getFileValidator()

The file validator instance

Returns:

file validator

setFileValidator

public void setFileValidator(FileValidator fileValidator)

Sets the file validator for the FilePropertyType. Will use DefaultFileValidator if this is null.

Parameters:

fileValidator - the new file validator.

See Also:

DefaultFileValidator

validateValue

public File validateValue(String propertyName,
                          String value)
                   throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<File>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from class: PropertyType

A PropertyType can have some constraints here is where they are validated.
The constraints of a PropertyType is always assumed to be valid, but what if they are not.
Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
This is the method where we validate the constraints of a PropertyType before any value is actually validated.
Any many cases this will not be nessecary.
This method is call in Property.validate();

Overrides:

validateConstraints in class PropertyType<File>

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

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType 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.

Specified by:

getRestrictions in class PropertyType<File>

Returns:

the restrictions of the PropertyType as a list of strings.