de.vandermeer.skb.base.info

Interface InfoSource

All Known Implementing Classes:

AbstractSource, DirectorySource, DirectoryTarget, FileSource, FileSourceList, StgFileSource

public interface InfoSource

A source of information.

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>

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.
default boolean	isValid() Returns the valid flag of the source.

Method Detail

getSource

Object getSource()

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.

Returns:

object representation of the source

asString

String asString()

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.

Returns:

string representation of the source

getInitError

IsErrorSetFT getInitError()

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

Returns:

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

isValid

default boolean isValid()

Returns the valid flag of the source.

Returns:

true if the source is valid (can be used for a loader), false if not (loader should reject using the source). If the source is valid, then getInitError() must return null, otherwise it must return an error string. If the source is valid, then getSource() must return a non-null source object, otherwise it must return null.