dagger.internal.codegen.BindingNode.java Source code

Introduction

Here is the source code for dagger.internal.codegen.BindingNode.java

Source

/*
 * Copyright (C) 2018 The Dagger Authors.
 *
 * 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 dagger.internal.codegen;

import static com.google.common.base.Preconditions.checkNotNull;
import static dagger.internal.codegen.BindingType.PRODUCTION;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableSet;
import dagger.BindsOptionalOf;
import dagger.Module;
import dagger.model.BindingKind;
import dagger.model.ComponentPath;
import dagger.model.DependencyRequest;
import dagger.model.Key;
import dagger.model.Scope;
import dagger.multibindings.Multibinds;
import java.util.Optional;
import java.util.function.Supplier;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;

/**
 * An implementation of {@link dagger.model.Binding} that also exposes {@link BindingDeclaration}s
 * associated with the binding.
 */
// TODO(dpb): Consider a supertype of dagger.model.Binding that dagger.internal.codegen.Binding
// could also implement.
@AutoValue
abstract class BindingNode implements dagger.model.Binding {
    static BindingNode create(ComponentPath component, Binding delegate,
            Iterable<BindingDeclaration> associatedDeclarations, Supplier<String> toStringFunction) {
        BindingNode node = new AutoValue_BindingNode(component, delegate,
                ImmutableSet.copyOf(associatedDeclarations));
        node.toStringFunction = checkNotNull(toStringFunction);
        return node;
    }

    private Supplier<String> toStringFunction;

    abstract Binding delegate();

    /**
     * The {@link Element}s (other than the binding's {@link #bindingElement()}) that are associated
     * with the binding.
     *
     * <ul>
     *   <li>{@linkplain BindsOptionalOf optional binding} declarations
     *   <li>{@linkplain Module#subcomponents() module subcomponent} declarations
     *   <li>{@linkplain Multibinds multibinding} declarations
     * </ul>
     */
    abstract ImmutableSet<BindingDeclaration> associatedDeclarations();

    @Override
    public Key key() {
        return delegate().key();
    }

    @Override
    public ImmutableSet<DependencyRequest> dependencies() {
        return delegate().dependencies();
    }

    @Override
    public Optional<Element> bindingElement() {
        return delegate().bindingElement();
    }

    @Override
    public Optional<TypeElement> contributingModule() {
        return delegate().contributingModule();
    }

    @Override
    public boolean requiresModuleInstance() {
        return delegate().requiresModuleInstance();
    }

    @Override
    public Optional<Scope> scope() {
        return delegate().scope();
    }

    @Override
    public boolean isNullable() {
        return delegate().isNullable();
    }

    @Override
    public boolean isProduction() {
        return delegate().bindingType().equals(PRODUCTION);
    }

    @Override
    public BindingKind kind() {
        return delegate().kind();
    }

    @Override
    public final String toString() {
        return toStringFunction.get();
    }
}