Top Description Fields Constructors Methods
com.google.inject.spi

public final Class Dependency<T>

extends Object
Class Inheritance
Static Imports
com.google.common.base.Preconditions.checkNotNull

A variable that can be resolved by an injector.

Use get to build a freestanding dependency, or InjectionPoint to build one that's attached to a constructor, method or field.

Authors
[email protected] (Bob Lee), [email protected] (Jesse Wilson)
Since
2.0

Field Summary

Modifier and TypeField and Description
private final InjectionPoint
private final Key<T>
private final boolean
private final int

Constructor Summary

AccessConstructor and Description
pack-priv
Dependency(InjectionPoint injectionPoint, Key<T> key, boolean nullable, int parameterIndex)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static Set<Dependency<?>>
forInjectionPoints(Set<InjectionPoint> injectionPoints)

Returns the dependencies from the given injection points.

public static <T> Dependency<T>
get(Key<T> key)

Returns a new dependency that is not attached to an injection point.

public InjectionPoint
getInjectionPoint()

Returns the injection point to which this dependency belongs, or null if this dependency isn't attached to a particular injection point.

public Key<T>
getKey()

Returns the key to the binding that satisfies this dependency.

public int
getParameterIndex()

Returns the index of this dependency in the injection point's parameter list, or -1 if this dependency does not belong to a parameter list.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
isNullable()

Returns true if null is a legal value for this dependency.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

injectionPointback to summary
private final InjectionPoint injectionPoint
keyback to summary
private final Key<T> key
nullableback to summary
private final boolean nullable
parameterIndexback to summary
private final int parameterIndex

Constructor Detail

Dependencyback to summary
pack-priv Dependency(InjectionPoint injectionPoint, Key<T> key, boolean nullable, int parameterIndex)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
forInjectionPointsback to summary
public static Set<Dependency<?>> forInjectionPoints(Set<InjectionPoint> injectionPoints)

Returns the dependencies from the given injection points.

getback to summary
public static <T> Dependency<T> get(Key<T> key)

Returns a new dependency that is not attached to an injection point. The returned dependency is nullable.

getInjectionPointback to summary
public InjectionPoint getInjectionPoint()

Returns the injection point to which this dependency belongs, or null if this dependency isn't attached to a particular injection point.

getKeyback to summary
public Key<T> getKey()

Returns the key to the binding that satisfies this dependency.

getParameterIndexback to summary
public int getParameterIndex()

Returns the index of this dependency in the injection point's parameter list, or -1 if this dependency does not belong to a parameter list. Only method and constructor dependencies are elements in a parameter list.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isNullableback to summary
public boolean isNullable()

Returns true if null is a legal value for this dependency.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override