de.vandermeer.skb.base.info

Class DirectorySource

Object

AbstractDirectoryInfo

DirectorySource

All Implemented Interfaces:

InfoSource

public class DirectorySource
extends AbstractDirectoryInfo
implements InfoSource

A source object for a directory.

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 AbstractDirectoryInfo

AbstractDirectoryInfo.Options

Field Summary

Fields

Modifier and Type	Field and Description
static FileFilter	DIRECTORIES_ONLY A simple filter for directories.

Fields inherited from class AbstractDirectoryInfo

asStringOpt, errors, file, url

Constructor Summary

Constructors

Constructor and Description
DirectorySource(String directory) Creates a new directory source object from a directory name.
DirectorySource(String directory, InfoLocationOptions option) Creates a new directory source object from a directory name with options.

Method Summary

Modifier and Type	Method and Description
String	asString() Returns a string representation of the source for messages.
IsErrorSetFT	getInitError() Returns any error that happened during initialization (and relate validation) of the source.
Object	getSource() Returns the actual source.
protected ValidationOptions	valOption() Returns the validation option which makes this abstract implementation a info object or target or both.

Methods inherited from class AbstractDirectoryInfo

asFile, asURL, getFullDirecoryName, getSetRootPath, init, isValid, reset, setAsStringOption, testDirectory, tryCP, tryFS

Methods inherited from class Object

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

Methods inherited from interface InfoSource

isValid

Field Detail

DIRECTORIES_ONLY

public static final FileFilter DIRECTORIES_ONLY

A simple filter for directories.

Constructor Detail

DirectorySource

public DirectorySource(String directory)

Creates a new directory source object from a directory name. This constructor will try to locate the directory as resource first and in the file system next.

Parameters:

directory - name of the directory. Path information can be relative to any path in the class path.

DirectorySource

public DirectorySource(String directory,
                       InfoLocationOptions option)

Creates a new directory source object from a directory name with options.

Parameters:

directory - name of the directory. Path information can be relative to any path in the class path.

option - an option on how to locate the directory

Method Detail

getSource

public Object getSource()

Description copied from interface: InfoSource

Returns the actual source. For instance, if the source is a path in the file system this method returns the path. The result of this method can (will) be used as key in maps.

Specified by:

getSource in interface InfoSource

Returns:

object representation of the source

getInitError

public IsErrorSetFT getInitError()

Description copied from interface: InfoSource

Returns any error that happened during initialization (and relate validation) of the source.

Specified by:

getInitError in interface InfoSource

Returns:

a null string if the source is initialized successfully (and thus valid), a string with an error message otherwise

valOption

protected ValidationOptions valOption()

Description copied from class: AbstractDirectoryInfo

Returns the validation option which makes this abstract implementation a info object or target or both.

Specified by:

valOption in class AbstractDirectoryInfo

Returns:

validation option, if not set (null) will create init errors

asString

public String asString()

Description copied from interface: InfoSource

Returns a string representation of the source for messages. This representation should be configurable, for instance for a file source it might return the root directory or a set-root directory or the file base name or the file extension, depending on configuration.

Specified by:

asString in interface InfoSource

Returns:

string representation of the source