• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2020 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 
17 package android.annotation;
18 
19 import static java.lang.annotation.ElementType.FIELD;
20 import static java.lang.annotation.ElementType.METHOD;
21 import static java.lang.annotation.ElementType.PARAMETER;
22 import static java.lang.annotation.ElementType.TYPE;
23 import static java.lang.annotation.RetentionPolicy.SOURCE;
24 
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.Target;
27 
28 /**
29  * Denotes a {@link android.content.Context} that can be used to create UI, meaning that it can
30  * provide a {@link android.view.Display} via {@link android.content.Context#getDisplay} and can be
31  * used to obtain a {@link android.view.WindowManager}, {@link android.view.LayoutInflater} or
32  * {@link android.app.WallpaperManager} via
33  * {@link android.content.Context#getSystemService(String)}. A {@link android.content.Context}
34  * which is marked as {@link UiContext} implies that the {@link android.content.Context} is also a
35  * {@link android.view.DisplayContext}.
36  * <p>
37  * This kind of {@link android.content.Context} is usually an {@link android.app.Activity} or
38  * created via {@link android.content.Context#createWindowContext(int, android.os.Bundle)}.
39  * </p>
40  * This is a marker annotation and has no specific attributes.
41  *
42  * @see android.content.Context#getDisplay()
43  * @see android.content.Context#getSystemService(String)
44  * @see android.content.Context#getSystemService(Class)
45  * @see android.content.Context#createWindowContext(int, android.os.Bundle)
46  * @see DisplayContext
47  * @hide
48  */
49 @Retention(SOURCE)
50 @Target({TYPE, METHOD, PARAMETER, FIELD})
51 public @interface UiContext {
52 }
53