xref: /aosp_15_r20/external/dagger2/java/dagger/spi/model/DaggerAnnotation.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
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.KSAnnotation;
20 import com.google.errorprone.annotations.DoNotMock;
21 import javax.lang.model.element.AnnotationMirror;
22 
23 /** Wrapper type for an annotation. */
24 @DoNotMock("Only use real implementations created by Dagger")
25 public abstract class DaggerAnnotation {
annotationTypeElement()26   public abstract DaggerTypeElement annotationTypeElement();
27 
28   /**
29    * Returns the Javac representation for the annotation.
30    *
31    * @throws IllegalStateException if the current backend isn't Javac.
32    */
javac()33   public abstract AnnotationMirror javac();
34 
35   /**
36    * Returns the KSP representation for the annotation.
37    *
38    * @throws IllegalStateException if the current backend isn't KSP.
39    */
ksp()40   public abstract KSAnnotation ksp();
41 
42   /** Returns the backend used in this compilation. */
backend()43   public abstract DaggerProcessingEnv.Backend backend();
44 }
45