Package net.officefloor.plugin.section.clazz

Class FlowAnnotation

java.lang.Object

net.officefloor.plugin.section.clazz.FlowAnnotation

public class FlowAnnotation
extends java.lang.Object

FlowInterface broken down annotation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
FlowAnnotation(java.lang.String flowName, int flowIndex, boolean isSpawn, java.lang.Class<?> parameterType, boolean isFlowCallback)	Instantiate.

Method Summary

Modifier and Type	Method	Description
int	getFlowIndex()	Obtains the index of the Flow to invoke for this Method.
java.lang.String	getFlowName()	Obtains the name of the Flow.
java.lang.Class<?>	getParameterType()	Obtains the parameter type.
boolean	isFlowCallback()	Indicates if FlowCallback for the Flow.
boolean	isSpawn()	Indicates whether to spawn Flow in another ThreadState.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowAnnotation

public FlowAnnotation(java.lang.String flowName,
                      int flowIndex,
                      boolean isSpawn,
                      java.lang.Class<?> parameterType,
                      boolean isFlowCallback)

Instantiate.

Parameters:

flowName - Name of the Flow.

flowIndex - Index of Flow to invoked for this Method.

isSpawn - Flags whether to spawn Flow in another ThreadState.

parameterType - Type for parameter of the Flow. Will be null if no parameter.

isFlowCallback - Flag indicating if FlowCallback for the Flow.

Method Detail

getFlowName

public java.lang.String getFlowName()

Obtains the name of the Flow.

Returns:

Name of the Flow.

getFlowIndex

public int getFlowIndex()

Obtains the index of the Flow to invoke for this Method.

Returns:

Index of the Flow to invoke for this Method.

isSpawn

public boolean isSpawn()

Indicates whether to spawn Flow in another ThreadState.

Returns:

true to spawn Flow in another ThreadState.

getParameterType

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

Obtains the parameter type.

Returns:

Type for parameter of the Flow. Will be null if no parameter.

isFlowCallback

public boolean isFlowCallback()

Indicates if FlowCallback for the Flow.

Returns:

true if FlowCallback for the Flow.