Home | History | Annotate | Download | only in annotation
      1 /*
      2  * Copyright (C) 2017 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 android.content.Intent;
     20 
     21 import java.lang.annotation.ElementType;
     22 import java.lang.annotation.Retention;
     23 import java.lang.annotation.RetentionPolicy;
     24 import java.lang.annotation.Target;
     25 
     26 /**
     27  * Description of how the annotated broadcast action behaves.
     28  *
     29  * @hide
     30  */
     31 @Target({ ElementType.FIELD })
     32 @Retention(RetentionPolicy.SOURCE)
     33 public @interface BroadcastBehavior {
     34     /**
     35      * This broadcast will only be delivered to an explicit target.
     36      *
     37      * @see Intent#setPackage(String)
     38      * @see Intent#setComponent(android.content.ComponentName)
     39      */
     40     boolean explicitOnly() default false;
     41 
     42     /**
     43      * This broadcast will only be delivered to registered receivers.
     44      *
     45      * @see Intent#FLAG_RECEIVER_REGISTERED_ONLY
     46      */
     47     boolean registeredOnly() default false;
     48 
     49     /**
     50      * This broadcast will include all {@code AndroidManifest.xml} receivers
     51      * regardless of process state.
     52      *
     53      * @see Intent#FLAG_RECEIVER_INCLUDE_BACKGROUND
     54      */
     55     boolean includeBackground() default false;
     56 
     57     /**
     58      * This broadcast is protected and can only be sent by the OS.
     59      */
     60     boolean protectedBroadcast() default false;
     61 }
     62