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

Interface ManagedFunctionObjectTypeBuilder<M extends Enum<M>>

All Known Implementing Classes:

ManagedFunctionObjectTypeImpl

public interface ManagedFunctionObjectTypeBuilder<M extends Enum<M>>

Provides means for the ManagedFunctionSource to provide a type definition of a dependency Object required by the ManagedFunction.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
ManagedFunctionObjectTypeBuilder<M>	addAnnotation(Object annotation)	Adds an annotation.
int	getIndex()	Obtains the index of the dependency.
ManagedFunctionObjectTypeBuilder<M>	setKey(M key)	Specifies the Enum for this ManagedFunctionObjectTypeBuilder.
ManagedFunctionObjectTypeBuilder<M>	setLabel(String label)	Provides means to specify a display label for the Object.
ManagedFunctionObjectTypeBuilder<M>	setTypeQualifier(String qualifier)	Specifies the type qualifier.

Method Details

getIndex

int getIndex()

Obtains the index of the dependency.

Returns:

Index of the dependency.

setKey

ManagedFunctionObjectTypeBuilder<M> setKey(M key)

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

Parameters:

key - Enum for this ManagedFunctionObjectTypeBuilder.

Returns:

this.

setTypeQualifier

ManagedFunctionObjectTypeBuilder<M> setTypeQualifier(String qualifier)

Specifies the type qualifier.

Parameters:

qualifier - Type qualifier.

Returns:

this.

setLabel

ManagedFunctionObjectTypeBuilder<M> setLabel(String label)

Provides means to specify a display label for the Object.

This need not be set as is only an aid to better identify the Object. 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 Object.

Returns:

this.

addAnnotation

ManagedFunctionObjectTypeBuilder<M> addAnnotation(Object annotation)

Adds an annotation.

Parameters:

annotation - Annotation.

Returns:

this.