uk.gov.gchq.gaffer.function.context

Class PassThroughFunctionContext.Builder<R,F extends ConsumerProducerFunction>

java.lang.Object

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

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

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

Type Parameters:

R - The type of reference used to select from and project into tuples in the context.

F - The type of ConsumerProducerFunction wrapped by the context.

Enclosing class:

PassThroughFunctionContext<R,F extends ConsumerProducerFunction>

public static class PassThroughFunctionContext.Builder<R,F extends ConsumerProducerFunction>
extends ConsumerFunctionContext.Builder<R,F>

Implementation of the Builder pattern for PassThroughFunctionContext.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PassThroughFunctionContext<R,F>	build() Build the FunctionContext configured by this Builder.
PassThroughFunctionContext.Builder<R,F>	execute(F function) Sets the Function to be wrapped by the context and returns this Builder for further configuration.
PassThroughFunctionContext<R,F>	getContext() Get the FunctionContext configured by this Builder.
PassThroughFunctionContext.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.ConsumerFunctionContext.Builder

isSelected

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 PassThroughFunctionContext.

Builder

public Builder(PassThroughFunctionContext<R,F> context)

Create a Builder to configure a PassThroughFunctionContext.

Parameters:

context - PassThroughFunctionContext to be configured.

Method Detail

select

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

Description copied from class: ConsumerFunctionContext.Builder

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

Overrides:

select in class ConsumerFunctionContext.Builder<R,F extends ConsumerProducerFunction>

Parameters:

newSelection - References to select data from an input Tuple.

Returns:

This Builder.

execute

public PassThroughFunctionContext.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 ConsumerFunctionContext.Builder<R,F extends ConsumerProducerFunction>

Parameters:

function - Function to be wrapped by the context.

Returns:

This Builder.

build

public PassThroughFunctionContext<R,F> build()

Description copied from class: FunctionContext.Builder

Build the FunctionContext configured by this Builder.

Overrides:

build in class ConsumerFunctionContext.Builder<R,F extends ConsumerProducerFunction>

Returns:

Configured FunctionContext

getContext

public PassThroughFunctionContext<R,F> getContext()

Description copied from class: FunctionContext.Builder

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

Overrides:

getContext in class ConsumerFunctionContext.Builder<R,F extends ConsumerProducerFunction>

Returns:

Configured FunctionContext