Package net.officefloor.plugin.clazz.dependency

Interface ClassDependencyManufacturerContext

All Superinterfaces:

StatePoint

public interface ClassDependencyManufacturerContext
extends StatePoint

Context for the ClassDependencyManufacturer.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ClassDependencyManufacturerContext.AnnotationConfigurer<T>	Allows specifying annotation.
static interface	ClassDependencyManufacturerContext.ClassDependency	Allows further configuration of the Class dependency.
static interface	ClassDependencyManufacturerContext.ClassFlow	Allows further configuration of the Class dependency.
static interface	ClassDependencyManufacturerContext.ItemBuilder	Builds and adds the item.
static interface	ClassDependencyManufacturerContext.QualifierConfigurer<T>	Allows specifying the qualifier.

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(Object annotation)	Adds an annotation to the ManagedFunction / ManagedObject requiring the dependency.
<E extends Throwable> void	addEscalation(Class<E> escalationType)	Registers an Escalation.
<A extends Annotation> A	getDependencyAnnotation(Class<? extends A> annotationType)	Obtains the Annotation by the input type.
Annotation[]	getDependencyAnnotations()	Obtains the Annotation instances for the dependency.
Class<?>	getDependencyClass()	Obtains the Class of the dependency.
String	getDependencyQualifier()	Obtains the dependency qualifier.
Type	getDependencyType()	Obtains the Type of the dependency.
Logger	getLogger()	Obtains the Logger.
String	getName()	Obtains the name of item receiving the dependency.
SourceContext	getSourceContext()	Obtains the SourceContext.
ClassDependencyManufacturerContext.ClassDependency	newDependency(Class<?> objectType)	Adds a ClassDependencyManufacturerContext.ClassDependency.
ClassDependencyManufacturerContext.ClassFlow	newFlow(String flowName)	Adds a ClassDependencyManufacturerContext.ClassFlow.

Methods inherited from interface net.officefloor.plugin.clazz.state.StatePoint

getAnnotatedElement, getExecutable, getExecutableParameterIndex, getField, toLocation

Method Details

getDependencyClass

Class<?> getDependencyClass()

Obtains the Class of the dependency.

Returns:

Class of the dependency.

getDependencyType

Type getDependencyType()

Obtains the Type of the dependency.

Returns:

Type of the dependency.

getDependencyQualifier

String getDependencyQualifier()

Obtains the dependency qualifier.

This is via Qualifier or Qualified Annotation on the dependency.

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

Returns:

Qualifier for the dependency.

getDependencyAnnotations

Annotation[] getDependencyAnnotations()

Obtains the Annotation instances for the dependency.

Returns:

Annotation instances for the dependency.

getDependencyAnnotation

<A extends Annotation> A getDependencyAnnotation(Class<? extends A> annotationType)

Obtains the Annotation by the input type.

Type Parameters:

A - Annotation type.

Parameters:

annotationType - Required Annotation type.

Returns:

Annotation or null if no Annotation by the required type.

getName

String getName()

Obtains the name of item receiving the dependency.

Returns:

Name of item receiving the dependency.

getLogger

Logger getLogger()

Obtains the Logger.

Returns:

Logger.

newDependency

ClassDependencyManufacturerContext.ClassDependency newDependency(Class<?> objectType)

Adds a ClassDependencyManufacturerContext.ClassDependency.

Parameters:

objectType - Type of the dependent Object.

Returns:

ClassDependencyManufacturerContext.ClassDependency.

newFlow

ClassDependencyManufacturerContext.ClassFlow newFlow(String flowName)

Adds a ClassDependencyManufacturerContext.ClassFlow.

Parameters:

flowName - Name of Flow.

Returns:

ClassDependencyManufacturerContext.ClassFlow.

addEscalation

<E extends Throwable> void addEscalation(Class<E> escalationType)

Registers an Escalation.

Type Parameters:

E - Escalation type.

Parameters:

escalationType - Type to be handled by an EscalationFlow.

addAnnotation

void addAnnotation(Object annotation)

Adds an annotation to the ManagedFunction / ManagedObject requiring the dependency.

Parameters:

annotation - Annotation.

getSourceContext

SourceContext getSourceContext()

Obtains the SourceContext.

Returns:

SourceContext.