Stopwatch.Builder

Artifact: androidx.appsearch:appsearch-builtin-types

Added in 1.1.0

Kotlin |Java

public final class Stopwatch.Builder

Builder for Stopwatch.

Summary

Protected fields
`long`	`mAccumulatedDurationMillis`
`List<String>`	`mAlternateNames`
`long`	`mBaseTimeMillis`
`long`	`mBaseTimeMillisInElapsedRealtime`
`int`	`mBootCount`
`long`	`mCreationTimestampMillis`
`String`	`mDescription`
`int`	`mDocumentScore`
`long`	`mDocumentTtlMillis`
`final String`	`mId`
`String`	`mImage`
`List<StopwatchLap>`	`mLaps`
`String`	`mName`
`final String`	`mNamespace`
`List<PotentialAction>`	`mPotentialActions`
`int`	`mStatus`
`String`	`mUrl`

Public constructors
`Builder(@NonNull Stopwatch stopwatch)` Constructor for `Stopwatch.Builder` with all the existing values.
`Builder(@NonNull String namespace, @NonNull String id)` Constructor for `Stopwatch.Builder`.

Public methods
`@NonNull T`	`addAlternateName(@NonNull String alternateName)` Adds an alias for the item.
`@NonNull T`	`@ExperimentalAppSearchApi addPotentialAction(@NonNull PotentialAction newPotentialAction)` Add a new action to the list of potential actions for this document.
`@NonNull Stopwatch`	`build()` Builds the `Stopwatch`.
`@NonNull Thing`	`build()` Builds a `Thing` object.
`@NonNull T`	`clearAlternateNames()` Clears the aliases, if any, for the item.
`@NonNull T`	`@ExperimentalAppSearchApi clearPotentialActions()` Clear all the potential actions for this document.
`@NonNull T`	`setAccumulatedDurationMillis(long accumulatedDurationMillis)` Sets the total duration in milliseconds accumulated by the `Stopwatch`.
`@NonNull T`	`setAlternateNames(@Nullable List<String> alternateNames)` Sets a list of aliases for the item.
`@NonNull T`	`setBaseTimeMillis( long baseTimeMillis, long baseTimeMillisInElapsedRealtime, int bootCount )` Sets the point in time that the `Stopwatch` counts up from.
`@NonNull T`	`setBaseTimeMillis( @NonNull Context context, long baseTimeMillis, long baseTimeMillisInElapsedRealtime )` Sets the point in time that the `Stopwatch` counts up from.
`@NonNull T`	`setCreationTimestampMillis(long creationTimestampMillis)` Sets the creation timestamp for the current AppSearch entity, in milliseconds using the `currentTimeMillis` time base.
`@NonNull T`	`setDescription(@Nullable String description)` Sets the description for the item.
`@NonNull T`	`setDocumentScore(int documentScore)` Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using `RANKING_STRATEGY_DOCUMENT_SCORE`.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
`@NonNull T`	`@ExperimentalAppSearchApi setImage(@Nullable String image)` Sets the URL for an image of the item.
`@NonNull T`	`setLaps(@NonNull List<StopwatchLap> laps)` Sets all the `StopwatchLap` instances.
`@NonNull T`	`setName(@Nullable String name)` Sets the name of the item.
`@NonNull T`	`@ExperimentalAppSearchApi setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)` Sets a list of potential actions for this document.
`@NonNull T`	`setStatus(int status)` Sets the current status.
`@NonNull T`	`setUrl(@Nullable String url)` Sets the deeplink URL of the item.

Protected fields

mAccumulatedDurationMillis

protected long mAccumulatedDurationMillis

mAlternateNames

protected List<String> mAlternateNames

mBaseTimeMillis

protected long mBaseTimeMillis

mBaseTimeMillisInElapsedRealtime

protected long mBaseTimeMillisInElapsedRealtime

mBootCount

protected int mBootCount

mCreationTimestampMillis

protected long mCreationTimestampMillis

mDescription

protected String mDescription

mDocumentScore

protected int mDocumentScore

mDocumentTtlMillis

protected long mDocumentTtlMillis

mId

protected final String mId

mImage

protected String mImage

mLaps

protected List<StopwatchLap> mLaps

mName

protected String mName

mNamespace

protected final String mNamespace

mPotentialActions

protected List<PotentialAction> mPotentialActions

mStatus

protected int mStatus

mUrl

protected String mUrl

Public constructors

Builder

Added in 1.1.0

public Builder(@NonNull Stopwatch stopwatch)

Constructor for Stopwatch.Builder with all the existing values.

Builder

Added in 1.1.0

public Builder(@NonNull String namespace, @NonNull String id)

Constructor for Stopwatch.Builder.

Parameters
`@NonNull String namespace`	Namespace for the Document. See `Document.Namespace`.
`@NonNull String id`	Unique identifier for the Document. See `Document.Id`.

