java.lang.Object
- net.officefloor.compile.impl.managedfunction.ManagedFunctionTypeImpl<M,F>

All Implemented Interfaces:: ManagedFunctionType<M,F>, ManagedFunctionTypeBuilder<M,F>, AnnotatedType

public class ManagedFunctionTypeImpl<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
extends java.lang.Object
implements ManagedFunctionType<M,F>, ManagedFunctionTypeBuilder<M,F>

ManagedFunctionType implementation.

Author:: Daniel Sagenschneider

Constructor Summary

Constructors
Constructor	Description
`ManagedFunctionTypeImpl(java.lang.String functionName, java.lang.Class<M> objectKeyClass, java.lang.Class<F> flowKeyClass)`	Initiate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ManagedFunctionTypeBuilder<M,F>`	`addAnnotation(java.lang.Object annotation)`	Adds an annotation.
`<E extends java.lang.Throwable> ManagedFunctionEscalationTypeBuilder`	`addEscalation(java.lang.Class<E> escalationType)`	Adds a `ManagedFunctionEscalationTypeBuilder` to the `ManagedFunctionTypeBuilder` definition.
`ManagedFunctionFlowTypeBuilder<F>`	`addFlow()`	Adds a `ManagedFunctionFlowTypeBuilder` to the `ManagedFunctionTypeBuilder` definition.
`ManagedFunctionObjectTypeBuilder<M>`	`addObject(java.lang.Class<?> objectType)`	Adds a `ManagedFunctionObjectTypeBuilder` to the `ManagedFunctionTypeBuilder` definition.
`java.lang.Object[]`	`getAnnotations()`	Obtains the annotations.
`ManagedFunctionEscalationType[]`	`getEscalationTypes()`	Obtains the `ManagedFunctionEscalationType` definitions for the possible `EscalationFlow` instances by the `ManagedFunction`.
`java.lang.Class<F>`	`getFlowKeyClass()`	Obtains the `Enum` providing the keys for the `Flow` instances instigated by the `ManagedFunction`.
`ManagedFunctionFlowType<F>[]`	`getFlowTypes()`	Obtains the `ManagedFunctionFlowType` definitions for the possible `Flow` instances instigated by the `ManagedFunction`.
`java.lang.String`	`getFunctionName()`	Obtains the name of the `ManagedFunction`.
`ManagedFunctionFactory<M,F>`	`getManagedFunctionFactory()`	Obtains the `ManagedFunctionFactory`.
`java.lang.Class<M>`	`getObjectKeyClass()`	Obtains the `Enum` providing the keys for the dependent `Object` instances.
`ManagedFunctionObjectType<M>[]`	`getObjectTypes()`	Obtains the `ManagedFunctionObjectType` definitions for the dependent `Object` instances required by the `ManagedFunction`.
`java.lang.Class<?>`	`getReturnType()`	Obtains the type name of `Object` returned from the `ManagedFunction` that is to be used as the argument to the next `ManagedFunction`.
`ManagedFunctionTypeBuilder<M,F>`	`setFunctionFactory(ManagedFunctionFactory<M,F> functionFactory)`	Specifies the `ManagedFunctionFactory` to create the `ManagedFunction`.
`ManagedFunctionTypeBuilder<M,F>`	`setReturnType(java.lang.Class<?> returnType)`	Specifies the type of `Object` returned from the `ManagedFunction` that is to be used as the argument to the next `ManagedFunction`.

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
  - ManagedFunctionTypeImpl
```
public ManagedFunctionTypeImpl(java.lang.String functionName,
                               java.lang.Class<M> objectKeyClass,
                               java.lang.Class<F> flowKeyClass)
```
    Initiate.
    
    Parameters:
    
    functionName - Name of the ManagedFunction.
    
    objectKeyClass - Enum providing keys for dependent Object instances.
    
    flowKeyClass - Enum providing keys for instigated Flow instances.
- Method Detail
  - setFunctionFactory
```
public ManagedFunctionTypeBuilder<M,F> setFunctionFactory(ManagedFunctionFactory<M,F> functionFactory)
```
    Description copied from interface: ManagedFunctionTypeBuilder
    
    Specifies the ManagedFunctionFactory to create the ManagedFunction.
    
    Specified by:
    
    setFunctionFactory in interface ManagedFunctionTypeBuilder<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Parameters:
    
    functionFactory - ManagedFunctionFactory to create the ManagedFunction.
    
    Returns:
    
    this.
  - addAnnotation
```
public ManagedFunctionTypeBuilder<M,F> addAnnotation(java.lang.Object annotation)
```
    Description copied from interface: ManagedFunctionTypeBuilder
    
    Adds an annotation.
    
    Specified by:
    
    addAnnotation in interface ManagedFunctionTypeBuilder<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Parameters:
    
    annotation - Annotation.
    
    Returns:
    
    this.
  - setReturnType
```
public ManagedFunctionTypeBuilder<M,F> setReturnType(java.lang.Class<?> returnType)
```
    Description copied from interface: ManagedFunctionTypeBuilder
    
    Specifies the type of Object returned from the ManagedFunction that is to be used as the argument to the next ManagedFunction.
    
    Specified by:
    
    setReturnType in interface ManagedFunctionTypeBuilder<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Parameters:
    
    returnType - Return type of the ManagedFunction.
    
    Returns:
    
    this.
  - addObject
```
public ManagedFunctionObjectTypeBuilder<M> addObject(java.lang.Class<?> objectType)
```
    Description copied from interface: ManagedFunctionTypeBuilder
    
    Adds a ManagedFunctionObjectTypeBuilder to the ManagedFunctionTypeBuilder definition.
    Should the dependent Object instances be Indexed, the order they are added is the order of indexing (starting at 0).
    
    Specified by:
    
    addObject in interface ManagedFunctionTypeBuilder<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Parameters:
    
    objectType - Type of the dependent Object.
    
    Returns:
    
    ManagedFunctionObjectTypeBuilder to provide the type definition of the added dependent Object.
  - addFlow
```
public ManagedFunctionFlowTypeBuilder<F> addFlow()
```
    Description copied from interface: ManagedFunctionTypeBuilder
    
    Adds a ManagedFunctionFlowTypeBuilder to the ManagedFunctionTypeBuilder definition.
    Should the Flow instigation be Indexed, the order they are added is the order of indexing (starting at 0).
    
    Specified by:
    
    addFlow in interface ManagedFunctionTypeBuilder<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedFunctionFlowTypeBuilder to provide the type definition of the possible instigated Flow by the ManagedFunction.
  - addEscalation
```
public <E extends java.lang.Throwable> ManagedFunctionEscalationTypeBuilder addEscalation(java.lang.Class<E> escalationType)
```
    Description copied from interface: ManagedFunctionTypeBuilder
    
    Adds a ManagedFunctionEscalationTypeBuilder to the ManagedFunctionTypeBuilder definition.
    
    Specified by:
    
    addEscalation in interface ManagedFunctionTypeBuilder<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Type Parameters:
    
    E - Escalation type.
    
    Parameters:
    
    escalationType - Type to be handled by an EscalationFlow.
    
    Returns:
    
    ManagedFunctionEscalationTypeBuilder to provide the type definition.
  - getFunctionName
```
public java.lang.String getFunctionName()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the name of the ManagedFunction.
    
    Specified by:
    
    getFunctionName in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Name of the ManagedFunction.
  - getManagedFunctionFactory
```
public ManagedFunctionFactory<M,F> getManagedFunctionFactory()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the ManagedFunctionFactory.
    
    Specified by:
    
    getManagedFunctionFactory in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedFunctionFactory.
  - getAnnotations
```
public java.lang.Object[] getAnnotations()
```
    Description copied from interface: AnnotatedType
    
    Obtains the annotations.
    
    Specified by:
    
    getAnnotations in interface AnnotatedType
    
    Returns:
    
    Annotations.
  - getObjectKeyClass
```
public java.lang.Class<M> getObjectKeyClass()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the Enum providing the keys for the dependent Object instances.
    
    Specified by:
    
    getObjectKeyClass in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Enum providing the dependent Object keys or null if Indexed or no dependencies.
  - getObjectTypes
```
public ManagedFunctionObjectType<M>[] getObjectTypes()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the ManagedFunctionObjectType definitions for the dependent Object instances required by the ManagedFunction.
    
    Specified by:
    
    getObjectTypes in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedFunctionObjectType definitions for the dependent Object instances required by the ManagedFunction.
  - getFlowKeyClass
```
public java.lang.Class<F> getFlowKeyClass()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the Enum providing the keys for the Flow instances instigated by the ManagedFunction.
    
    Specified by:
    
    getFlowKeyClass in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Enum providing instigated Flow keys or null if Indexed or no instigated Flow instances.
  - getFlowTypes
```
public ManagedFunctionFlowType<F>[] getFlowTypes()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the ManagedFunctionFlowType definitions for the possible Flow instances instigated by the ManagedFunction.
    
    Specified by:
    
    getFlowTypes in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedFunctionFlowType definitions for the possible Flow instances instigated by the ManagedFunction.
  - getEscalationTypes
```
public ManagedFunctionEscalationType[] getEscalationTypes()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the ManagedFunctionEscalationType definitions for the possible EscalationFlow instances by the ManagedFunction.
    
    Specified by:
    
    getEscalationTypes in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    ManagedFunctionEscalationType definitions for the possible EscalationFlow instances by the ManagedFunction.
  - getReturnType
```
public java.lang.Class<?> getReturnType()
```
    Description copied from interface: ManagedFunctionType
    
    Obtains the type name of Object returned from the ManagedFunction that is to be used as the argument to the next ManagedFunction.
    
    Specified by:
    
    getReturnType in interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
    
    Returns:
    
    Return type name of the ManagedFunction.

Class ManagedFunctionTypeImpl<M extends java.lang.Enum<M>,​F extends java.lang.Enum<F>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedFunctionTypeImpl

Method Detail

setFunctionFactory

addAnnotation

setReturnType

addObject

addFlow

addEscalation

getFunctionName

getManagedFunctionFactory

getAnnotations

getObjectKeyClass

getObjectTypes

getFlowKeyClass

getFlowTypes

getEscalationTypes

getReturnType

Class ManagedFunctionTypeImpl<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>