uk.gov.gchq.gaffer.function.context

Class ConsumerFunctionContext.Builder<R,F extends ConsumerFunction>

java.lang.Object

uk.gov.gchq.gaffer.function.context.FunctionContext.Builder<F>

uk.gov.gchq.gaffer.function.context.ConsumerFunctionContext.Builder<R,F>

Type Parameters:

R - The type of reference used to select data from input tuples in the context.

F - The type of ConsumerFunction wrapped by the context.

Direct Known Subclasses:

ConsumerProducerFunctionContext.Builder, PassThroughFunctionContext.Builder

Enclosing class:

ConsumerFunctionContext<R,F extends ConsumerFunction>

public static class ConsumerFunctionContext.Builder<R,F extends ConsumerFunction>
extends FunctionContext.Builder<F>

Implementation of the Builder pattern for ConsumerFunctionContext.

Constructor Summary

Constructors

Constructor and Description
Builder() Create a Builder to configure a new ConsumerFunctionContext.
Builder(ConsumerFunctionContext<R,F> context) Create a Builder to configure a ConsumerFunctionContext.

Method Summary

Modifier and Type	Method and Description
ConsumerFunctionContext<R,F>	build() Build the FunctionContext configured by this Builder.
ConsumerFunctionContext.Builder<R,F>	execute(F function) Sets the Function to be wrapped by the context and returns this Builder for further configuration.
ConsumerFunctionContext<R,F>	getContext() Get the FunctionContext configured by this Builder.
boolean	isSelected() Tests whether the selection references have been configured.
ConsumerFunctionContext.Builder<R,F>	select(R... newSelection) Sets the references to be used by the ConsumerFunctionContext to select input data and returns this Builder for further configuration.

Methods inherited from class uk.gov.gchq.gaffer.function.context.FunctionContext.Builder

isExecuted

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create a Builder to configure a new ConsumerFunctionContext.

Builder

public Builder(ConsumerFunctionContext<R,F> context)

Create a Builder to configure a ConsumerFunctionContext.

Parameters:

context - ConsumerFunctionContext to be configured.

Method Detail

select

public ConsumerFunctionContext.Builder<R,F> select(R... newSelection)

Sets the references to be used by the ConsumerFunctionContext to select input data and returns this Builder for further configuration.

Parameters:

newSelection - References to select data from an input Tuple.

Returns:

This Builder.

execute

public ConsumerFunctionContext.Builder<R,F> execute(F function)

Description copied from class: FunctionContext.Builder

Sets the Function to be wrapped by the context and returns this Builder for further configuration.

Overrides:

execute in class FunctionContext.Builder<F extends ConsumerFunction>

Parameters:

function - Function to be wrapped by the context.

Returns:

This Builder.

isSelected

public boolean isSelected()

Tests whether the selection references have been configured.

Returns:

False until select(R...) is called, then true.

build

public ConsumerFunctionContext<R,F> build()

Description copied from class: FunctionContext.Builder

Build the FunctionContext configured by this Builder.

Overrides:

build in class FunctionContext.Builder<F extends ConsumerFunction>

Returns:

Configured FunctionContext

getContext

public ConsumerFunctionContext<R,F> getContext()

Description copied from class: FunctionContext.Builder

Get the FunctionContext configured by this Builder. Equivalent to build().

Overrides:

getContext in class FunctionContext.Builder<F extends ConsumerFunction>

Returns:

Configured FunctionContext