Package org.apache.turbine.pipeline

Interface PipelineData

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

RunData, TurbineRunData

All Known Implementing Classes:

DefaultPipelineData, DefaultTurbineRunData

public interface PipelineData
extends AutoCloseable

A PipelineData is a holder for data being passed from one Valve to the next. The detailed contract for a Valve is included in the description of the invoke() method below.

HISTORICAL NOTE: The "PipelineData" name was assigned to this holder as it functions similarly to the RunData object, but without the additional methods

Author:

Eric Pugh, Peter Courcoux

Method Summary

Modifier and Type	Method	Description
Map<Class<?>,? super Object>	get(Class<?> name)	Get the configured map of objects for the given key
<T> T	get(Class<?> key, Class<T> innerKey)	Get a value from the configured map of objects for the given keys
default RunData	getRunData()	Get RunData from PipelineData
void	put(Class<?> name, Map<Class<?>,? super Object> value)	Put a configured map of objects into the pipeline data object

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

put

void put(Class<?> name,
         Map<Class<?>,? super Object> value)

Put a configured map of objects into the pipeline data object

Parameters:

name - the key class

value - the value map

get

Map<Class<?>,? super Object> get(Class<?> name)

Get the configured map of objects for the given key

Parameters:

name - the key class

Returns:

the value map or null if no such key exists

get

<T> T get(Class<?> key,
          Class<T> innerKey)

Get a value from the configured map of objects for the given keys

Type Parameters:

T - the type of the inner key

Parameters:

key - the key class

innerKey - the key into the value map

Returns:

the inner value or null if no such keys exist

getRunData

default RunData getRunData()

Get RunData from PipelineData

Returns:

RunData extracted from PipelineData