Destination.Builder

class Destination.Builder

A builder of Destination.

Summary

Public constructors

Returns an empty Builder instance.

Public functions
Destination

Constructs the Destination defined by this builder.
Destination.Builder

Sets the destination address formatted for the user's current locale.
Destination.Builder
setImage(image: CarIcon)

Sets the destination image to display.
Destination.Builder

Sets the destination name formatted for the user's current locale.

Public constructors

Builder

Added in 1.0.0
Builder()

Returns an empty Builder instance.

Public functions

build

Added in 1.0.0
fun build(): Destination

Constructs the Destination defined by this builder.

At least one of the name or the address must be set and not empty.

Throws
java.lang.IllegalStateException

if both the name and the address are null or empty.
See also
setName
setAddress

setAddress

Added in 1.0.0
fun setAddress(address: CharSequence): Destination.Builder

Sets the destination address formatted for the user's current locale.

Spans are not supported in the input string and will be ignored.

Throws
java.lang.NullPointerException

if address is null
See also
CarText

setImage

Added in 1.0.0
fun setImage(image: CarIcon): Destination.Builder

Sets the destination image to display.

Image Sizing Guidance To minimize scaling artifacts across a wide range of car screens, apps should provide images targeting a 128 x 128 dp bounding box. If the image exceeds this maximum size in either one of the dimensions, it will be scaled down to be centered inside the bounding box while preserving the aspect ratio.

See CarIcon for more details related to providing icon and image resources that work with different car screen pixel densities.

Throws
java.lang.NullPointerException

if image is null

setName

Added in 1.0.0
fun setName(name: CharSequence): Destination.Builder

Sets the destination name formatted for the user's current locale.

Spans are not supported in the input string and will be ignored.

Throws
java.lang.NullPointerException

if name is null
See also
CarText