FileSystemNode (Debian Package Maven Plugin 1.0.5 API)

Type Parameters:

A - The type of the attachment.

All Known Implementing Classes:

FileSystemNodeImpl
```
public interface FileSystemNode<A>
```
A node representing a file or directory in the file system.

Version:

1.0, 10.05.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FileSystemNode<A>`	`addChild(FileSystemNode<A> child)` Adds a child node to this node.
`boolean`	`containsOnlyCreatedByDependency()` Returns the flag if the child nodes (recursively) are all created by dependency.
`FileSystemNode<A>`	`createChildDirectory(String name, FileOwner owner, FileMode mode, A attachment)` Creates a child node within this node representing a directory.
`FileSystemNode<A>`	`createChildFile(String name, FileOwner owner, FileMode mode, A attachment)` Creates a child node within this node representing a file.
`FileSystemNode<A>`	`createChildSymLink(String name, Path target, FileOwner owner, FileMode mode, A attachment)` Creates a child node within this node representing a file.
`FileSystemNode<A>`	`createDirectories(Path path)` Creates a node for the directory specified by the path and all directories on the path there.
`A`	`getAttachment()` Returns the attachment.
`FileSystemNode<A>`	`getChild(String name)` Returns the child node with the specified name.
`FileMode`	`getMode()` Returns the mode.
`String`	`getName()` Returns the name of the node.
`FileSystemNode<A>`	`getNode(Path path)` Returns the node for the specified path.
`FileOwner`	`getOwner()` Returns the owner.
`FileSystemNode<A>`	`getParent()` Returns the parent.
`Path`	`getPath()` Returns the path of the node.
`Path`	`getSymLinkTarget()` Returns the path of the target of the symbolic link.
`boolean`	`isCreatedByDependency()` Returns the flag if this node was created by a dependency.
`boolean`	`isDirectory()` Returns the flag if the node represents a directory.
`boolean`	`isFile()` Returns the flag if the node represents a file.
`boolean`	`isSymLink()` Returns the flag if the node represents a symbolic link.
`List<FileSystemNode<A>>`	`moveChildrenTo(FileSystemNode<A> node)` Moves all child nodes of this node to the specified node.
`boolean`	`removeChild(FileSystemNode<A> child)` Removes the specified child node.
`FileSystemNode<A>`	`removeChild(String name)` Removes the child node with the specified name.
`void`	`setAttachment(A attachment)` Sets the attachment.
`FileSystemNode<A>`	`setParent(FileSystemNode<A> parent)` Sets the parent.
`FileSystemNodeVisitResult`	`walkNodeTree(FileSystemNodeVisitor<A> visitor)` Walks the node tree starting at this node.

- Method Detail
  - getParent
```
FileSystemNode<A> getParent()
```
    Returns the parent.
    
    Returns:
    
    The parent or null, if this node is the root node.
  - setParent
```
FileSystemNode<A> setParent(FileSystemNode<A> parent)
```
    Sets the parent.
    
    Parameters:
    
    parent - The parent or null, if this node should be the root node.
    
    Returns:
    
    The previous parent or null, if this node wasn't a child node before.
  - getName
```
String getName()
```
    Returns the name of the node.
    
    Returns:
    
    The name.
  - getPath
```
Path getPath()
```
    Returns the path of the node.
    
    Returns:
    
    The path.
  - getSymLinkTarget
```
Path getSymLinkTarget()
```
    Returns the path of the target of the symbolic link.
    
    Returns:
    
    The path or null, if the node doesn't represent a symbolic link.
    
    See Also:
    
    isSymLink()
  - getOwner
```
FileOwner getOwner()
```
    Returns the owner.
    
    Returns:
    
    The owner.
  - getMode
```
FileMode getMode()
```
    Returns the mode.
    
    Returns:
    
    The mode.
  - isDirectory
```
boolean isDirectory()
```
    Returns the flag if the node represents a directory.
    
    Returns:
    
    The flag: true, if the node represents a directory, false otherwise.
  - isFile
```
boolean isFile()
```
    Returns the flag if the node represents a file.
    
    Symbolic links are handled as files.
    
    Returns:
    
    The flag: true, if the node represents a file, false otherwise.
    
    See Also:
    
    isSymLink()
  - isSymLink
```
boolean isSymLink()
```
    Returns the flag if the node represents a symbolic link.
    
    Returns:
    
    The flag: true, if the node represents a symbolic link, false otherwise.
    
    See Also:
    
    getSymLinkTarget()
  - getAttachment
```
A getAttachment()
```
    Returns the attachment.
    
    Returns:
    
    The attachment file or null, if no attachment is set.
  - setAttachment
```
void setAttachment(A attachment)
```
    Sets the attachment.
    
    Parameters:
    
    attachment - The attachment.
  - createChildDirectory
```
FileSystemNode<A> createChildDirectory(String name,
                                       FileOwner owner,
                                       FileMode mode,
                                       A attachment)
```
    Creates a child node within this node representing a directory.
    
    Parameters:
    
    name - The name.
    
    owner - The owner.
    
    mode - The mode.
    
    attachment - The attachment (optional).
    
    Returns:
    
    The child node.
    
    Throws:
    
    IllegalArgumentException - If any of the non-optional parameters are null.
    
    IllegalStateException - If this node does not represents a directory or if a child node with the specified name already exists.
  - createChildFile
```
FileSystemNode<A> createChildFile(String name,
                                  FileOwner owner,
                                  FileMode mode,
                                  A attachment)
