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

public final Class ProviderLookup<T>

extends Object
implements Element
Class Inheritance
All Implemented Interfaces
com.google.inject.spi.Element
Static Imports
com.google.common.base.Preconditions.checkNotNull, .Preconditions.checkState
A lookup of the provider for a type. Lookups are created explicitly in a module using getProvider() statements: 
    Provider<PaymentService> paymentServiceProvider
        = getProvider(PaymentService.class);
Author
[email protected] (Jesse Wilson)
Since
2.0

Field Summary

Modifier and TypeField and Description
private Provider<T>
delegate

private final Dependency<T>
dependency

private final Object
source

Constructor Summary

AccessConstructor and Description
public
ProviderLookup(Object source, Key<T> key)

public
ProviderLookup(Object source, Dependency<T> dependency)

Method Summary

Modifier and TypeMethod and Description
public <T> T
acceptVisitor(ElementVisitor<T>
to call back on
visitor)

Implements com.google.inject.spi.Element.acceptVisitor.

Accepts an element visitor.
public void
applyTo(Binder
to apply configuration element to
binder)

Implements com.google.inject.spi.Element.applyTo.

Writes this module element to the given binder (optional operation).
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Provider<T>
getDelegate()

Returns the delegate provider, or null if it has not yet been initialized.

public Dependency<T>
getDependency()

public Key<T>
getKey()

public Provider<T>
getProvider()

Returns the looked up provider.

public Object
getSource()

Implements com.google.inject.spi.Element.getSource.

Returns an arbitrary object containing information about the "place" where this element was configured.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public void
initializeDelegate(Provider<T> delegate)

Sets the actual provider.

public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

delegateback to summary
private Provider<T> delegate
dependencyback to summary
private final Dependency<T> dependency
sourceback to summary
private final Object source

Constructor Detail

ProviderLookupback to summary
public ProviderLookup(Object source, Key<T> key)
ProviderLookupback to summary
public ProviderLookup(Object source, Dependency<T> dependency)
Since
4.0

Method Detail

acceptVisitorback to summary
public <T> T acceptVisitor(ElementVisitor<T> visitor)

Implements com.google.inject.spi.Element.acceptVisitor.

Doc from com.google.inject.spi.Element.acceptVisitor.

Accepts an element visitor. Invokes the visitor method specific to this element's type.

Parameters
visitor:ElementVisitor<T>

to call back on

Annotations
@Override
applyToback to summary
public void applyTo(Binder binder)

Implements com.google.inject.spi.Element.applyTo.

Doc from com.google.inject.spi.Element.applyTo.

Writes this module element to the given binder (optional operation).

Parameters
binder:Binder

to apply configuration element to

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

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
obj: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
getDelegateback to summary
public Provider<T> getDelegate()

Returns the delegate provider, or null if it has not yet been initialized. The delegate will be initialized when this element is processed, or otherwise used to create an injector.

getDependencyback to summary
public Dependency<T> getDependency()
Since
4.0
getKeyback to summary
public Key<T> getKey()
getProviderback to summary
public Provider<T> getProvider()

Returns the looked up provider. The result is not valid until this lookup has been initialized, which usually happens when the injector is created. The provider will throw an IllegalStateException if you try to use it beforehand.

getSourceback to summary
public Object getSource()

Implements com.google.inject.spi.Element.getSource.

Doc from com.google.inject.spi.Element.getSource.

Returns an arbitrary object containing information about the "place" where this element was configured. Used by Guice in the production of descriptive error messages.

Tools might specially handle types they know about; StackTraceElement is a good example. Tools should simply call toString() on the source object if the type is unfamiliar.

Annotations
@Override
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
initializeDelegateback to summary
public void initializeDelegate(Provider<T> delegate)

Sets the actual provider.

Exceptions
IllegalStateException:
if the delegate is already set
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