teetime.stage.io

Class Printer<T>

java.lang.Object

teetime.framework.AbstractStage

teetime.framework.AbstractConsumerStage<T>

teetime.stage.io.Printer<T>

public final class Printer<T>
extends AbstractConsumerStage<T>

A filter to print objects to a configured stream

Since:

1.10

Author:

Matthias Rohr, Jan Waller, Nils Christian Ehmke

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODING_UTF8
static String	STREAM_NULL
static String	STREAM_STDERR
static String	STREAM_STDLOG
static String	STREAM_STDOUT

Fields inherited from class teetime.framework.AbstractConsumerStage

inputPort

Fields inherited from class teetime.framework.AbstractStage

logger

Constructor Summary

Constructors

Constructor and Description
Printer()

Method Summary

Modifier and Type	Method and Description
protected void	execute(T object) Contains the logic of this stage and is invoked (possibly multiple times) by the framework.
String	getEncoding()
String	getStreamName()
boolean	isAppend()
void	onStarting() Event that is triggered, if all of the following conditions hold: after passing the validation phase and after the threads are ready-to-run and just before the threads execute any stage.
void	onTerminating() Event that is triggered, if all of the following conditions hold: while executing the P&F configuration and after receiving the termination signal.
void	setAppend(boolean append)
void	setEncoding(String encoding)
void	setStreamName(String streamName)

Methods inherited from class teetime.framework.AbstractConsumerStage

createInputPort, execute, getInputPort

Methods inherited from class teetime.framework.AbstractStage

abort, addInputPortRemovedListener, addOutputPortRemovedListener, compareAndSetBeingExecuted, createInputPort, createInputPort, createInputPort, createOutputPort, createOutputPort, createOutputPort, createOutputPort, declareActive, declarePassive, executeByFramework, getCurrentState, getId, getInputPorts, getOutputPorts, getOwningThread, getTerminationStrategy, isActive, isBeingExecuted, isPaused, isProducer, isStateless, onSignal, onValidating, removeDynamicPort, removeDynamicPort, setPaused, setStateless, shouldBeTerminated, signalAlreadyReceived, terminateStage, toString, workCompleted

Methods inherited from class java.lang.Object

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

Field Detail

STREAM_STDOUT

public static final String STREAM_STDOUT

See Also:

Constant Field Values

STREAM_STDERR

public static final String STREAM_STDERR

See Also:

Constant Field Values

STREAM_STDLOG

public static final String STREAM_STDLOG

See Also:

Constant Field Values

STREAM_NULL

public static final String STREAM_NULL

See Also:

Constant Field Values

ENCODING_UTF8

public static final String ENCODING_UTF8

See Also:

Constant Field Values

Constructor Detail

Printer

public Printer()

Method Detail

execute

protected void execute(T object)

Description copied from class: AbstractConsumerStage

Contains the logic of this stage and is invoked (possibly multiple times) by the framework.

Specified by:

execute in class AbstractConsumerStage<T>

Parameters:

object - the next non-null element from the (only) input port of this stage

getStreamName

public String getStreamName()

setStreamName

public void setStreamName(String streamName)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

isAppend

public boolean isAppend()

setAppend

public void setAppend(boolean append)

onStarting

public void onStarting()

Description copied from class: AbstractStage

Event that is triggered, if all of the following conditions hold:

• after passing the validation phase and
• after the threads are ready-to-run and
• just before the threads execute any stage.

If stage developers want to override this method, they must always call the super implementation first:

 @Override
 protected void onStarting() {
        super.onStarting();
        // insert your code here
 }
 

To throw a checked exception, wrap it to an unchecked exception, e.g. to an IllegalArgumentException.IllegalArgumentException(String, Throwable). Always pass the original exception to the new unchecked exception to allow easy debugging.

Overrides:

onStarting in class AbstractStage

onTerminating

public void onTerminating()

Description copied from class: AbstractStage

Event that is triggered, if all of the following conditions hold:

• while executing the P&F configuration and
• after receiving the termination signal.

If stage developers want to override this method, they must always call the super implementation last:

 @Override
 protected void onTerminating() {
        // insert your code here
        super.onTerminating();
 }
 

To throw a checked exception, wrap it to an unchecked exception, e.g. to an IllegalArgumentException.IllegalArgumentException(String, Throwable). Always pass the original exception to the new unchecked exception to allow easy debugging.

Overrides:

onTerminating in class AbstractStage