stream.io

Class LineWriter

java.lang.Object

stream.AbstractProcessor

stream.io.LineWriter

All Implemented Interfaces:

Processor, StatefulProcessor

public class LineWriter
extends AbstractProcessor

A simple output processor that writes out data items to a file according to some format string.

Author:

Christian Bockermann <chris@jwall.org>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	append
(package private) boolean	escapeNewlines
(package private) File	file
(package private) String	format
(package private) PrintStream	out

Fields inherited from class stream.AbstractProcessor

context

Constructor Summary

Constructors

Constructor and Description
LineWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	finish()
File	getFile()
String	getFormat()
void	init(ProcessContext ctx)
boolean	isAppend()
boolean	isEscapeNewlines()
Data	process(Data input)
void	setAppend(boolean append)
void	setEscapeNewlines(boolean escapeNewlines)
void	setFile(File file)
void	setFormat(String format)

Methods inherited from class stream.AbstractProcessor

resetState

Methods inherited from class java.lang.Object

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

Field Detail

file

File file

append

boolean append

out

PrintStream out

format

String format

escapeNewlines

boolean escapeNewlines

Constructor Detail

LineWriter

public LineWriter()

Method Detail

getFile

public File getFile()

Returns:

the file

setFile

@Parameter(required=true,
           description="Name of the file to write to.")
public void setFile(File file)

Parameters:

file - the file to set

getFormat

public String getFormat()

Returns:

the format

setFormat

@Parameter(required=true,
           description="The format string, containing macros that are expanded for each item")
public void setFormat(String format)

Parameters:

format - the format to set

isAppend

public boolean isAppend()

Returns:

the append

setAppend

@Parameter(required=false,
           description="Denotes whether to append to existing files or create a new file at container startup.",
           defaultValue="false")
public void setAppend(boolean append)

Parameters:

append - the append to set

isEscapeNewlines

public boolean isEscapeNewlines()

Returns:

the escapeNewlines

setEscapeNewlines

@Parameter(required=false,
           description="Whether to escape newlines contained in the attributes or not.")
public void setEscapeNewlines(boolean escapeNewlines)

Parameters:

escapeNewlines - the escapeNewlines to set

init

public void init(ProcessContext ctx)
          throws Exception

Specified by:

init in interface StatefulProcessor

Overrides:

init in class AbstractProcessor

Throws:

Exception

See Also:

AbstractProcessor.init(stream.ProcessContext)

process

public Data process(Data input)

See Also:

Processor.process(stream.Data)

finish

public void finish()
            throws Exception

Specified by:

finish in interface StatefulProcessor

Overrides:

finish in class AbstractProcessor

Throws:

Exception

See Also:

AbstractProcessor.finish()