org.rvpf.base.pipe

Class PipeEngineRequest

Object

PipeRequest

PipeEngineRequest

@ThreadSafe
public final class PipeEngineRequest
extends PipeRequest

Pipe engine request.

Nested Class Summary

Nested classes/interfaces inherited from class PipeRequest

PipeRequest.LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
static int	REQUEST_FORMAT_VERSION The request format version.

Fields inherited from class PipeRequest

DEBUG_LEVEL, ERROR_LEVEL, FATAL_LEVEL, INFO_LEVEL, LINE_SEPARATOR, SPACE_PATTERN, TRACE_LEVEL, WARN_LEVEL

Method Summary

Modifier and Type	Method and Description
void	addResult(PointValue result) Adds a result.
void	clearResults() Clears the results.
PointValue[]	getInputs() Gets the inputs.
String[]	getPointParams() Gets the Point params.
PointValue	getResult() Gets the result.
String[]	getTransformParams() Gets the Transform params.
static Optional<PipeEngineRequest>	nextRequest() Returns the next request.
void	respond() Responds to this request.
void	setResultState(Serializable state) Sets the state of the result.
void	setResultValue(Serializable value) Sets the value of the result.

Methods inherited from class PipeRequest

cleanString, debug, debug, error, error, fatal, fatal, firstLine, getRequestID, getVersion, info, info, log, log, nextLine, nextPointValue, parseInt, pointValueToString, stringToPointValue, trace, trace, warn, warn, writeLine, writePointValue

Methods inherited from class Object

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

Field Detail

REQUEST_FORMAT_VERSION

public static final int REQUEST_FORMAT_VERSION

The request format version.

See Also:

Constant Field Values

Method Detail

nextRequest

@Nonnull
 @CheckReturnValue
public static Optional<PipeEngineRequest> nextRequest()

Returns the next request.

Returns:

The next request (empty when done).

addResult

public void addResult(@Nonnull
                      PointValue result)

Adds a result.

Parameters:

result - The result.

clearResults

public void clearResults()

Clears the results.

getInputs

@Nonnull
 @CheckReturnValue
public PointValue[] getInputs()

Gets the inputs.

Returns:

The inputs.

getPointParams

@Nonnull
 @CheckReturnValue
public String[] getPointParams()

Gets the Point params.

Returns:

The Point params.

getResult

@Nonnull
 @CheckReturnValue
public PointValue getResult()

Gets the result.

Returns:

The result.

getTransformParams

@Nonnull
 @CheckReturnValue
public String[] getTransformParams()

Gets the Transform params.

Returns:

The Transform params.

respond

public void respond()

Responds to this request.

setResultState

public void setResultState(@Nullable
                           Serializable state)

Sets the state of the result.

Note: must not be called after clearResults().

Parameters:

state - The state of the result.

setResultValue

public void setResultValue(@Nullable
                           Serializable value)

Sets the value of the result.

Note: must not be called after clearResults().

Parameters:

value - The value of the result.