uk.gov.gchq.gaffer.function.context

Class ProducerFunctionContext.Builder<R,F extends ProducerFunction>

java.lang.Object

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

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

Type Parameters:

R - The type of reference used to project data into output tuples in the context.

F - The type of ProducerFunction wrapped by the context.

Enclosing class:

ProducerFunctionContext<R,F extends ProducerFunction>

public static class ProducerFunctionContext.Builder<R,F extends ProducerFunction>
extends FunctionContext.Builder<F>

Implementation of the Builder pattern for ProducerFunctionContext.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ProducerFunctionContext<R,F>	build() Build the FunctionContext configured by this Builder.
ProducerFunctionContext.Builder<R,F>	execute(F function) Sets the Function to be wrapped by the context and returns this Builder for further configuration.
ProducerFunctionContext<R,F>	getContext() Get the FunctionContext configured by this Builder.
boolean	isProjected() Tests whether the projection references have been configured.
ProducerFunctionContext.Builder<R,F>	project(R... newProjection) Sets the references to be used by the ProducerFunctionContext to project output 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 ProducerFunctionContext.

Builder

public Builder(ProducerFunctionContext<R,F> context)

Create a Builder to configure a ProducerFunctionContext.

Parameters:

context - ProducerFunctionContext to be configured.

Method Detail

execute

public ProducerFunctionContext.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 ProducerFunction>

Parameters:

function - Function to be wrapped by the context.

Returns:

This Builder.

project

public ProducerFunctionContext.Builder<R,F> project(R... newProjection)

Sets the references to be used by the ProducerFunctionContext to project output data and returns this Builder for further configuration.

Parameters:

newProjection - References to project data into an output Tuple.

Returns:

This Builder.

isProjected

public boolean isProjected()

Tests whether the projection references have been configured.

Returns:

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

build

public ProducerFunctionContext<R,F> build()

Description copied from class: FunctionContext.Builder

Build the FunctionContext configured by this Builder.

Overrides:

build in class FunctionContext.Builder<F extends ProducerFunction>

Returns:

Configured FunctionContext

getContext

public ProducerFunctionContext<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 ProducerFunction>

Returns:

Configured FunctionContext