com.gpudb.filesystem.common

Class LocalFileFinder

java.lang.Object

java.nio.file.SimpleFileVisitor<Path>

com.gpudb.filesystem.common.LocalFileFinder

All Implemented Interfaces:

FileVisitor<Path>

public class LocalFileFinder
extends SimpleFileVisitor<Path>

This is an internal class and not meant to be used by the end users of the filesystem API. The consequences of using this class directly in client code is not guaranteed and maybe undesirable. This class handles the file searching operations on the local filesystem. It handles standard glob patterns like "**", "*", "?" etc. and can do the recursive searches on file patterns along the directory hierarchy starting from a particular directory. This class extends the Java class SimpleFileVisitor and overrides the file and the directory visit methods. It is essentially an implementation of the visitor pattern.

Method Summary

Modifier and Type	Method and Description
List<String>	getMatchingFileNames()
int	getNumMatches()
List<String>	getRemoteFileNames()
FileVisitResult	preVisitDirectory(Path dir, BasicFileAttributes attrs) This method is automatically called as a directory is found.
FileVisitResult	visitFile(Path file, BasicFileAttributes attrs) This method is automatically called as a file is found.
FileVisitResult	visitFileFailed(Path file, IOException exc) This method is called in case there is an exception raised while traversing a directory tree.

Methods inherited from class java.nio.file.SimpleFileVisitor

postVisitDirectory

Methods inherited from class java.lang.Object

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

Method Detail

getMatchingFileNames

public List<String> getMatchingFileNames()

getRemoteFileNames

public List<String> getRemoteFileNames()

getNumMatches

public int getNumMatches()

visitFile

public FileVisitResult visitFile(Path file,
                                 BasicFileAttributes attrs)

This method is automatically called as a file is found. Invoke the pattern matching method on each file.

Specified by:

visitFile in interface FileVisitor<Path>

Overrides:

visitFile in class SimpleFileVisitor<Path>

Parameters:

file - - the Path representing the file.

attrs - - the attributes BasicFileAttributes of the file.

Returns:

- The FileVisitResult object used internally by the FileWalker.

preVisitDirectory

public FileVisitResult preVisitDirectory(Path dir,
                                         BasicFileAttributes attrs)

This method is automatically called as a directory is found. Invoke the pattern matching method on each directory.

Specified by:

preVisitDirectory in interface FileVisitor<Path>

Overrides:

preVisitDirectory in class SimpleFileVisitor<Path>

Parameters:

dir - - The Path object representing the directory found

attrs - - the attributes BasicFileAttributes of the directory.

Returns:

- The FileVisitResult object used internally by the FileWalker.

visitFileFailed

public FileVisitResult visitFileFailed(Path file,
                                       IOException exc)

This method is called in case there is an exception raised while traversing a directory tree.

Specified by:

visitFileFailed in interface FileVisitor<Path>

Overrides:

visitFileFailed in class SimpleFileVisitor<Path>

Parameters:

file - - the file Path object

exc - - the IOException object

Returns:

- FileVisitResult object