InspectableProperty

annotation InspectableProperty

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
InspectableProperty.EnumEntry

One entry in an enumeration packed into a primitive {int}.
InspectableProperty.FlagEntry

One flag value of many that may be packed into a primitive {int}.
InspectableProperty.ValueType

The type of value packed into a primitive {int}.

Public methods
abstract @NonNull int

If the property is inflated from XML, the resource ID of its XML attribute.
abstract @NonNull Array<@NonNull InspectableProperty.EnumEntry>

For enumerations packed into primitive {int} properties, map the values to string names.
abstract @NonNull Array<@NonNull InspectableProperty.FlagEntry>

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

If this property has an attribute ID.
abstract @NonNull String

The name of the property.
abstract @NonNull InspectableProperty.ValueType

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

Public methods

attributeId

@NonNull
public abstract int attributeId()

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

@NonNull
public abstract Array<@NonNull InspectableProperty.EnumEntry> enumMapping()

For enumerations packed into primitive {int} properties, map the values to string names. Note that {@code #enumMapping()} cannot be used simultaneously with flagMapping.

Returns
Array<@NonNull InspectableProperty.EnumEntry>

An array of EnumEntry, empty if not applicable

flagMapping

@NonNull
public abstract Array<@NonNull InspectableProperty.FlagEntry> flagMapping()

For flags packed into primitive {int} properties, model the string names of the flags. Note that {@code #flagMapping()} cannot be used simultaneously with enumMapping.

Returns
Array<@NonNull InspectableProperty.FlagEntry>

An array of FlagEntry, empty if not applicable

hasAttributeId

@NonNull
public abstract boolean hasAttributeId()

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

@NonNull
public abstract String name()

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

@NonNull
public abstract InspectableProperty.ValueType valueType()

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

Returns
InspectableProperty.ValueType

A ValueType