Report
class Report
| kotlin.Any | |
| ↳ | android.hardware.hid.Report |
Represents a Human Interface Device (HID) report exchanged between a host and a HID device.
A HID report contains structured data defined by the device's report descriptor. It includes an optional report ID that distinguishes between multiple report formats supported by the same device, along with a read-only binary data payload.
Summary
| Public constructors | |
|---|---|
Report(reportId: Int, data: ByteBuffer)Creates a new |
|
Report(data: ByteBuffer)Constructor for a report that does not use report ID. |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| ByteBuffer |
getData()Returns the data provided by the device for the report ID. |
| Int |
Accessor for the report ID. |
| Int |
hashCode()Returns a hash code value for the object. |
Public constructors
Report
Report(
reportId: Int,
data: ByteBuffer)
Creates a new Report instance with a specified report ID and binary data payload.
To prevent external modification, the provided ByteBuffer is copied into an internal payload buffer.
| Parameters | |
|---|---|
reportId |
Int: the ID for this report format, or zero if report IDs are not used. |
data |
ByteBuffer: the non-null buffer containing the raw binary report payload. |
Report
Report(data: ByteBuffer)
Constructor for a report that does not use report ID.
| Parameters | |
|---|---|
data |
ByteBuffer: the report data. This value cannot be null. |
Public methods
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
getData
fun getData(): ByteBuffer
Returns the data provided by the device for the report ID.
The data format is specified in the device descriptor, provided by HidDevice.getReportDescriptor.
| Return | |
|---|---|
ByteBuffer |
the ByteBuffer of the raw report data. This value cannot be null. |
getReportId
fun getReportId(): Int
Accessor for the report ID.
| Return | |
|---|---|
Int |
the report ID or zero if the device does not use report IDs. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |