Added in API level 37

StructuredDataInfo

abstract class StructuredDataInfo
kotlin.Any
   ↳ android.view.accessibility.AccessibilityNodeInfo.StructuredDataInfo

An abstract base class for holding structured semantic information about a node.

This class provides a container for a "tag" (a string constant representing the node's role) and a set of key-value "attributes" that provide additional properties. This object can be attached to an AccessibilityNodeInfo to give accessibility services rich, structured information about the node's meaning.

This class is intended to be subclassed for structured semantic standards.

Summary

Public methods
open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
open String?
getAttribute(attributeKey: String)

Gets the value of an attribute.
open MutableMap<String!, String!>

open String

open Int

Returns a hash code value for the object.
open Unit
putAttribute(attributeKey: String, value: String)

Adds an attribute.
open Unit
removeAttribute(attributeKey: String)

Removes an attribute.

Public methods

equals

Added in API level 37
open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAttribute

Added in API level 37
open fun getAttribute(attributeKey: String): String?

Gets the value of an attribute.

Parameters
attributeKey String: The attribute key.
This value cannot be null.
Return
String? The attribute value.
This value may be null.

getAttributes

Added in API level 37
open fun getAttributes(): MutableMap<String!, String!>
Return
MutableMap<String!, String!> The map of attributes.
This value cannot be null.

getTag

Added in API level 37
open fun getTag(): String
Return
String The tag for this structured semantic information.
This value cannot be null.

hashCode

Added in API level 37
open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

putAttribute

Added in API level 37
open fun putAttribute(
    attributeKey: String, 
    value: String
): Unit

Adds an attribute.

Parameters
attributeKey String: The attribute key.
This value cannot be null.
value String: The attribute value.
This value cannot be null.

removeAttribute

Added in API level 37
open fun removeAttribute(attributeKey: String): Unit

Removes an attribute.

Parameters
attributeKey String: The attribute key.
This value cannot be null.