Package org.frankframework.core

Class PipeRunResult

java.lang.Object

org.frankframework.core.PipeRunResult

All Implemented Interfaces:

AutoCloseable

public class PipeRunResult
extends Object
implements AutoCloseable

The PipeRunResult is a type to store both the result of the processing of a message in doPipe() as well as the exitState.
Responsibility:

• keeper of the result of the execution of a Pipe
• keeper of the forward to be returned to the PipeLine

Pipes return a PipeRunResult with the information as above.

Author:

Johan Verrips

See Also:

• PipeForward
• IPipe.doPipe(org.frankframework.stream.Message, org.frankframework.core.PipeLineSession)
• AbstractPipe.findForward(java.lang.String)

Constructor Summary

Constructors

Constructor	Description
PipeRunResult()
PipeRunResult(PipeForward forward, Object result)
PipeRunResult(PipeForward forward, Message result)

Method Summary

Modifier and Type	Method	Description
void	close()
PipeForward	getPipeForward()
Message	getResult()
boolean	isSuccessful()
void	setPipeForward(PipeForward pipeForward)
void	setResult(Object result)
void	setResult(Message result)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PipeRunResult

public PipeRunResult()

PipeRunResult

public PipeRunResult(PipeForward forward,
 Message result)

PipeRunResult

public PipeRunResult(PipeForward forward,
 Object result)

Method Details

setResult

public void setResult(Object result)

setResult

public void setResult(Message result)

getResult

public Message getResult()

toString

public String toString()

Overrides:

toString in class Object

isSuccessful

public boolean isSuccessful()

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getPipeForward

public PipeForward getPipeForward()

setPipeForward

public void setPipeForward(PipeForward pipeForward)