```
    Creates a child node within this node representing a file.
    
    Parameters:
    
    name - The name.
    
    owner - The owner.
    
    mode - The mode.
    
    attachment - The attachment (optional).
    
    Returns:
    
    The child node.
    
    Throws:
    
    IllegalArgumentException - If any of the non-optional parameters are null.
    
    IllegalStateException - If this node does not represents a directory or if a child node with the specified name already exists.
  - createChildSymLink
```
FileSystemNode<A> createChildSymLink(String name,
                                     Path target,
                                     FileOwner owner,
                                     FileMode mode,
                                     A attachment)
```
    Creates a child node within this node representing a file.
    
    Parameters:
    
    name - The name.
    
    target - The path of the target.
    
    owner - The owner.
    
    mode - The mode.
    
    attachment - The attachment (optional).
    
    Returns:
    
    The child node.
    
    Throws:
    
    IllegalArgumentException - If any of the non-optional parameters are null.
    
    IllegalStateException - If this node does not represents a directory or if a child node with the specified name already exists.
  - addChild
```
FileSystemNode<A> addChild(FileSystemNode<A> child)
```
    Adds a child node to this node.
    
    Parameters:
    
    child - The child node.
    
    Returns:
    
    The child node which was replaced by the specified child node or null, if no child node with the same name exists.
    
    Throws:
    
    IllegalArgumentException - If the child node is null.
    
    IllegalStateException - If this node does not represent a directory.
  - getChild
```
FileSystemNode<A> getChild(String name)
```
    Returns the child node with the specified name.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    The child node or null, if no child node with the specified name exists.
    
    Throws:
    
    IllegalArgumentException - If the name is null.
    
    IllegalStateException - If this node does not represent a directory.
  - removeChild
```
FileSystemNode<A> removeChild(String name)
```
    Removes the child node with the specified name.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    The removed child node or null, if no child node with the specified name exists.
    
    Throws:
    
    IllegalArgumentException - If the name is null.
    
    IllegalStateException - If this node does not represent a directory.
  - removeChild
```
boolean removeChild(FileSystemNode<A> child)
```
    Removes the specified child node.
    
    Parameters:
    
    child - The child node.
    
    Returns:
    
    true, if the child node was successfully removed, false, if the specified node is not a child node of this node.
    
    Throws:
    
    IllegalArgumentException - If the child node is null.
    
    IllegalStateException - If this node does not represent a directory.
  - moveChildrenTo
```
List<FileSystemNode<A>> moveChildrenTo(FileSystemNode<A> node)
```
    Moves all child nodes of this node to the specified node.
    
    Parameters:
    
    node - The node.
    
    Returns:
    
    All child nodes which were replaced in the specified node by the child nodes of this node.
    
    Throws:
    
    IllegalArgumentException - If the node is null.
    
    IllegalStateException - If this node or the specified node do not represent a directory.
  - createDirectories
```
FileSystemNode<A> createDirectories(Path path)
```
    Creates a node for the directory specified by the path and all directories on the path there.
    
    All created directories are marked as created by a dependency.
    
    Parameters:
    
    path - The path.
    
    Returns:
    
    The node representing the directory.
    
    Throws:
    
    IllegalArgumentException - If the path is null.
    
    IllegalStateException - If this node does not represent a directory or any of the already existing nodes along the path.
  - getNode
```
FileSystemNode<A> getNode(Path path)
```
    Returns the node for the specified path.
    
    Parameters:
    
    path - The path.
    
    Returns:
    
    The node or null, if the node or any nodes on path to it don't exist.
    
    Throws:
    
    IllegalArgumentException - If the path is null.
    
    IllegalStateException - If any node along the path - except the node of the last part - does not represent a directory.
  - isCreatedByDependency
```
boolean isCreatedByDependency()
```
    Returns the flag if this node was created by a dependency.
    
    This is the case if a sub-folder was added, but the parent weren't added before and created automatically.
    
    Returns:
    
    The flag: true, if this node was created by a dependency, false otherwise.
    
    See Also:
    
    containsOnlyCreatedByDependency()
  - containsOnlyCreatedByDependency
```
boolean containsOnlyCreatedByDependency()
```
    Returns the flag if the child nodes (recursively) are all created by dependency.
    
    This method doesn't check the flag of this node.
    
    Returns:
    
    The flag: true, if all child nodes were created by a dependency, false otherwise.
    
    See Also:
    
    isCreatedByDependency()
  - walkNodeTree
```
FileSystemNodeVisitResult walkNodeTree(FileSystemNodeVisitor<A> visitor)
                                throws IOException
```
    Walks the node tree starting at this node.
    
    Parameters:
    
    visitor - The visitor to invoke for each node.
    
    Returns:
    
    The visit result of this node.
    
    Throws:
    
    IllegalArgumentException - If the visitor is null.
    
    IOException - If an I/O error occurs.

Interface FileSystemNode<A>

Method Summary

Method Detail

getParent

setParent

getName

getPath

getSymLinkTarget

getOwner

getMode

isDirectory

isFile

isSymLink

getAttachment

setAttachment

createChildDirectory

createChildFile

createChildSymLink

addChild

getChild

removeChild

removeChild

moveChildrenTo

createDirectories

getNode

isCreatedByDependency

containsOnlyCreatedByDependency

walkNodeTree