Discouraged.kt
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.annotation
/**
* Denotes that the annotated element, while not disallowed or deprecated, is one that
* programmers are generally discouraged from using.
*
* Example:
* ```
* @Discouraged(message = "It is much more efficient to retrieve "
* + "resources by identifier than by name.")
* public void getValue(String name) {
* ...
* }
* ```
*
*/
@Retention(AnnotationRetention.SOURCE)
@Target(
AnnotationTarget.CONSTRUCTOR,
AnnotationTarget.FIELD,
AnnotationTarget.FUNCTION,
AnnotationTarget.PROPERTY_GETTER,
AnnotationTarget.PROPERTY_SETTER,
AnnotationTarget.VALUE_PARAMETER,
AnnotationTarget.ANNOTATION_CLASS,
AnnotationTarget.CLASS
)
public annotation class Discouraged(
/**
* Defines the message to display when an element marked with this annotation is used. An
* alternative should be provided in the message.
*/
val message: String
)