UwbAddress
public
final
class
UwbAddress
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.ranging.uwb.UwbAddress |
A class representing a UWB address
Summary
Constants | |
---|---|
int |
EXTENDED_ADDRESS_BYTE_LENGTH
|
int |
SHORT_ADDRESS_BYTE_LENGTH
|
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<UwbAddress> |
CREATOR
|
Public methods | |
---|---|
static
UwbAddress
|
createRandomShortAddress()
Generates a new random 2 bytes |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
static
UwbAddress
|
fromBytes(byte[] address)
Create a |
byte[]
|
getAddressBytes()
Get the address as a byte array |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
EXTENDED_ADDRESS_BYTE_LENGTH
public static final int EXTENDED_ADDRESS_BYTE_LENGTH
Constant Value: 8 (0x00000008)
SHORT_ADDRESS_BYTE_LENGTH
public static final int SHORT_ADDRESS_BYTE_LENGTH
Constant Value: 2 (0x00000002)
Fields
Public methods
createRandomShortAddress
public static UwbAddress createRandomShortAddress ()
Generates a new random 2 bytes UwbAddress
.
Returns | |
---|---|
UwbAddress |
a new randomly generated UwbAddress .
This value cannot be null . |
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
public boolean equals (Object obj)
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
fromBytes
public static UwbAddress fromBytes (byte[] address)
Create a ERROR(/android.uwb.UwbAddress)
from a byte array.
If the provided array is SHORT_ADDRESS_BYTE_LENGTH
bytes, a short address is
created. If the provided array is EXTENDED_ADDRESS_BYTE_LENGTH
bytes, then an
extended address is created.
Parameters | |
---|---|
address |
byte : a byte array to convert to a ERROR(/android.uwb.UwbAddress)
This value cannot be null . |
Returns | |
---|---|
UwbAddress |
a ERROR(/android.uwb.UwbAddress) created from the input byte array
This value cannot be null . |
Throws | |
---|---|
IllegalArgumentException |
when the length is not one of
SHORT_ADDRESS_BYTE_LENGTH or EXTENDED_ADDRESS_BYTE_LENGTH bytes |
getAddressBytes
public byte[] getAddressBytes ()
Get the address as a byte array
Returns | |
---|---|
byte[] |
the byte representation of this ERROR(/android.uwb.UwbAddress)
This value cannot be null . |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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 inequals
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 thehashCode
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 thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
This value cannot be null . |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |