Package net.officefloor.plugin.managedfunction.method

Interface MethodParameterManufacturerContext

All Superinterfaces:

SourceContext, SourceProperties

public interface MethodParameterManufacturerContext
extends SourceContext

Context for the MethodParameterManufacturer.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addDefaultDependencyAnnotation(java.lang.Object annotation)	Adds an annotation to the default ManagedFunctionObjectTypeBuilder.
<E extends java.lang.Throwable> ManagedFunctionEscalationTypeBuilder	addEscalation(java.lang.Class<E> escalationType)	Adds a ManagedFunctionEscalationTypeBuilder to the ManagedFunctionTypeBuilder definition.
int	addFlow(java.util.function.Consumer<ManagedFunctionFlowTypeBuilder<Indexed>> builder)	Adds a ManagedFunctionFlowTypeBuilder to the ManagedFunctionTypeBuilder definition.
int	addObject(java.lang.Class<?> objectType, java.util.function.Consumer<ManagedFunctionObjectTypeBuilder<Indexed>> builder)	Adds a ManagedFunctionObjectTypeBuilder to the ManagedFunctionTypeBuilder definition.
java.lang.String	getFunctionName()	Obtains the name of the ManagedFunction.
java.lang.reflect.Method	getMethod()	Obtains the Method.
java.lang.annotation.Annotation[]	getParameterAnnotations()	Obtains the Annotation instances for the parameter.
java.lang.Class<?>	getParameterClass()	Obtains the Class of the parameter.
int	getParameterIndex()	Obtains the index of the parameter on the Method.
java.lang.String	getParameterQualifier()	Obtains the parameter qualifier.
java.lang.reflect.Type	getParameterType()	Obtains the Type of the parameter.
SourceContext	getSourceContext()	Obtains the SourceContext.

Methods inherited from interface net.officefloor.frame.api.source.SourceContext

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

getParameterClass

java.lang.Class<?> getParameterClass()

Obtains the Class of the parameter.

Returns:

Class of the parameter.

getParameterType

java.lang.reflect.Type getParameterType()

Obtains the Type of the parameter.

Returns:

Type of the parameter.

getParameterQualifier

java.lang.String getParameterQualifier()

Obtains the parameter qualifier.

This is via Qualifier or Qualified Annotation on the parameter.

This provides standard means to obtain the qualifier and avoid each MethodParameterManufacturer handling Annotation to determine.

Returns:

Qualifier for the parameter.

getParameterAnnotations

java.lang.annotation.Annotation[] getParameterAnnotations()

Obtains the Annotation instances for the parameter.

Returns:

Annotation instances for the parameter.

getFunctionName

java.lang.String getFunctionName()

Obtains the name of the ManagedFunction.

Returns:

Name of the ManagedFunction.

getMethod

java.lang.reflect.Method getMethod()

Obtains the Method.

Due to type erasure, the type information on the parameter Class may be lost. This allows more information to be derived about the parameter.

Returns:

Method.

getParameterIndex

int getParameterIndex()

Obtains the index of the parameter on the Method.

Returns:

Index of the parameter on the Method.

addObject

int addObject(java.lang.Class<?> objectType,
              java.util.function.Consumer<ManagedFunctionObjectTypeBuilder<Indexed>> builder)

Adds a ManagedFunctionObjectTypeBuilder to the ManagedFunctionTypeBuilder definition.

Parameters:

objectType - Type of the dependent Object.

builder - Means to build the ManagedFunctionObjectTypeBuilder.

Returns:

Index for the added Object.

addFlow

int addFlow(java.util.function.Consumer<ManagedFunctionFlowTypeBuilder<Indexed>> builder)

Adds a ManagedFunctionFlowTypeBuilder to the ManagedFunctionTypeBuilder definition.

Parameters:

builder - Means to build the ManagedFunctionFlowTypeBuilder.

Returns:

Index for the added Flow.

addEscalation

<E extends java.lang.Throwable> ManagedFunctionEscalationTypeBuilder addEscalation(java.lang.Class<E> escalationType)

Adds a ManagedFunctionEscalationTypeBuilder to the ManagedFunctionTypeBuilder definition.

It is possible the MethodParameterFactory will throw an Escalation. While this should be avoided, this allows registering Escalation for being handled.

Type Parameters:

E - Escalation type.

Parameters:

escalationType - Type to be handled by an EscalationFlow.

Returns:

ManagedFunctionEscalationTypeBuilder to provide the type definition.

addDefaultDependencyAnnotation

void addDefaultDependencyAnnotation(java.lang.Object annotation)

Adds an annotation to the default ManagedFunctionObjectTypeBuilder.

This allows enriching the default ManagedFunctionObjectTypeBuilder with additional annotations.

Parameters:

annotation - Annotation for the default ManagedFunctionObjectTypeBuilder.

getSourceContext

SourceContext getSourceContext()

Obtains the SourceContext.

Returns:

SourceContext.