org.geomajas.service.pipeline

Interface PipelineContext

@Api(allMethods=true)
public interface PipelineContext

Context which is provided to a pipeline context to help execute.

Since:

1.6.0

Author:

Joachim Van der Auwera

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(String key) Returns true if the context contains the specified key.
Object	get(String key) Get the value for a key.
<TYPE> TYPE	get(String key, Class<TYPE> type) Get the value for a key.
Object	getOptional(String key) Get the value for a key.
<TYPE> TYPE	getOptional(String key, Class<TYPE> type) Get the value for a key.
<TYPE> TYPE	getOptional(String key, Class<TYPE> type, TYPE defaultValue) Get the value for a key.
boolean	isFinished() Has the pipeline finished execution? Has a pipeline step indicated that the pipeline should finish executing?
Object	put(String key, Object value) Put context value which may be accessed by later pipeline steps.
void	setFinished(boolean finished) By setting this to true, you can indicate that following steps in the pipeline should not be executed.

Method Detail

containsKey

boolean containsKey(String key)

Returns true if the context contains the specified key.

Parameters:

key - key which needs to be checked.

Returns:

true if the context contains the key, false otherwise

Since:

1.9.0

get

Object get(String key)
           throws GeomajasException

Get the value for a key.

These values can be used to pass values between the pipeline steps.

Parameters:

key - key for which the value needs to be obtained.

Returns:

value for key

Throws:

GeomajasException - no value found for key

getOptional

Object getOptional(String key)

Get the value for a key.

These values can be used to pass values between the pipeline steps.

Parameters:

key - key for which the value needs to be obtained.

Returns:

value for key or null

get

<TYPE> TYPE get(String key,
              Class<TYPE> type)
         throws GeomajasException

Get the value for a key.

These values can be used to pass values between the pipeline steps.

Type Parameters:

TYPE - type for the object which needs to be get

Parameters:

key - key for which the value needs to be obtained.

type - class which needs to be used for the parameter

Returns:

value for key

Throws:

GeomajasException - no value of correct type found for key

getOptional

<TYPE> TYPE getOptional(String key,
                      Class<TYPE> type)

Get the value for a key.

These values can be used to pass values between the pipeline steps.

Type Parameters:

TYPE - type for the object which needs to be get

Parameters:

key - key for which the value needs to be obtained.

type - class which needs to be used for the parameter

Returns:

value for key or null

getOptional

<TYPE> TYPE getOptional(String key,
                      Class<TYPE> type,
                      TYPE defaultValue)

Get the value for a key.

These values can be used to pass values between the pipeline steps.

Type Parameters:

TYPE - type for the object which needs to be get

Parameters:

key - key for which the value needs to be obtained.

type - class which needs to be used for the parameter

defaultValue - default value to be returned in case the value is missing

Returns:

value for key or null

Since:

1.10.0

put

Object put(String key,
         Object value)

Put context value which may be accessed by later pipeline steps.

The put needs to be ignored if the key is null.

Parameters:

key - key for value

value - value for key

Returns:

previous value stored for this key

isFinished

boolean isFinished()

Has the pipeline finished execution?

Has a pipeline step indicated that the pipeline should finish executing?

Returns:

true when pipeline should finish

setFinished

void setFinished(boolean finished)

By setting this to true, you can indicate that following steps in the pipeline should not be executed.

Parameters:

finished - indicates whether the pipeline should stop