dagger.spi.model.DaggerProcessingEnv Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dagger-spi Show documentation

A fast dependency injector for Android and Java.

There is a newer version: 2.52

/*
 * Copyright (C) 2021 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.spi.model;

import com.google.devtools.ksp.processing.Resolver;
import com.google.devtools.ksp.processing.SymbolProcessorEnvironment;
import com.google.errorprone.annotations.DoNotMock;
import javax.annotation.processing.ProcessingEnvironment;

/** Wrapper type for an element. */
@DoNotMock("Only use real implementations created by Dagger")
public abstract class DaggerProcessingEnv {
  /** Represents a type of backend used for compilation. */
  public enum Backend {
    JAVAC,
    KSP
  }

  /**
   * Returns the Javac representation for the processing environment.
   *
   * @throws IllegalStateException if the current backend isn't Javac.
   */
  public abstract ProcessingEnvironment javac();

  /**
   * Returns the KSP representation for the processing environment.
   *
   * @throws IllegalStateException if the current backend isn't KSP.
   */
  public abstract SymbolProcessorEnvironment ksp();

  /**
   * Returns the KSP representation for the resolver.
   *
   * @throws IllegalStateException if the current backend isn't KSP.
   */
  public abstract Resolver resolver();

  /** Returns the backend used in this compilation. */
  public abstract DaggerProcessingEnv.Backend backend();
}