de.vandermeer.skb.base.info

Class AbstractSource

Object

AbstractSource

All Implemented Interfaces:

InfoSource

Direct Known Subclasses:

FileSourceList

public class AbstractSource
extends Object
implements InfoSource

Abstract source implementation.

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>

Constructor Summary

Constructors

Constructor and Description
AbstractSource()

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.

Methods inherited from class Object

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

Methods inherited from interface InfoSource

isValid

Constructor Detail

AbstractSource

public AbstractSource()

Method Detail

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

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

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