SearchResult.Builder

Kotlin |Java

public final class SearchResult.Builder

Builder for SearchResult objects.

Summary

Public constructors
`Builder(@NonNull String packageName, @NonNull String databaseName)` Constructs a new builder for `SearchResult` objects.

Public methods
`@NonNull SearchResult.Builder`	`addInformationalRankingSignal(double rankingSignal)` Adds the informational ranking signal of the matched document in this SearchResult.
`@NonNull SearchResult.Builder`	`addJoinedResult(@NonNull SearchResult joinedResult)` Adds a `SearchResult` that was joined by the `JoinSpec`.
`@NonNull SearchResult.Builder`	`addMatchInfo(@NonNull SearchResult.MatchInfo matchInfo)` Adds another match to this SearchResult.
`@NonNull SearchResult`	`build()` Constructs a new `SearchResult`.
`@NonNull SearchResult.Builder`	`setDocument(@NonNull Object document)` Sets the document which matched.
`@NonNull SearchResult.Builder`	`setGenericDocument(@NonNull GenericDocument document)` Sets the document which matched.
`@NonNull SearchResult.Builder`	`setRankingSignal(double rankingSignal)` Sets the ranking signal of the matched document in this SearchResult.

public Builder(@NonNull String packageName, @NonNull String databaseName)

Constructs a new builder for SearchResult objects.

Parameters
`@NonNull String packageName`	the package name the matched document belongs to
`@NonNull String databaseName`	the database name the matched document belongs to.

public @NonNull SearchResult.Builder addInformationalRankingSignal(double rankingSignal)

Adds the informational ranking signal of the matched document in this SearchResult.

public @NonNull SearchResult.Builder addJoinedResult(@NonNull SearchResult joinedResult)

Adds a SearchResult that was joined by the JoinSpec.

Parameters
`@NonNull SearchResult joinedResult`	The joined SearchResult to add.

public @NonNull SearchResult.Builder addMatchInfo(@NonNull SearchResult.MatchInfo matchInfo)

Adds another match to this SearchResult.

public @NonNull SearchResult build()

Constructs a new SearchResult.

public @NonNull SearchResult.Builder setDocument(@NonNull Object document)

Sets the document which matched.

Parameters
`@NonNull Object document`	An instance of a class annotated with `androidx.appsearch.annotation.Document`.

Throws
`androidx.appsearch.exceptions.AppSearchException`	if an error occurs converting a document class into a `GenericDocument`.

public @NonNull SearchResult.Builder setGenericDocument(@NonNull GenericDocument document)

Sets the document which matched.

public @NonNull SearchResult.Builder setRankingSignal(double rankingSignal)

Sets the ranking signal of the matched document in this SearchResult.