dagger.hilt.processor.internal.root.Root Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hilt-compiler Show documentation
A fast dependency injector for Android and Java.
The newest version!
/*
 * Copyright (C) 2019 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.hilt.processor.internal.root;

import androidx.room.compiler.processing.XElement;
import androidx.room.compiler.processing.XProcessingEnv;
import androidx.room.compiler.processing.XTypeElement;
import com.google.auto.value.AutoValue;
import com.squareup.javapoet.ClassName;
import dagger.hilt.processor.internal.ClassNames;
import dagger.internal.codegen.xprocessing.XElements;

/** Metadata for a root element that can trigger the {@link RootProcessor}. */
@AutoValue
abstract class Root {
  /**
   * Creates the default root for this (test) build compilation.
   *
   * A default root installs only the global {@code InstallIn} and {@code TestInstallIn}
   * dependencies. Test-specific dependencies are not installed in the default root.
   *
   * 
The default root is used for two purposes:
   *
   * 

   *   To inject {@code EarlyEntryPoint} annotated interfaces.
   *   
To inject tests that only depend on global dependencies
   * 
   */
  static Root createDefaultRoot(XProcessingEnv env) {
    XTypeElement rootElement = env.requireTypeElement(ClassNames.DEFAULT_ROOT.canonicalName());
    return new AutoValue_Root(rootElement, rootElement, /*isTestRoot=*/ true);
  }

  /** Creates a {@plainlink Root root} for the given {@plainlink Element element}. */
  static Root create(XElement element, XProcessingEnv env) {
    XTypeElement rootElement = XElements.asTypeElement(element);
    if (ClassNames.DEFAULT_ROOT.equals(rootElement.getClassName())) {
      return createDefaultRoot(env);
    }
    return new AutoValue_Root(rootElement, rootElement, RootType.of(rootElement).isTestRoot());
  }

  /** Returns the root element that should be used with processing. */
  abstract XTypeElement element();

  /**
   * Returns the originating root element. In most cases this will be the same as {@link
   * #element()}.
   */
  abstract XTypeElement originatingRootElement();

  /** Returns {@code true} if this is a test root. */
  abstract boolean isTestRoot();

  /** Returns the class name of the root element. */
  ClassName classname() {
    return element().getClassName();
  }

  /** Returns the class name of the originating root element. */
  ClassName originatingRootClassname() {
    return originatingRootElement().getClassName();
  }

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

  /** Returns {@code true} if this uses the default root. */
  boolean isDefaultRoot() {
    return classname().equals(ClassNames.DEFAULT_ROOT);
  }
}