com.google.inject.spi

Class ProvisionListenerBinding

java.lang.Object

com.google.inject.spi.ProvisionListenerBinding

All Implemented Interfaces:

Element

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

Binds keys (picked using a Matcher) to a provision listener. Listeners are created explicitly in a module using Binder.bindListener(Matcher, ProvisionListener...) statements:

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
private Matcher<? super Binding<?>>	bindingMatcher
private java.util.List<ProvisionListener>	listeners
private java.lang.Object	source

Constructor Summary

Constructors

Constructor and Description
ProvisionListenerBinding(java.lang.Object source, Matcher<? super Binding<?>> bindingMatcher, ProvisionListener[] listeners)

Method Summary

Modifier and Type	Method and Description
<R> R	acceptVisitor(ElementVisitor<R> visitor) Accepts an element visitor.
void	applyTo(Binder binder) Writes this module element to the given binder (optional operation).
Matcher<? super Binding<?>>	getBindingMatcher() Returns the binding matcher which chooses which bindings the listener should be notified of.
java.util.List<ProvisionListener>	getListeners() Returns the registered listeners.
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

Field Detail

source

private final java.lang.Object source

bindingMatcher

private final Matcher<? super Binding<?>> bindingMatcher

listeners

private final java.util.List<ProvisionListener> listeners

Constructor Detail

ProvisionListenerBinding

ProvisionListenerBinding(java.lang.Object source,
                         Matcher<? super Binding<?>> bindingMatcher,
                         ProvisionListener[] listeners)

Method Detail

getListeners

public java.util.List<ProvisionListener> getListeners()

Returns the registered listeners.

getBindingMatcher

public Matcher<? super Binding<?>> getBindingMatcher()

Returns the binding matcher which chooses which bindings the listener should be notified of.

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

acceptVisitor

public <R> R acceptVisitor(ElementVisitor<R> 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