# UwbAddress

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# UwbAddress

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/ranging/uwb/UwbAddress "View this page in Java")  

```
class UwbAddress : Parcelable
```

|---|------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                   ||
| ↳ | [android.ranging.uwb.UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#) |

A class representing a UWB address

## Summary

|                                                                                                                   Constants                                                                                                                    ||
|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [EXTENDED_ADDRESS_BYTE_LENGTH](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#EXTENDED_ADDRESS_BYTE_LENGTH:kotlin.Int) <br /> |
| static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [SHORT_ADDRESS_BYTE_LENGTH](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#SHORT_ADDRESS_BYTE_LENGTH:kotlin.Int) <br />       |

| Inherited constants ||
|---|---|
| From class[Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#) |----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) <br /> Descriptor bit used with[describeContents()](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. <br />                                                                                                                                                                                                        | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int) <br /> Flag for use with[writeToParcel](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.Int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". Some implementations may want to release resources at this point. <br /> | ||

|                                                                                                                                                                                                                               Public methods                                                                                                                                                                                                                               ||
|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| static[UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#) | [createRandomShortAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#createRandomShortAddress())`()` Generates a new random 2 bytes[UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#).                                                                                                   |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                         | [describeContents](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#describeContents())`()` <br />                                                                                                                                                                                                                                        |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                 | [equals](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one.                                                                                                       |
| static[UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#) | [fromBytes](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#fromBytes(kotlin.ByteArray))`(`address:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`)` Create a[android.uwb.UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#)from a byte array.      |
| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)            | [getAddressBytes](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#getAddressBytes())`()` Get the address as a byte array                                                                                                                                                                                                                 |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                         | [hashCode](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#hashCode())`()` <br />                                                                                                                                                                                                                                                        |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)                   | [toString](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#toString())`()` Returns a string representation of the object.                                                                                                                                                                                                                |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)                       | [writeToParcel](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#writeToParcel(android.os.Parcel,%20kotlin.Int))`(`dest:` `[Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#)`, `flags:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Flatten this object in to a Parcel. |

|                                                                                                                                                                       Properties                                                                                                                                                                       ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| static[Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#)!\> | [CREATOR](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#CREATOR:android.os.Parcelable.Creator) <br /> |

## Constants

### EXTENDED_ADDRESS_BYTE_LENGTH

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val EXTENDED_ADDRESS_BYTE_LENGTH: Int
```  

    Value: 8

### SHORT_ADDRESS_BYTE_LENGTH

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val SHORT_ADDRESS_BYTE_LENGTH: Int
```  

    Value: 2

## Public methods

### createRandomShortAddress

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static fun createRandomShortAddress(): UwbAddress
```

Generates a new random 2 bytes[UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#).

|                                                                                                                     Return                                                                                                                      ||
|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| [UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#) | a new randomly generated[UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#). This value cannot be`null`. |

### describeContents

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun describeContents(): Int
```

|                                                                                                                                                                               Return                                                                                                                                                                               ||
|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) |

### equals

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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` | This value may be`null`. |

|                                                                           Return                                                                           ||
|------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. |

### fromBytes

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static fun fromBytes(address: ByteArray): UwbAddress
```

Create a[android.uwb.UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#)from a byte array.

If the provided array is[SHORT_ADDRESS_BYTE_LENGTH](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#SHORT_ADDRESS_BYTE_LENGTH:kotlin.Int)bytes, a short address is created. If the provided array is[EXTENDED_ADDRESS_BYTE_LENGTH](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#EXTENDED_ADDRESS_BYTE_LENGTH:kotlin.Int)bytes, then an extended address is created.

|                                                                                                                             Parameters                                                                                                                             ||
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `address` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html):a byte array to convert to a[android.uwb.UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#)This value cannot be`null`. |

|                                                                                                                                Return                                                                                                                                ||
|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#) | a[android.uwb.UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#)created from the input byte array This value cannot be`null`. |

|                                                                                                                                                                                   Exceptions                                                                                                                                                                                   ||
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java.lang.IllegalArgumentException` | when the length is not one of[SHORT_ADDRESS_BYTE_LENGTH](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#SHORT_ADDRESS_BYTE_LENGTH:kotlin.Int)or[EXTENDED_ADDRESS_BYTE_LENGTH](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#EXTENDED_ADDRESS_BYTE_LENGTH:kotlin.Int)bytes |

### getAddressBytes

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getAddressBytes(): ByteArray
```

Get the address as a byte array

|                                                                                                                           Return                                                                                                                            ||
|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html) | the byte representation of this[android.uwb.UwbAddress](https://developer.android.com/reference/kotlin/android/ranging/uwb/UwbAddress#)This value cannot be`null`. |

### hashCode

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun hashCode(): Int
```

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |

### toString

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun toString(): String
```

Returns a string representation of the object.

|                                                    Return                                                     ||
|----------------------------------------------------------------------------------|-----------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | This value cannot be`null`. |

### writeToParcel

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit
```

Flatten this object in to a Parcel.

|                                                                                                                                                                                                                                                                                     Parameters                                                                                                                                                                                                                                                                                     ||
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest`  | [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#):This value cannot be`null`.                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Additional flags about how the object should be written. May be 0 or[PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int). Value is either`0`or a combination of[android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |

## Properties

### CREATOR

Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val CREATOR: Parcelable.Creator<UwbAddress!>
```