de.vandermeer.skb.base.info

Interface InfoTarget

All Known Implementing Classes:

AbstractTarget, FileTarget

public interface InfoTarget

An information target.

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 target for messages.
IsErrorSetFT	getInitError() Returns any error that happened during initialization (and relate validation) of the target.
Object	getTarget() Returns the actual target.
default boolean	isValid() Returns the valid flag of the target.

Method Detail

getTarget

Object getTarget()

Returns the actual target. For instance, if the target 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 target

asString

String asString()

Returns a string representation of the target for messages. This representation should be configurable, for instance for a file target 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 target

getInitError

IsErrorSetFT getInitError()

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

Returns:

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

isValid

default boolean isValid()

Returns the valid flag of the target.

Returns:

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