1 /*
2  * Copyright (C) 2014 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.support.annotation;
17 
18 import java.lang.annotation.Retention;
19 import java.lang.annotation.Target;
20 
21 import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
22 import static java.lang.annotation.ElementType.FIELD;
23 import static java.lang.annotation.ElementType.METHOD;
24 import static java.lang.annotation.ElementType.PARAMETER;
25 import static java.lang.annotation.RetentionPolicy.SOURCE;
26 
27 /**
28  * Denotes that the annotated String element, represents a logical
29  * type and that its value should be one of the explicitly named constants.
30  * <p>
31  * Example:
32  * <pre><code>
33  *  &#64;Retention(SOURCE)
34  *  &#64;StringDef({
35  *     POWER_SERVICE,
36  *     WINDOW_SERVICE,
37  *     LAYOUT_INFLATER_SERVICE
38  *  })
39  *  public @interface ServiceName {}
40  *  public static final String POWER_SERVICE = "power";
41  *  public static final String WINDOW_SERVICE = "window";
42  *  public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
43  *  ...
44  *  public abstract Object getSystemService(@ServiceName String name);
45  * </code></pre>
46  */
47 @Retention(SOURCE)
48 @Target({ANNOTATION_TYPE})
49 public @interface StringDef {
50     /** Defines the allowed constants for this element */
value()51     String[] value() default {};
52 }
53