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 static java.lang.annotation.ElementType.TYPE;
     20 import static java.lang.annotation.RetentionPolicy.SOURCE;
     21 
     22 import android.content.Context;
     23 
     24 import java.lang.annotation.Retention;
     25 import java.lang.annotation.Target;
     26 
     27 /**
     28  * Description of a system service available through
     29  * {@link Context#getSystemService(Class)}. This is used to auto-generate
     30  * documentation explaining how to obtain a reference to the service.
     31  *
     32  * @hide
     33  */
     34 @Retention(SOURCE)
     35 @Target(TYPE)
     36 public @interface SystemService {
     37     /**
     38      * The string name of the system service that can be passed to
     39      * {@link Context#getSystemService(String)}.
     40      *
     41      * @see Context#getSystemServiceName(Class)
     42      */
     43     String value();
     44 }
     45