net.sourceforge.javadpkg.plugin.io

Interface FileSystemNodeVisitor<A>

Type Parameters:

A - The type of the attachment.

All Known Implementing Classes:

DataFileSystemNodeVisitor

public interface FileSystemNodeVisitor<A>

A visitor of file system nodes.

Version:

1.0, 10.05.2016 by Gerrit Hohl

Author:

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

Method Summary

Modifier and Type	Method and Description
FileSystemNodeVisitResult	postVisitDirectory(FileSystemNode<A> node) Invoked for a directory node after children in the directory node, and all of their descendants, have been visited.
FileSystemNodeVisitResult	preVisitDirectory(FileSystemNode<A> node) Invoked for a directory node before children of the directory node are visited.
FileSystemNodeVisitResult	visitFile(FileSystemNode<A> node) Invoked for a file node in a directory node.

Method Detail

preVisitDirectory

FileSystemNodeVisitResult preVisitDirectory(FileSystemNode<A> node)
                                     throws IOException

Invoked for a directory node before children of the directory node are visited.

If this method returns FileSystemNodeVisitResult.CONTINUE, then children of the directory node are visited. If this method returns FileSystemNodeVisitResult.SKIP_SUBTREE or FileSystemNodeVisitResult.SKIP_SIBLINGS then children of the directory node (and any descendants) will not be visited.

Parameters:

node - The directory node.

Returns:

The visit result.

Throws:

IllegalArgumentException - If the directory node is null.

IOException - If an I/O error occurs.

visitFile

FileSystemNodeVisitResult visitFile(FileSystemNode<A> node)
                             throws IOException

Invoked for a file node in a directory node.

Parameters:

node - The file node.

Returns:

The visit result.

Throws:

IllegalArgumentException - If the file node is null.

IOException - If an I/O error occurs.

postVisitDirectory

FileSystemNodeVisitResult postVisitDirectory(FileSystemNode<A> node)
                                      throws IOException

Invoked for a directory node after children in the directory node, and all of their descendants, have been visited. This method is also invoked when iteration of the directory completes prematurely (by a visitFile(FileSystemNode) method returning FileSystemNodeVisitResult.SKIP_SIBLINGS directory).

Parameters:

node - The directory node.

Returns:

The visit result.

Throws:

IllegalArgumentException - If the directory node is null.

IOException - If an I/O error occurs.