com.google.inject.spi.ScopeBinding Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guice Show documentation
There is a newer version: 7.0.0
/*
 * Copyright (C) 2008 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 static com.google.common.base.Preconditions.checkNotNull;

import com.google.common.base.MoreObjects;
import com.google.inject.Binder;
import com.google.inject.Scope;
import com.google.inject.internal.Errors;
import java.lang.annotation.Annotation;

/**
 * Registration of a scope annotation with the scope that implements it. Instances are created
 * explicitly in a module using {@link com.google.inject.Binder#bindScope(Class, Scope) bindScope()}
 * statements:
 *
 *  *     Scope recordScope = new RecordScope();
 *     bindScope(RecordScoped.class, new RecordScope());
 *
 * @author [email protected] (Jesse Wilson)
 * @since 2.0
 */
public final class ScopeBinding implements Element {
  private final Object source;
  private final Class annotationType;
  private final Scope scope;

  ScopeBinding(Object source, Class annotationType, Scope scope) {
    this.source = checkNotNull(source, "source");
    this.annotationType = checkNotNull(annotationType, "annotationType");
    this.scope = checkNotNull(scope, "scope");
  }

  @Override
  public Object getSource() {
    return source;
  }

  public Class getAnnotationType() {
    return annotationType;
  }

  public Scope getScope() {
    return scope;
  }

  @Override
  public  T acceptVisitor(ElementVisitor visitor) {
    return visitor.visit(this);
  }

  @Override
  public void applyTo(Binder binder) {
    binder.withSource(getSource()).bindScope(annotationType, scope);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(ScopeBinding.class)
        .add("annotationType", annotationType)
        .add("scope", scope)
        .add("source", Errors.convert(source))
        .toString();
  }
}