de.vandermeer.skb.base.info

Class SimpleDirectoryScanner

Object

AbstractLoader

SimpleDirectoryScanner

All Implemented Interfaces:

DirectoryLoader, InfoLoader

public class SimpleDirectoryScanner
extends AbstractLoader
implements DirectoryLoader

Scans a directory and returns a complete list of files found.

Since:

v0.0.6

Version:

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

Author:

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

Constructor Summary

Constructors

Constructor and Description
SimpleDirectoryScanner(DirectorySource source) Returns a new directory scanner for a given source.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears errors and warnings, automatically called for new scans.
protected List<FileSource>	doScan(File fDir) Does the actual scan of a directory.
protected List<FileSource>	getFiles() Returns a set of files found in the given directory.
DirectorySource	getSource() Returns the source set for the loader, that is where the loader loads information from.
List<String>	lastInfos() Returns collected information from a scan.
List<String>	lastWarnings() Returns collected warnings from a scan.
FileSourceList	load() Loads information from a source and returns a specific object.
String	toString()

Methods inherited from class AbstractLoader

getLoadErrors

Methods inherited from class Object

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

Methods inherited from interface InfoLoader

getLoadErrors, validateSource

Constructor Detail

SimpleDirectoryScanner

public SimpleDirectoryScanner(DirectorySource source)

Returns a new directory scanner for a given source.

Parameters:

source - the source for the scanner

Method Detail

clear

public void clear()

Clears errors and warnings, automatically called for new scans.

getFiles

protected List<FileSource> getFiles()

Returns a set of files found in the given directory. A scan will go recursively through all readable sub directories and collect all readable files. Hidden files and directories will be ignored (not scanned, found or counted)

Returns:

a set of readable files found in the directory, empty set of none found, errors and warnings are collected per scan

doScan

protected List<FileSource> doScan(File fDir)

Does the actual scan of a directory.

Parameters:

fDir - starting directory

Returns:

set of found and readable files, empty set of none found

lastWarnings

public List<String> lastWarnings()

Returns collected warnings from a scan.

Returns:

a list with warnings, empty list of none occurred

lastInfos

public List<String> lastInfos()

Returns collected information from a scan.

Returns:

a list with information, empty list of none occurred

toString

public String toString()

Overrides:

toString in class Object

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

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