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.annotation; 18 19 import static java.lang.annotation.ElementType.CONSTRUCTOR; 20 import static java.lang.annotation.ElementType.FIELD; 21 import static java.lang.annotation.ElementType.METHOD; 22 import static java.lang.annotation.ElementType.PARAMETER; 23 import static java.lang.annotation.ElementType.TYPE; 24 import static java.lang.annotation.RetentionPolicy.SOURCE; 25 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.Target; 28 29 /** 30 * Denotes that the annotated element, while not disallowed or deprecated, is one that 31 * programmers are generally discouraged from using. 32 * <p> 33 * Example: 34 * <pre><code> 35 * @Discouraged(message = "It is much more efficient to retrieve " 36 * + "resources by identifier than by name.") 37 * public void getValue(String name) { 38 * ... 39 * } 40 * </code></pre> 41 * </p> 42 * @hide 43 */ 44 @Retention(SOURCE) 45 @Target({CONSTRUCTOR, FIELD, METHOD, PARAMETER, TYPE}) 46 public @interface Discouraged { 47 /** 48 * Defines the message to display when an element marked with this annotation is used. An 49 * alternative should be provided in the message. 50 */ message()51 String message(); 52 } 53 54