de.vandermeer.skb.base.info

Class StringFileWriter

Object

AbstractWriter

StringFileWriter

All Implemented Interfaces:

InfoWriter

public class StringFileWriter
extends AbstractWriter

An file information writer writing strings into a file.

Since:

v0.0.9

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
StringFileWriter(FileTarget target) Returns a new writer for a file target.
StringFileWriter(String fileName) Returns a new writer for a file name, creating a file target automatically.

Method Summary

Modifier and Type	Method and Description
FileTarget	getTarget() Returns the target set for the writer, that is where the writer writes information to.
boolean	write(Object content) Writes information to a target and returns a specific object.

Methods inherited from class AbstractWriter

getWriteErrors

Methods inherited from class Object

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

Methods inherited from interface InfoWriter

validateTarget

Constructor Detail

StringFileWriter

public StringFileWriter(FileTarget target)

Returns a new writer for a file target.

Parameters:

target - the file target to be used

StringFileWriter

public StringFileWriter(String fileName)

Returns a new writer for a file name, creating a file target automatically.

Parameters:

fileName - a file name with all path elements (if required). The file name cannot be located (see FileTarget.FileTarget(String) the writer is not valid.

Method Detail

write

public boolean write(Object content)

Description copied from interface: InfoWriter

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

Parameters:

content - the content to be written

Returns:

true on success, false on error

getTarget

public FileTarget getTarget()

Description copied from interface: InfoWriter

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

Returns:

target set for the writer