org.metafacture.formatting

Class PreambleEpilogueAdder

java.lang.Object

org.metafacture.framework.helpers.DefaultSender<R>

org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.lang.String>>

org.metafacture.formatting.PreambleEpilogueAdder

All Implemented Interfaces:

org.metafacture.framework.LifeCycle, org.metafacture.framework.ObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.lang.String>>, org.metafacture.framework.ObjectReceiver<java.lang.String>, org.metafacture.framework.Receiver, org.metafacture.framework.Sender<org.metafacture.framework.ObjectReceiver<java.lang.String>>

@Description(value="Adds a String preamle and/or epilogue to the stream")
 @In(value=java.lang.String.class)
 @Out(value=java.lang.String.class)
 @FluxCommand(value="add-preamble-epilogue")
public final class PreambleEpilogueAdder
extends org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.lang.String>>

Emits a preamble string before the first string object in the stream and an epilogue string before the end of the stream.

The preamble and epilogue strings are only emitted if an object is received. If the preamble or epilogue string is empty, the respective string is not emitted.

Constructor Summary

Constructors

Constructor and Description
PreambleEpilogueAdder() Creates an instance of PreambleEpilogueAdder.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEpilogue() Gets the epilogue.
java.lang.String	getPreamble() Gets the preamble.
protected void	onCloseStream()
protected void	onResetStream()
void	process(java.lang.String obj)
void	setEpilogue(java.lang.String epilogue) Sets the epilogue string which is emitted after the last object.
void	setPreamble(java.lang.String preamble) Sets the preamble string which is emitted before the first object.

Methods inherited from class org.metafacture.framework.helpers.DefaultSender

closeStream, getReceiver, isClosed, onSetReceiver, resetStream, setReceiver

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.metafacture.framework.LifeCycle

closeStream, resetStream

Methods inherited from interface org.metafacture.framework.Sender

setReceiver

Constructor Detail

PreambleEpilogueAdder

public PreambleEpilogueAdder()

Creates an instance of PreambleEpilogueAdder.

Method Detail

setPreamble

public void setPreamble(java.lang.String preamble)

Sets the preamble string which is emitted before the first object.

The default preamble is an empty string. That means by default no preamble is emitted.

The parameter may only be changed before the first object is processed otherwise the change has no effect.

Parameters:

preamble - the preamble string

getPreamble

public java.lang.String getPreamble()

Gets the preamble.

Returns:

the preamble

setEpilogue

public void setEpilogue(java.lang.String epilogue)

Sets the epilogue string which is emitted after the last object.

The default epilogue string is an empty string. That means by default no epilogue is emitted.

The parameter may be changed at any time. Its becomes effective when a close-stream event is received.

Parameters:

epilogue - the epilogue string

getEpilogue

public java.lang.String getEpilogue()

Gets the epilogue.

Returns:

the epilogue

process

public void process(java.lang.String obj)

Specified by:

process in interface org.metafacture.framework.ObjectReceiver<java.lang.String>

Overrides:

process in class org.metafacture.framework.helpers.DefaultObjectPipe<java.lang.String,org.metafacture.framework.ObjectReceiver<java.lang.String>>

onCloseStream

protected void onCloseStream()

Overrides:

onCloseStream in class org.metafacture.framework.helpers.DefaultSender<org.metafacture.framework.ObjectReceiver<java.lang.String>>

onResetStream

protected void onResetStream()

Overrides:

onResetStream in class org.metafacture.framework.helpers.DefaultSender<org.metafacture.framework.ObjectReceiver<java.lang.String>>