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

public final Class ScopeBinding

extends Object
implements Element
Class Inheritance
All Implemented Interfaces
com.google.inject.spi.Element
Static Imports
com.google.common.base.Preconditions.checkNotNull

Registration of a scope annotation with the scope that implements it. Instances are created explicitly in a module using bindScope() statements:
    Scope recordScope = new RecordScope();
    bindScope(RecordScoped.class, new RecordScope());
Author
[email protected] (Jesse Wilson)
Since
2.0

Field Summary

Modifier and TypeField and Description
private final Class<? extends Annotation>
private final Scope
private final Object

Constructor Summary

AccessConstructor and Description
pack-priv
ScopeBinding(Object source, Class<? extends Annotation> annotationType, Scope scope)

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 Class<? extends Annotation>
public Scope
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 String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

annotationTypeback to summary
private final Class<? extends Annotation> annotationType
scopeback to summary
private final Scope scope
sourceback to summary
private final Object source

Constructor Detail

ScopeBindingback to summary
pack-priv ScopeBinding(Object source, Class<? extends Annotation> annotationType, Scope scope)

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
getAnnotationTypeback to summary
public Class<? extends Annotation> getAnnotationType()
getScopeback to summary
public Scope getScope()
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
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