org.apache.reef.tang.implementation

Class InjectionPlan<T>

java.lang.Object

org.apache.reef.tang.implementation.InjectionPlan<T>

All Implemented Interfaces:

Traversable<InjectionPlan<?>>

Direct Known Subclasses:

Constructor, InjectionFuturePlan, JavaInstance, ListInjectionPlan, SetInjectionPlan, Subplan

public abstract class InjectionPlan<T>
extends Object
implements Traversable<InjectionPlan<?>>

Constructor Summary

Constructors

Constructor and Description
InjectionPlan(Node node)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<InjectionPlan<?>>	getChildren() Get child elements of the injection plan tree.
Node	getNode()
abstract int	getNumAlternatives()
abstract boolean	isAmbiguous()
boolean	isFeasible()
abstract boolean	isInjectable()
String	toCantInjectString() Algorithm for generating cant inject string:
String	toPrettyString()
abstract String	toShallowString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InjectionPlan

public InjectionPlan(Node node)

Method Detail

getNode

public Node getNode()

getChildren

public Collection<InjectionPlan<?>> getChildren()

Get child elements of the injection plan tree. By default, returns an empty list.

Specified by:

getChildren in interface Traversable<InjectionPlan<?>>

Returns:

An empty list.

getNumAlternatives

public abstract int getNumAlternatives()

isFeasible

public boolean isFeasible()

isAmbiguous

public abstract boolean isAmbiguous()

isInjectable

public abstract boolean isInjectable()

toPrettyString

public String toPrettyString()

toCantInjectString

public final String toCantInjectString()

Algorithm for generating cant inject string:

For infeasible plans:

Some node types are "leaves":

• NamedParameterNode
• ClassNode with no @Inject constructors

We do a depth first search of the injection plan, starting with the left most constructor arguments. When we encounter a constructor whose arguments are all either injectable or non-injectable leaf nodes, we return the name of its parent, and the name of the non-injectable leaves.

For ambiguous plans:

We perform a depth first search of the ambiguous constructors, as above. We return the name of the first class that has multiple constructors that are feasible or ambiguous (as opposed to having a single constructor with an ambiguous argument, or a constructor with an infeasible argument and an ambiguous argument).

toShallowString

public abstract String toShallowString()