• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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  * Denotes that the annotated method is unsupported on Ravenwood, and calling it will throw
27  * a runtime exception.
28  * <p>
29  * Implementation included in the annotated method will be removed on Ravenwood, and calling it
30  * will throw a runtime exception with a message indicating that the method is unsupported
31  * on Ravenwood.
32  *
33  * TODO: Create "whole-class-throw"?
34  *
35  * @hide
36  */
37 @Target({METHOD, CONSTRUCTOR})
38 @Retention(RetentionPolicy.CLASS)
39 public @interface RavenwoodThrow {
40     /**
41      * One or more classes that aren't yet supported by Ravenwood, which is why this method throws.
42      */
blockedBy()43     Class<?>[] blockedBy() default {};
44 
45     /**
46      * General free-form description of why this method throws.
47      */
reason()48     String reason() default "";
49 
50     /**
51      * Tracking bug number, if any.
52      */
bug()53     long bug() default 0;
54 }
55