Badge.Builder

public final class Badge.Builder

A builder of Badge.

Summary

Public constructors

Returns an empty Builder instance.

Public methods
@NonNull Badge

Constructs the Badge defined by this builder.
@NonNull Badge.Builder

Sets the color of the dot to the given backgroundColor.
@NonNull Badge.Builder
setHasDot(boolean hasDot)

Enables a circular dot that denotes some sort of alert, notification, etc.
@NonNull Badge.Builder

Sets an icon to be displayed as a badge.

Public constructors

Builder

Added in 1.4.0
public Builder()

Returns an empty Builder instance.

Public methods

build

Added in 1.4.0
public @NonNull Badge build()

Constructs the Badge defined by this builder.

Throws
java.lang.IllegalStateException

if the badge doesn't have a dot or an icon.

setBackgroundColor

Added in 1.4.0
public @NonNull Badge.Builder setBackgroundColor(@NonNull CarColor backgroundColor)

Sets the color of the dot to the given backgroundColor.

setHasDot

Added in 1.4.0
public @NonNull Badge.Builder setHasDot(boolean hasDot)

Enables a circular dot that denotes some sort of alert, notification, etc.

setIcon

Added in 1.4.0
public @NonNull Badge.Builder setIcon(@NonNull CarIcon icon)

Sets an icon to be displayed as a badge.

An icon badge gives context about the associated element on which it is displayed. For example, a work profile icon badge is displayed with an app icon to indicate that it is a work app.