dk.heick.properties.types.custom.filestructure

Class RootDirectoryNode

java.lang.Object

dk.heick.properties.types.custom.filestructure.AbstractTreeNode

dk.heick.properties.types.custom.filestructure.DirectoryNode

dk.heick.properties.types.custom.filestructure.RootDirectoryNode

All Implemented Interfaces:

Serializable

public final class RootDirectoryNode
extends DirectoryNode

This is the root node to initialize the FileStructurePropertyType with.
Every child directory or files, branches out from this node.
When the property value is loaded, it is the base directory, which this root node is initialized with.

Since:

1.1

Author:

Frederik Heick

See Also:

DirectoryNode, AbstractTreeNode, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RootDirectoryNode() Default constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getRestrictions() Gets a detailed description of the AbstractTreeNode implementation with any constraints that might influence the validation.
void	initialize(File rootDirectory) This method initalizes the root directory node with a directory path.
void	initialize(String rootDirectory) This method initalizes the root directory node with a directory path.

Methods inherited from class dk.heick.properties.types.custom.filestructure.DirectoryNode

addChild, getChildren, size, validate

Methods inherited from class dk.heick.properties.types.custom.filestructure.AbstractTreeNode

equals, exists, getFile, getFiles, getName, getParentNode, getValidator, hashCode, hasParentNode, isInitialized, isRootNode, reset, setInitialized, setName, setParentNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RootDirectoryNode

public RootDirectoryNode()

Default constructor. Initialized with DefaultDirectoryValidator().

See Also:

DefaultDirectoryValidator.DefaultDirectoryValidator()

Method Detail

initialize

public final void initialize(String rootDirectory)
                      throws PropertyException

This method initalizes the root directory node with a directory path.
Than it validates "this" node and all it child nodes.
It also validates for any cyclic references.
This is the method FileStructurePropertyType calls when loading the value.

Parameters:

rootDirectory - the String value that identifies the root node path.

Throws:

PropertyException

See Also:

PropertyType.validate(String, String)

initialize

public final void initialize(File rootDirectory)
                      throws PropertyException

This method initalizes the root directory node with a directory path.
Than it validates "this" node and all it child nodes.
It also validates for any cyclic references.
This is the method FileStructurePropertyType calls when loading the value.

Parameters:

rootDirectory - the file value that identifies the root node path.

Throws:

PropertyException

See Also:

PropertyType.validate(String, String)

getRestrictions

public List<String> getRestrictions()

Description copied from class: AbstractTreeNode

Gets a detailed description of the AbstractTreeNode implementation with any constraints that might influence the validation.

Overrides:

getRestrictions in class DirectoryNode

Returns:

the description of the node.