Package net.officefloor.plugin.section.clazz

Class SectionInterfaceAnnotation

java.lang.Object

net.officefloor.plugin.section.clazz.SectionInterfaceAnnotation

public class SectionInterfaceAnnotation
extends java.lang.Object

SectionInterface annotation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
SectionInterfaceAnnotation(java.lang.String flowName, int flowIndex, boolean isSpawn, java.lang.Class<?> parameterType, boolean isFlowCallback, java.lang.String sectionName, java.lang.Class<? extends SectionSource> source, java.lang.String location, PropertyValueAnnotation[] properties, FlowLinkAnnotation[] outputs)	Instantiate.
SectionInterfaceAnnotation(java.lang.String flowName, int flowIndex, boolean isSpawn, java.lang.Class<?> parameterType, boolean isFlowCallback, java.lang.String sectionName, SectionInterface section)	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.String	getLocation()	Obtains the location of the section.
FlowLinkAnnotation[]	getOutputs()	Obtains the FlowLink instances for the SectionOutput instances.
java.lang.Class<?>	getParameterType()	Obtains the parameter type.
PropertyValueAnnotation[]	getProperties()	Obtains the PropertyValue instances for the section.
java.lang.String	getSectionName()	Obtains the name of the section.
java.lang.Class<? extends SectionSource>	getSource()	Obtains the SectionSource class for this section.
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

SectionInterfaceAnnotation

public SectionInterfaceAnnotation(java.lang.String flowName,
                                  int flowIndex,
                                  boolean isSpawn,
                                  java.lang.Class<?> parameterType,
                                  boolean isFlowCallback,
                                  java.lang.String sectionName,
                                  java.lang.Class<? extends SectionSource> source,
                                  java.lang.String location,
                                  PropertyValueAnnotation[] properties,
                                  FlowLinkAnnotation[] outputs)

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.

sectionName - Name of the section.

source - SectionSource class for this section.

location - Location of the section.

properties - PropertyValue instances for the section.

outputs - FlowLink instances for the SectionOutput instances.

SectionInterfaceAnnotation

public SectionInterfaceAnnotation(java.lang.String flowName,
                                  int flowIndex,
                                  boolean isSpawn,
                                  java.lang.Class<?> parameterType,
                                  boolean isFlowCallback,
                                  java.lang.String sectionName,
                                  SectionInterface section)

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.

sectionName - Name of the section.

section - SectionInterface.

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.

getSectionName

public java.lang.String getSectionName()

Obtains the name of the section.

Returns:

Name of the section.

getSource

public java.lang.Class<? extends SectionSource> getSource()

Obtains the SectionSource class for this section.

Returns:

SectionSource class.

getLocation

public java.lang.String getLocation()

Obtains the location of the section.

Returns:

Location of the section.

getProperties

public PropertyValueAnnotation[] getProperties()

Obtains the PropertyValue instances for the section.

Returns:

PropertyValue instances for the section.

getOutputs

public FlowLinkAnnotation[] getOutputs()

Obtains the FlowLink instances for the SectionOutput instances.

Returns:

FlowLink instances for the SectionOutput instances.