ExportedProperty

ExportedProperty

ExportedProperty(
    resolveId: Boolean, 
    mapping: Array<ViewDebug.IntToString>, 
    indexMapping: Array<ViewDebug.IntToString>, 
    flagMapping: Array<ViewDebug.FlagToString>, 
    deepExport: Boolean, 
    prefix: String, 
    category: String, 
    formatToHexString: Boolean, 
    hasAdjacentMapping: Boolean)

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.

category

val category: String

Specifies the category the property falls into, such as measurement, layout, drawing, etc.

deepExport

val deepExport: Boolean

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.

flagMapping

val flagMapping: Array<ViewDebug.FlagToString>

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;
  <pre>
 
  A specified String is output when the following is true:</pre>

formatToHexString

val formatToHexString: Boolean

Indicates whether or not to format an int or byte value as a hex string.

hasAdjacentMapping

val hasAdjacentMapping: Boolean

Indicates whether or not the key to value mappings are held in adjacent indices. Note: Applies only to fields and methods that return String[].

indexMapping

val indexMapping: Array<ViewDebug.IntToString>

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;
  <pre></pre>

mapping

val mapping: Array<ViewDebug.IntToString>

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() { ...
  <pre></pre>

prefix

val prefix: String

The prefix to use on child properties when deep export is enabled

resolveId

val resolveId: Boolean

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.