1 /*
2  * Copyright (C) 2023 The Android Open Source Project
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 package android.ravenwood.annotation;
17 
18 import static java.lang.annotation.ElementType.CONSTRUCTOR;
19 import static java.lang.annotation.ElementType.METHOD;
20 
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24 
25 /**
26  * THIS ANNOTATION IS EXPERIMENTAL. REACH OUT TO g/ravenwood BEFORE USING IT, OR YOU HAVE ANY
27  * QUESTIONS ABOUT IT.
28  *
29  * TODO: Javadoc
30  * TODO: Create "whole-class-throw"?
31  *
32  * @hide
33  */
34 @Target({METHOD, CONSTRUCTOR})
35 @Retention(RetentionPolicy.CLASS)
36 public @interface RavenwoodThrow {
37     /**
38      * One or more classes that aren't yet supported by Ravenwood, which is why this method throws.
39      */
blockedBy()40     Class<?>[] blockedBy() default {};
41 
42     /**
43      * General free-form description of why this method throws.
44      */
reason()45     String reason() default "";
46 }
47