org.elasticsearch.common.inject.spi
Class ScopeBinding

java.lang.Object
  org.elasticsearch.common.inject.spi.ScopeBinding

All Implemented Interfaces:

Element

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

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());

Since:

2.0

Method Summary

<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.lang.Class<? extends java.lang.annotation.Annotation>	getAnnotationType()
Scope	getScope()
java.lang.Object	getSource() Returns an arbitrary object containing information about the "place" where this element was configured.

Methods inherited from class java.lang.Object

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

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

getAnnotationType

public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationType()

getScope

public Scope getScope()

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

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