1 /*
2  * Copyright (C) 2021 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.content.om;
18 
19 import android.annotation.NonNull;
20 import android.annotation.Nullable;
21 import android.annotation.SystemApi;
22 
23 /**
24  * A subset of {@link OverlayInfo} fields that when changed cause the overlay's settings to be
25  * completely reinitialized.
26  *
27  * @hide
28  */
29 public interface CriticalOverlayInfo {
30 
31     /**
32      * @return the package name of the overlay.
33      */
34     @NonNull
getPackageName()35     String getPackageName();
36 
37     /**
38      * @return the unique name of the overlay within its containing package.
39      */
40     @Nullable
getOverlayName()41     String getOverlayName();
42 
43     /**
44      * @return the target package name of the overlay.
45      */
46     @NonNull
getTargetPackageName()47     String getTargetPackageName();
48 
49     /**
50      * @return the name of the target overlayable declaration.
51      */
52     @Nullable
getTargetOverlayableName()53     String getTargetOverlayableName();
54 
55     /**
56      * @return an identifier representing the current overlay.
57      */
58     @NonNull
getOverlayIdentifier()59     OverlayIdentifier getOverlayIdentifier();
60 
61     /**
62      * Returns whether or not the overlay is a {@link FabricatedOverlay}.
63      */
isFabricated()64     boolean isFabricated();
65 }
66