Added in API level 31

Summary: Ctors | Methods | Inherited Methods

SearchResult.Builder

Kotlin |Java

public static final class SearchResult.Builder
extends Object

java.lang.Object
↳	android.app.appsearch.SearchResult.Builder

Builder for SearchResult objects.

Summary

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

Public methods
`SearchResult.Builder`	`addInformationalRankingSignal(double rankingSignal)` Adds the informational ranking signal of the matched document in this SearchResult.
`SearchResult.Builder`	`addJoinedResult(SearchResult joinedResult)` Adds a `SearchResult` that was joined by the `JoinSpec`.
`SearchResult.Builder`	`addMatchInfo(SearchResult.MatchInfo matchInfo)` Adds another match to this SearchResult.
`SearchResult`	`build()` Constructs a new `SearchResult`.
`SearchResult.Builder`	`setGenericDocument(GenericDocument document)` Sets the document which matched.
`SearchResult.Builder`	`setParentTypeMap(Map<String, List<String>> parentTypeMap)` Sets the map from schema type names to the list of their parent types.
`SearchResult.Builder`	`setRankingSignal(double rankingSignal)` Sets the ranking signal of the matched document in this SearchResult.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 31

public Builder (String packageName, 
                String databaseName)

Constructs a new builder for SearchResult objects.

Parameters
`packageName`	`String`: the package name the matched document belongs to This value cannot be `null`.
`databaseName`	`String`: the database name the matched document belongs to. This value cannot be `null`.

Public methods

addInformationalRankingSignal

Added in T Extensions 16

public SearchResult.Builder addInformationalRankingSignal (double rankingSignal)

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

Parameters
`rankingSignal`	`double`

Returns
`SearchResult.Builder`	This value cannot be `null`.

addJoinedResult

Added in API level 34
Also in T Extensions 7

public SearchResult.Builder addJoinedResult (SearchResult joinedResult)

Adds a SearchResult that was joined by the JoinSpec.

Parameters
`joinedResult`	`SearchResult`: The joined SearchResult to add. This value cannot be `null`.

Returns
`SearchResult.Builder`	This value cannot be `null`.

addMatchInfo

Added in API level 31

public SearchResult.Builder addMatchInfo (SearchResult.MatchInfo matchInfo)

Adds another match to this SearchResult.

Parameters
`matchInfo`	`SearchResult.MatchInfo`: This value cannot be `null`.

Returns
`SearchResult.Builder`	This value cannot be `null`.

build

Added in API level 31

public SearchResult build ()

Constructs a new SearchResult.

Returns
`SearchResult`	This value cannot be `null`.

setGenericDocument

Added in API level 31

public SearchResult.Builder setGenericDocument (GenericDocument document)

Sets the document which matched.

Parameters
`document`	`GenericDocument`: This value cannot be `null`.

Returns
`SearchResult.Builder`	This value cannot be `null`.

setParentTypeMap

Added in Android Baklava

public SearchResult.Builder setParentTypeMap (Map<String, List<String>> parentTypeMap)

Sets the map from schema type names to the list of their parent types.

The map should include entries for the GenericDocument's own type and all of the nested documents' types.

Child types must appear before parent types in each list. Otherwise, the GenericDocument's toDocumentClass method (an AndroidX-only API) may not correctly identify the most concrete type. This could lead to unintended deserialization into a more general type instead of a more specific type.

Parent types should include transitive parents.

Parameters
`parentTypeMap`	`Map`: This value cannot be `null`.

Returns
`SearchResult.Builder`	This value cannot be `null`.

setRankingSignal

Added in API level 31

public SearchResult.Builder setRankingSignal (double rankingSignal)

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

Parameters
`rankingSignal`	`double`

Returns
`SearchResult.Builder`	This value cannot be `null`.