1 /* 2 * Copyright (C) 2021 The Dagger Authors. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package dagger.spi.model; 18 19 import com.google.devtools.ksp.processing.Resolver; 20 import com.google.devtools.ksp.processing.SymbolProcessorEnvironment; 21 import com.google.errorprone.annotations.DoNotMock; 22 import javax.annotation.processing.ProcessingEnvironment; 23 24 /** Wrapper type for an element. */ 25 @DoNotMock("Only use real implementations created by Dagger") 26 public abstract class DaggerProcessingEnv { 27 /** Represents a type of backend used for compilation. */ 28 public enum Backend { 29 JAVAC, 30 KSP 31 } 32 33 /** 34 * Returns the Javac representation for the processing environment. 35 * 36 * @throws IllegalStateException if the current backend isn't Javac. 37 */ javac()38 public abstract ProcessingEnvironment javac(); 39 40 /** 41 * Returns the KSP representation for the processing environment. 42 * 43 * @throws IllegalStateException if the current backend isn't KSP. 44 */ ksp()45 public abstract SymbolProcessorEnvironment ksp(); 46 47 /** 48 * Returns the KSP representation for the resolver. 49 * 50 * @throws IllegalStateException if the current backend isn't KSP. 51 */ resolver()52 public abstract Resolver resolver(); 53 54 /** Returns the backend used in this compilation. */ backend()55 public abstract DaggerProcessingEnv.Backend backend(); 56 } 57