Package net.officefloor.compile.spi.managedfunction.source

Interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

All Known Implementing Classes:

ManagedFunctionFlowTypeImpl

public interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

Provides means for the ManagedFunctionSource to provide a type definition of a possible Flow instigated by the ManagedFunction.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
ManagedFunctionFlowTypeBuilder<F>	addAnnotation(java.lang.Object annotation)	Adds an annotation.
int	getIndex()	Obtains the index of the Flow.
ManagedFunctionFlowTypeBuilder<F>	setArgumentType(java.lang.Class<?> argumentType)	Specifies the type of the argument passed by the ManagedFunction to the Flow.
ManagedFunctionFlowTypeBuilder<F>	setKey(F key)	Specifies the Enum for this ManagedFunctionFlowTypeBuilder.
ManagedFunctionFlowTypeBuilder<F>	setLabel(java.lang.String label)	Provides means to specify a display label for the Flow.

Method Detail

getIndex

int getIndex()

Obtains the index of the Flow.

Returns:

Index of the Flow.

setKey

ManagedFunctionFlowTypeBuilder<F> setKey(F key)

Specifies the Enum for this ManagedFunctionFlowTypeBuilder. This is required to be set if F is not None or Indexed.

Parameters:

key - Enum for this ManagedFunctionFlowTypeBuilder.

Returns:

this.

setArgumentType

ManagedFunctionFlowTypeBuilder<F> setArgumentType(java.lang.Class<?> argumentType)

Specifies the type of the argument passed by the ManagedFunction to the Flow.

Should there be no argument, do not call this method.

Parameters:

argumentType - Type of argument passed to Flow.

Returns:

this.

setLabel

ManagedFunctionFlowTypeBuilder<F> setLabel(java.lang.String label)

Provides means to specify a display label for the Flow.

This need not be set as is only an aid to better identify the Flow. If not set the ManagedFunctionTypeBuilder will use the following order to get a display label:

1. Enum key name
2. index value

Parameters:

label - Display label for the Flow.

Returns:

this.

addAnnotation

ManagedFunctionFlowTypeBuilder<F> addAnnotation(java.lang.Object annotation)

Adds an annotation.

Parameters:

annotation - Annotation.

Returns:

this.