InspectableProperty

Artifact: androidx.annotation:annotation

View Source

Added in 1.1.0

Deprecated in 1.3.0

---

Kotlin |Java

Common/AllAndroid/JVMNative/C/iOS

• android

  @Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])
  @Retention(value = AnnotationRetention.SOURCE)
  annotation InspectableProperty

---

This annotation is deprecated.
Replaced by the androidx.resourceinpsection package.

Denotes that the annotated method is the getter for a resources-backed property that should be shown in Android Studio's inspection tools.

Summary

Nested types
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS]) @Retention(value = AnnotationRetention.SOURCE) annotation InspectableProperty.EnumEntry This annotation is deprecated. Replaced by the androidx.resourceinpsection package.
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CLASS]) @Retention(value = AnnotationRetention.SOURCE) annotation InspectableProperty.FlagEntry This annotation is deprecated. Replaced by the androidx.resourceinpsection package.
enum InspectableProperty.ValueType : Enum This enum is deprecated. Replaced by the androidx.resourceinpsection package.

Public constructors
InspectableProperty(     name: String,     attributeId: Int,     hasAttributeId: Boolean,     valueType: InspectableProperty.ValueType,     enumMapping: Array<InspectableProperty.EnumEntry>,     flagMapping: Array<InspectableProperty.FlagEntry> ) This function is deprecated. Replaced by the androidx.resourceinpsection package.	android

Public properties
Int	attributeId This property is deprecated. Replaced by the androidx.resourceinpsection package.	android
Array<InspectableProperty.EnumEntry>	enumMapping This property is deprecated. Replaced by the androidx.resourceinpsection package.	android
Array<InspectableProperty.FlagEntry>	flagMapping This property is deprecated. Replaced by the androidx.resourceinpsection package.	android
Boolean	hasAttributeId This property is deprecated. Replaced by the androidx.resourceinpsection package.	android
String	name This property is deprecated. Replaced by the androidx.resourceinpsection package.	android
InspectableProperty.ValueType	valueType This property is deprecated. Replaced by the androidx.resourceinpsection package.	android

Public constructors

InspectableProperty

android

InspectableProperty(
    name: String = "",
    attributeId: Int = 0,
    hasAttributeId: Boolean = true,
    valueType: InspectableProperty.ValueType = ValueType.INFERRED,
    enumMapping: Array<InspectableProperty.EnumEntry> = [],
    flagMapping: Array<InspectableProperty.FlagEntry> = []
)

This function is deprecated.
Replaced by the androidx.resourceinpsection package.

Public properties

attributeId

android

val attributeId: Int

This property is deprecated.
Replaced by the androidx.resourceinpsection package.

If the property is inflated from XML, the resource ID of its XML attribute.

If left as the default, and hasAttributeId is true, the attribute ID will be inferred from name.

Returns
Int	The attribute ID of the property or the default null resource ID

enumMapping

android

val enumMapping: Array<InspectableProperty.EnumEntry>

This property is deprecated.
Replaced by the androidx.resourceinpsection package.

For enumerations packed into primitive {int} properties, map the values to string names.

Note that #enumMapping() cannot be used simultaneously with flagMapping.

Returns
Array<InspectableProperty.EnumEntry>	An array of EnumEntry, empty if not applicable

flagMapping

android

val flagMapping: Array<InspectableProperty.FlagEntry>

This property is deprecated.
Replaced by the androidx.resourceinpsection package.

For flags packed into primitive {int} properties, model the string names of the flags.

Note that #flagMapping() cannot be used simultaneously with enumMapping.

Returns
Array<InspectableProperty.FlagEntry>	An array of FlagEntry, empty if not applicable

hasAttributeId

android

val hasAttributeId: Boolean

This property is deprecated.
Replaced by the androidx.resourceinpsection package.

If this property has an attribute ID.

Set to false if the annotated property does not have an attribute ID, that is, it is not inflated from an XML attribute. This will prevent the automatic inference of the attribute.

Returns
Boolean	Whether to infer an attribute ID if not supplied

name

android

val name: String

This property is deprecated.
Replaced by the androidx.resourceinpsection package.

The name of the property.

If left empty (the default), the property name will be inferred from the name of the getter method.

Returns
String	The name of the property.

valueType

android

val valueType: InspectableProperty.ValueType

This property is deprecated.
Replaced by the androidx.resourceinpsection package.

Specify how to interpret a value type packed into a primitive integer.

Returns
InspectableProperty.ValueType	A ValueType