Public methods

addAlternateName

Added in 1.1.0

public @NonNull T addAlternateName(@NonNull String alternateName)

Adds an alias for the item.

addPotentialAction

Added in 1.1.0

@ExperimentalAppSearchApi
public @NonNull T addPotentialAction(@NonNull PotentialAction newPotentialAction)

Add a new action to the list of potential actions for this document.

build

Added in 1.1.0

public @NonNull Stopwatch build()

Builds the Stopwatch.

build

Added in 1.1.0

public @NonNull Thing build()

Builds a Thing object.

clearAlternateNames

Added in 1.1.0

public @NonNull T clearAlternateNames()

Clears the aliases, if any, for the item.

clearPotentialActions

Added in 1.1.0

@ExperimentalAppSearchApi
public @NonNull T clearPotentialActions()

Clear all the potential actions for this document.

setAccumulatedDurationMillis

Added in 1.1.0

public @NonNull T setAccumulatedDurationMillis(long accumulatedDurationMillis)

Sets the total duration in milliseconds accumulated by the Stopwatch.

setAlternateNames

Added in 1.1.0

public @NonNull T setAlternateNames(@Nullable List<String> alternateNames)

Sets a list of aliases for the item.

setBaseTimeMillis

Added in 1.1.0

public @NonNull T setBaseTimeMillis(
    long baseTimeMillis,
    long baseTimeMillisInElapsedRealtime,
    int bootCount
)

Sets the point in time that the Stopwatch counts up from.

Base time should be sampled in both the currentTimeMillis and elapsedRealtime time base. In addition, the boot count of the device is needed to check if the elapsedRealtime time base is valid.

Parameters
`long baseTimeMillis`	The base time in milliseconds using the `currentTimeMillis` time base.
`long baseTimeMillisInElapsedRealtime`	The base time in milliseconds using the `elapsedRealtime` time base.
`int bootCount`	The current boot count of the device. See `BOOT_COUNT`.

setBaseTimeMillis

Added in 1.1.0

public @NonNull T setBaseTimeMillis(
    @NonNull Context context,
    long baseTimeMillis,
    long baseTimeMillisInElapsedRealtime
)

Sets the point in time that the Stopwatch counts up from.

See setBaseTimeMillis.

Parameters
`@NonNull Context context`	The app context used to fetch boot count.
`long baseTimeMillis`	The base time in milliseconds using the `currentTimeMillis` time base.
`long baseTimeMillisInElapsedRealtime`	The base time in milliseconds using the `elapsedRealtime` time base.

setCreationTimestampMillis

Added in 1.1.0

public @NonNull T setCreationTimestampMillis(long creationTimestampMillis)

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.

This timestamp refers to the creation time of the AppSearch entity, not when the document is written into AppSearch.

If not set, then the current timestamp will be used.

See androidx.appsearch.annotation.Document.CreationTimestampMillis for more information on creation timestamp.

setDescription

Added in 1.1.0

public @NonNull T setDescription(@Nullable String description)

Sets the description for the item.

setDocumentScore

Added in 1.1.0

public @NonNull T setDocumentScore(int documentScore)

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.

See androidx.appsearch.annotation.Document.Score for more information on score.

setDocumentTtlMillis

Added in 1.1.0

public @NonNull T setDocumentTtlMillis(long documentTtlMillis)

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.

The document will be automatically deleted when the TTL expires.

If not set, then the document will never expire.

See androidx.appsearch.annotation.Document.TtlMillis for more information on TTL.

setImage

Added in 1.1.0

@ExperimentalAppSearchApi
public @NonNull T setImage(@Nullable String image)

Sets the URL for an image of the item.

setLaps

Added in 1.1.0

public @NonNull T setLaps(@NonNull List<StopwatchLap> laps)

Sets all the StopwatchLap instances.

setName

Added in 1.1.0

public @NonNull T setName(@Nullable String name)

Sets the name of the item.

setPotentialActions

Added in 1.1.0

@ExperimentalAppSearchApi
public @NonNull T setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)

Sets a list of potential actions for this document.

setStatus

Added in 1.1.0

public @NonNull T setStatus(int status)

Sets the current status.

Status can be STATUS_UNKNOWN, STATUS_RESET, STATUS_RUNNING, or STATUS_PAUSED.

setUrl

Added in 1.1.0

public @NonNull T setUrl(@Nullable String url)

Sets the deeplink URL of the item.

If this item can be displayed by any system UI surface, or can be read by another Android package, through one of the androidx.appsearch.app.SetSchemaRequest.Builder methods, this url should act as a deeplink into the activity that can open it. Callers should be able to construct an ACTION_VIEW intent with the url as the setData to view the item inside your application.

See Allowing Other Apps to Start Your Activity for more details on how to make activities in your app open for use by other apps by defining intent filters.