uk.gov.gchq.gaffer.function.context

Class FunctionContext.Builder<F extends Function>

java.lang.Object

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

Type Parameters:

F - The type of Function wrapped by the context.

Direct Known Subclasses:

ConsumerFunctionContext.Builder, ProducerFunctionContext.Builder

Enclosing class:

FunctionContext<F extends Function>

public abstract static class FunctionContext.Builder<F extends Function>
extends Object

Implementation of the Builder pattern for FunctionContext.

Constructor Summary

Constructors

Constructor and Description
Builder(FunctionContext<F> context) Create a Builder to configure a FunctionContext.

Method Summary

Modifier and Type	Method and Description
FunctionContext<F>	build() Build the FunctionContext configured by this Builder.
FunctionContext.Builder<F>	execute(F function) Sets the Function to be wrapped by the context and returns this Builder for further configuration.
FunctionContext<F>	getContext() Get the FunctionContext configured by this Builder.
boolean	isExecuted() Tests whether the Function to be wrapped has been configured.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(FunctionContext<F> context)

Create a Builder to configure a FunctionContext.

Parameters:

context - FunctionContext to be configured.

Method Detail

execute

public FunctionContext.Builder<F> execute(F function)

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

Parameters:

function - Function to be wrapped by the context.

Returns:

This Builder.

isExecuted

public boolean isExecuted()

Tests whether the Function to be wrapped has been configured.

Returns:

False until aggregate(F) is called, then true.

build

public FunctionContext<F> build()

Build the FunctionContext configured by this Builder.

Returns:

Configured FunctionContext

getContext

public FunctionContext<F> getContext()

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

Returns:

Configured FunctionContext