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