com.google.inject.spi

Class StaticInjectionRequest

java.lang.Object

com.google.inject.spi.StaticInjectionRequest

All Implemented Interfaces:

Element

public final class StaticInjectionRequest
extends java.lang.Object
implements Element

A request to inject the static fields and methods of a type. Requests are created explicitly in a module using requestStaticInjection() statements:

     requestStaticInjection(MyLegacyService.class);

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	source
private java.lang.Class<?>	type

Constructor Summary

Constructors

Constructor and Description
StaticInjectionRequest(java.lang.Object source, java.lang.Class<?> type)

Method Summary

Modifier and Type	Method and Description
<T> T	acceptVisitor(ElementVisitor<T> visitor) Accepts an element visitor.
void	applyTo(Binder binder) Writes this module element to the given binder (optional operation).
java.util.Set<InjectionPoint>	getInjectionPoints() Returns the static methods and fields of type that will be injected to fulfill this request.
java.lang.Object	getSource() Returns an arbitrary object containing information about the "place" where this element was configured.
java.lang.Class<?>	getType()

Methods inherited from class java.lang.Object

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

Field Detail

source

private final java.lang.Object source

type

private final java.lang.Class<?> type

Constructor Detail

StaticInjectionRequest

StaticInjectionRequest(java.lang.Object source,
                       java.lang.Class<?> type)

Method Detail

getSource

public java.lang.Object getSource()

Description copied from interface: Element

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.

Specified by:

getSource in interface Element

getType

public java.lang.Class<?> getType()

getInjectionPoints

public java.util.Set<InjectionPoint> getInjectionPoints()
                                                 throws ConfigurationException

Returns the static methods and fields of type that will be injected to fulfill this request.

Returns:

a possibly empty set of injection points. The set has a specified iteration order. All fields are returned and then all methods. Within the fields, supertype fields are returned before subtype fields. Similarly, supertype methods are returned before subtype methods.

Throws:

ConfigurationException - if there is a malformed injection point on type, such as a field with multiple binding annotations. The exception's partial value is a Set<InjectionPoint> of the valid injection points.

applyTo

public void applyTo(Binder binder)

Description copied from interface: Element

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

Specified by:

applyTo in interface Element

Parameters:

binder - to apply configuration element to

acceptVisitor

public <T> T acceptVisitor(ElementVisitor<T> visitor)

Description copied from interface: Element

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

Specified by:

acceptVisitor in interface Element

Parameters:

visitor - to call back on