• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.symbol.KSDeclaration;
20 import com.google.errorprone.annotations.DoNotMock;
21 import javax.lang.model.element.ExecutableElement;
22 
23 /** Wrapper type for an executable element. */
24 @DoNotMock("Only use real implementations created by Dagger")
25 public abstract class DaggerExecutableElement {
26   /**
27    * Returns the Javac representation for the executable element.
28    *
29    * @throws IllegalStateException if the current backend isn't Javac.
30    */
javac()31   public abstract ExecutableElement javac();
32 
33   /**
34    * Returns the KSP representation for the executable element. Can be either KSFunctionDeclaration
35    * or KSPropertyDeclaration.
36    *
37    * @throws IllegalStateException if the current backend isn't KSP.
38    */
ksp()39   public abstract KSDeclaration ksp();
40 
41   /** Returns the backend used in this compilation. */
backend()42   public abstract DaggerProcessingEnv.Backend backend();
43 }
44