Package net.officefloor.compile.impl.managedfunction

Class ManagedFunctionFlowTypeImpl<F extends java.lang.Enum<F>>

java.lang.Object

net.officefloor.compile.impl.managedfunction.ManagedFunctionFlowTypeImpl<F>

All Implemented Interfaces:

ManagedFunctionFlowType<F>, ManagedFunctionFlowTypeBuilder<F>, AnnotatedType

public class ManagedFunctionFlowTypeImpl<F extends java.lang.Enum<F>>
extends java.lang.Object
implements ManagedFunctionFlowType<F>, ManagedFunctionFlowTypeBuilder<F>

ManagedFunctionFlowType implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ManagedFunctionFlowTypeImpl(int index)	Initiate.

Method Summary

Modifier and Type	Method	Description
ManagedFunctionFlowTypeBuilder<F>	addAnnotation(java.lang.Object annotation)	Adds an annotation.
java.lang.Object[]	getAnnotations()	Obtains the annotations.
java.lang.Class<?>	getArgumentType()	Obtains the type of the argument passed by the ManagedFunction to the Flow.
java.lang.String	getFlowName()	Obtains the name for the ManagedFunctionFlowType.
int	getIndex()	Obtains the index for the ManagedFunctionFlowType.
F	getKey()	Obtains the Enum key for the ManagedFunctionFlowType.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.compile.type.AnnotatedType

getAnnotation, getAnnotations

Constructor Detail

ManagedFunctionFlowTypeImpl

public ManagedFunctionFlowTypeImpl(int index)

Initiate.

Parameters:

index - Index of this ManagedFunctionFlowType.

Method Detail

setKey

public ManagedFunctionFlowTypeBuilder<F> setKey(F key)

Description copied from interface: ManagedFunctionFlowTypeBuilder

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

Specified by:

setKey in interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

Parameters:

key - Enum for this ManagedFunctionFlowTypeBuilder.

Returns:

this.

setArgumentType

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

Description copied from interface: ManagedFunctionFlowTypeBuilder

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

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

Specified by:

setArgumentType in interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

Parameters:

argumentType - Type of argument passed to Flow.

Returns:

this.

setLabel

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

Description copied from interface: ManagedFunctionFlowTypeBuilder

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

Specified by:

setLabel in interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

Parameters:

label - Display label for the Flow.

Returns:

this.

addAnnotation

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

Description copied from interface: ManagedFunctionFlowTypeBuilder

Adds an annotation.

Specified by:

addAnnotation in interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

Parameters:

annotation - Annotation.

Returns:

this.

getFlowName

public java.lang.String getFlowName()

Description copied from interface: ManagedFunctionFlowType

Obtains the name for the ManagedFunctionFlowType.

Specified by:

getFlowName in interface ManagedFunctionFlowType<F extends java.lang.Enum<F>>

Returns:

Name for the ManagedFunctionFlowType.

getIndex

public int getIndex()

Description copied from interface: ManagedFunctionFlowType

Obtains the index for the ManagedFunctionFlowType.

Should there be an Enum then will be the Enum.ordinal() value. Otherwise will be the index that this was added.

Specified by:

getIndex in interface ManagedFunctionFlowType<F extends java.lang.Enum<F>>

Specified by:

getIndex in interface ManagedFunctionFlowTypeBuilder<F extends java.lang.Enum<F>>

Returns:

Index for the ManagedFunctionFlowType.

getArgumentType

public java.lang.Class<?> getArgumentType()

Description copied from interface: ManagedFunctionFlowType

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

Specified by:

getArgumentType in interface ManagedFunctionFlowType<F extends java.lang.Enum<F>>

Returns:

Type of argument passed to Flow. May be null to indicate no argument.

getKey

public F getKey()

Description copied from interface: ManagedFunctionFlowType

Obtains the Enum key for the ManagedFunctionFlowType.

Specified by:

getKey in interface ManagedFunctionFlowType<F extends java.lang.Enum<F>>

Returns:

Enum key for the ManagedFunctionFlowType. May be null if no Enum for flows.

getAnnotations

public java.lang.Object[] getAnnotations()

Description copied from interface: AnnotatedType

Obtains the annotations.

Specified by:

getAnnotations in interface AnnotatedType

Returns:

Annotations.