de.vandermeer.skb.base.info

Class CommonsDirectoryWalker

Object

DirectoryWalker<FileSource>

CommonsDirectoryWalker

All Implemented Interfaces:

DirectoryLoader, InfoLoader

public class CommonsDirectoryWalker
extends DirectoryWalker<FileSource>
implements DirectoryLoader

Walks a directory and loads files.

Since:

v0.0.7

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Nested Class Summary

Nested classes/interfaces inherited from class DirectoryWalker

DirectoryWalker.CancelException

Constructor Summary

Constructors

Constructor and Description
CommonsDirectoryWalker(DirectorySource source, IOFileFilter dirFilter, IOFileFilter fileFilter) Returns a new loader that uses a directory walker with directory and file filters.
CommonsDirectoryWalker(String root, IOFileFilter dirFilter, IOFileFilter fileFilter) Returns a new loader that uses a directory walker with directory and file filters.

Method Summary

Modifier and Type	Method and Description
IsErrorSetFT	getLoadErrors() Returns collected errors from the last invocation of load or other methods.
DirectorySource	getSource() Returns the source set for the loader, that is where the loader loads information from.
protected void	handleFile(File file, int depth, Collection<FileSource> results)
FileSourceList	load() Loads information from a source and returns a specific object.

Methods inherited from class DirectoryWalker

checkIfCancelled, filterDirectoryContents, handleCancelled, handleDirectory, handleDirectoryEnd, handleDirectoryStart, handleEnd, handleIsCancelled, handleRestricted, handleStart, walk

Methods inherited from class Object

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

Methods inherited from interface InfoLoader

validateSource

Constructor Detail

CommonsDirectoryWalker

public CommonsDirectoryWalker(DirectorySource source,
                              IOFileFilter dirFilter,
                              IOFileFilter fileFilter)

Returns a new loader that uses a directory walker with directory and file filters.

Parameters:

source - the directory source to load from

dirFilter - directory filters the walker should use

fileFilter - file filters the walker should use

CommonsDirectoryWalker

public CommonsDirectoryWalker(String root,
                              IOFileFilter dirFilter,
                              IOFileFilter fileFilter)

Returns a new loader that uses a directory walker with directory and file filters.

Parameters:

root - the directory source to load from

dirFilter - directory filters the walker should use

fileFilter - file filters the walker should use

Method Detail

load

public FileSourceList load()

Description copied from interface: InfoLoader

Loads information from a source and returns a specific object. Errors of the loading process will be collected, use InfoLoader.getLoadErrors() to retrieve them.

Specified by:

load in interface DirectoryLoader

Specified by:

load in interface InfoLoader

Returns:

an object with the information loaded

getSource

public DirectorySource getSource()

Description copied from interface: InfoLoader

Returns the source set for the loader, that is where the loader loads information from.

Specified by:

getSource in interface DirectoryLoader

Specified by:

getSource in interface InfoLoader

Returns:

source set for the loader

getLoadErrors

public IsErrorSetFT getLoadErrors()

Description copied from interface: InfoLoader

Returns collected errors from the last invocation of load or other methods.

Specified by:

getLoadErrors in interface InfoLoader

Returns:

collected errors, should not be null but can be empty (meaning no errors).

handleFile

protected void handleFile(File file,
                          int depth,
                          Collection<FileSource> results)
                   throws IOException

Overrides:

handleFile in class DirectoryWalker<FileSource>

Throws:

IOException