src/com/google/inject/spi/InjectableTypeListenerBinding.java

/**
 * Copyright (C) 2009 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.inject.spi;

import com.google.inject.Binder;
import com.google.inject.TypeLiteral;
import com.google.inject.matcher.Matcher;

/**
 * Binds injectable types (picked using a Matcher) to an injectable type listener.
 * Registrations are created explicitly in a module using {@link
 * com.google.inject.Binder#bindListener(com.google.inject.matcher.Matcher,
 * com.google.inject.spi.InjectableType.Listener)} statements:
 *
 * <pre>
 *     register(any(), listener);</pre>
 */
public final class InjectableTypeListenerBinding implements Element {

  final Object source;
  final Matcher<? super TypeLiteral<?>> typeMatcher;
  final InjectableType.Listener listener;

  InjectableTypeListenerBinding(Object source, InjectableType.Listener listener,
      Matcher<? super TypeLiteral<?>> typeMatcher) {
    this.source = source;
    this.listener = listener;
    this.typeMatcher = typeMatcher;
  }

  /** Returns the registered listener. */
  public InjectableType.Listener getListener() {
    return listener;
  }

  /** Returns the type matcher which chooses which types the listener should be notified of. */
  public Matcher<? super TypeLiteral<?>> getTypeMatcher() {
    return typeMatcher;
  }

  public Object getSource() {
    return source;
  }

  public <T> T acceptVisitor(ElementVisitor<T> visitor) {
    return visitor.visit(this);
  }

  public void applyTo(Binder binder) {
    binder.withSource(getSource()).bindListener(typeMatcher, listener);
  }
}