ViewDebug.ExportedProperty
public
static
abstract
@interface
ViewDebug.ExportedProperty
implements
Annotation
android.view.ViewDebug.ExportedProperty |
This annotation can be used to mark fields and methods to be dumped by the view server. Only non-void methods with no arguments can be annotated by this annotation.
Summary
Public methods | |
---|---|
String
|
category()
Specifies the category the property falls into, such as measurement, layout, drawing, etc. |
boolean
|
deepExport()
When deep export is turned on, this property is not dumped. |
FlagToString[]
|
flagMapping()
A flags mapping can be defined to map flags encoded in an integer to specific strings. |
boolean
|
formatToHexString()
Indicates whether or not to format an |
boolean
|
hasAdjacentMapping()
Indicates whether or not the key to value mappings are held in adjacent indices. |
IntToString[]
|
indexMapping()
A mapping can be defined to map array indices to specific strings. |
IntToString[]
|
mapping()
A mapping can be defined to map int values to specific strings. |
String
|
prefix()
The prefix to use on child properties when deep export is enabled |
boolean
|
resolveId()
When resolveId is true, and if the annotated field/method return value is an int, the value is converted to an Android's resource name. |
Inherited methods | |
---|---|
Public methods
category
public String category ()
Specifies the category the property falls into, such as measurement, layout, drawing, etc.
Returns | |
---|---|
String |
the category as String |
deepExport
public boolean deepExport ()
When deep export is turned on, this property is not dumped. Instead, the properties contained in this property are dumped. Each child property is prefixed with the name of this property.
Returns | |
---|---|
boolean |
true if the properties of this property should be dumped |
See also:
flagMapping
public FlagToString[] flagMapping ()
A flags mapping can be defined to map flags encoded in an integer to specific strings. A mapping can be used to see human readable values for the flags of an integer:
@ViewDebug.ExportedProperty(flagMapping = { @ViewDebug.FlagToString(mask = ENABLED_MASK, equals = ENABLED, name = "ENABLED"), @ViewDebug.FlagToString(mask = ENABLED_MASK, equals = DISABLED, name = "DISABLED"), }) private int mFlags;A specified String is output when the following is true:
Returns | |
---|---|
FlagToString[] |
An array of int to String mappings |
formatToHexString
public boolean formatToHexString ()
Indicates whether or not to format an int
or byte
value as a hex string.
Returns | |
---|---|
boolean |
true if the supported values should be formatted as a hex string. |
hasAdjacentMapping
public boolean hasAdjacentMapping ()
Indicates whether or not the key to value mappings are held in adjacent indices. Note: Applies only to fields and methods that return String[].
Returns | |
---|---|
boolean |
true if the key to value mappings are held in adjacent indices. |
indexMapping
public IntToString[] indexMapping ()
A mapping can be defined to map array indices to specific strings. A mapping can be used to see human readable values for the indices of an array:
@ViewDebug.ExportedProperty(indexMapping = { @ViewDebug.IntToString(from = 0, to = "INVALID"), @ViewDebug.IntToString(from = 1, to = "FIRST"), @ViewDebug.IntToString(from = 2, to = "SECOND") }) private int[] mElements;
Returns | |
---|---|
IntToString[] |
An array of int to String mappings |
See also:
mapping
public IntToString[] mapping ()
A mapping can be defined to map int values to specific strings. For instance, View.getVisibility() returns 0, 4 or 8. However, these values actually mean VISIBLE, INVISIBLE and GONE. A mapping can be used to see these human readable values:
@ViewDebug.ExportedProperty(mapping = { @ViewDebug.IntToString(from = 0, to = "VISIBLE"), @ViewDebug.IntToString(from = 4, to = "INVISIBLE"), @ViewDebug.IntToString(from = 8, to = "GONE") }) public int getVisibility() { ...
Returns | |
---|---|
IntToString[] |
An array of int to String mappings |
See also:
prefix
public String prefix ()
The prefix to use on child properties when deep export is enabled
Returns | |
---|---|
String |
a prefix as a String |
See also:
resolveId
public boolean resolveId ()
When resolveId is true, and if the annotated field/method return value is an int, the value is converted to an Android's resource name.
Returns | |
---|---|
boolean |
true if the property's value must be transformed into an Android resource name, false otherwise |