de.vandermeer.skb.base.info

Interface InfoWriter

All Known Subinterfaces:

FileWriter

All Known Implementing Classes:

AbstractWriter, StringFileWriter

public interface InfoWriter

An information writer.

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
InfoTarget	getTarget() Returns the target set for the writer, that is where the writer writes information to.
IsErrorSetFT	getWriteErrors() Returns collected errors from the last invocation of write or other methods.
default boolean	validateTarget() Validates the writers target.
boolean	write(Object content) Writes information to a target and returns a specific object.

Method Detail

getTarget

InfoTarget getTarget()

Returns the target set for the writer, that is where the writer writes information to.

Returns:

target set for the writer

write

boolean write(Object content)

Writes information to a target and returns a specific object. Errors of the writing process will be collected, use getWriteErrors() to retrieve them.

Parameters:

content - the content to be written

Returns:

true on success, false on error

Throws:

IllegalArgumentException - if the content was not of the right type, depending on the writer implementation

getWriteErrors

IsErrorSetFT getWriteErrors()

Returns collected errors from the last invocation of write or other methods.

Returns:

collected errors, should not be null but can be empty (meaning no errors).

validateTarget

default boolean validateTarget()

Validates the writers target.

Returns:

true if the source is valid (not null and getSource not null), false otherwise