dk.heick.properties.types

Class DirectoryPropertyType

java.lang.Object

dk.heick.properties.PropertyType<File>

dk.heick.properties.types.DirectoryPropertyType

All Implemented Interfaces:

MarkerPathPropertyType, Serializable

public class DirectoryPropertyType
extends PropertyType<File>
implements MarkerPathPropertyType

PropertyType that validates to a file value of type directory.
This type convert and validates a string to a java.io.File. Which must be of type directory.
Options can be set if the directory must exists and/or if auto creation of the directory shall be performed.

Constructor Example			Comments
Property<File> A_PROPERTY = new Property<File>("name" , new DirectoryPropertyType());			No default value, with DefaultDirectoryValidator().
Property<File> A_PROPERTY = new Property<File>("name" , new DirectoryPropertyType(new File("c:/temp")));			Default value is "new File("c:/temp")" with DefaultDirectoryValidator.
Property<File> A_PROPERTY = new Property<File>("name" , new DirectoryPropertyType(new DefaultDirectoryValidator()));			No default value, with DefaultDirectoryValidator.
Property<File> A_PROPERTY = new Property<File>("name" , new DirectoryPropertyType(new File("c:/temp"),new DefaultDirectoryValidator()));			Default value is "new File("c:/temp")" with "new DefaultDirectoryValidator()".
Property<File> A_PROPERTY = new Property<File>("name" , new DirectoryPropertyType(new File("c:/temp"),new DefaultDirectoryValidator(true,true,true,false)));			Default value is "new File("c:/temp")" with "new DefaultDirectoryValidator(true,true,true,false)".
Type of value(s)	Examples	Result	Comments
Valid	c:/temp	new File("c:/file")	Validate successfully.
Invalid	cow	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, File.isDirectory(), File.exists(), FileValidator, DefaultDirectoryValidator, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DirectoryPropertyType() Default constructor, where default value is null and using no args constructor in DefaultDirectoryValidator.
DirectoryPropertyType(File defaultValue) Constructor with default value and using no args constructor in DefaultDirectoryValidator.
DirectoryPropertyType(File defaultValue, FileValidator fileValidator) Constructor with default value.
DirectoryPropertyType(FileValidator fileValidator) Constructor where default value is 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 DirectoryPropertyType.
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 DirectoryPropertyType.

See Also:

Constant Field Values

Constructor Detail

DirectoryPropertyType

public DirectoryPropertyType()

Default constructor, where default value is null and using no args constructor in DefaultDirectoryValidator.

• mustExists = true
• autoCreate = false
• readable = true
• writable = false

See Also:

DefaultDirectoryValidator

DirectoryPropertyType

public DirectoryPropertyType(File defaultValue)

Constructor with default value and using no args constructor in DefaultDirectoryValidator.

Parameters:

defaultValue - default value returned if property value is undefined.

See Also:

DefaultDirectoryValidator

DirectoryPropertyType

public DirectoryPropertyType(FileValidator fileValidator)

Constructor where default value is null.

Parameters:

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

See Also:

DefaultDirectoryValidator

DirectoryPropertyType

public DirectoryPropertyType(File defaultValue,
                             FileValidator fileValidator)

Constructor with default value.

Parameters:

defaultValue - default value returned if property value is undefined.

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

See Also:

FileValidator, DefaultDirectoryValidator

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 DirectoryPropertyType. Will use DefaultDirectoryValidator if this is null.

Parameters:

fileValidator - the new file validator.

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.