SearchResult.MatchInfo.Builder

Kotlin |Java

public static final class SearchResult.MatchInfo.Builder
extends Object

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

Builder for MatchInfo objects.

Summary

Public constructors
`Builder(String propertyPath)` Creates a new `MatchInfo.Builder` reporting a match with the given property path.

Public methods
`SearchResult.MatchInfo`	`build()` Constructs a new `MatchInfo`.
`SearchResult.MatchInfo.Builder`	`setEmbeddingMatch(SearchResult.EmbeddingMatchInfo embeddingMatch)` Sets the `EmbeddingMatchInfo` corresponding to the given entry.
`SearchResult.MatchInfo.Builder`	`setExactMatchRange(SearchResult.MatchRange matchRange)` Sets the exact `MatchRange` corresponding to the given entry.
`SearchResult.MatchInfo.Builder`	`setSnippetRange(SearchResult.MatchRange matchRange)` Sets the snippet `MatchRange` corresponding to the given entry.
`SearchResult.MatchInfo.Builder`	`setSubmatchRange(SearchResult.MatchRange matchRange)` Sets the submatch `MatchRange` corresponding to the given entry.

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.

Added in API level 31

public Builder (String propertyPath)

Creates a new MatchInfo.Builder reporting a match with the given property path.

A property path is a dot-delimited sequence of property names indicating which property in the document these snippets correspond to.

Example properties: 'body', 'sender.name', 'sender.emailaddress', etc. For class example 1, this returns "subject".

Parameters
`propertyPath`	`String`: A dot-delimited sequence of property names indicating which property in the document these snippets correspond to. This value cannot be `null`.

Added in API level 31

public SearchResult.MatchInfo build ()

Constructs a new MatchInfo.

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

public SearchResult.MatchInfo.Builder setEmbeddingMatch (SearchResult.EmbeddingMatchInfo embeddingMatch)

Sets the EmbeddingMatchInfo corresponding to the given entry.

Parameters
`embeddingMatch`	`SearchResult.EmbeddingMatchInfo`: This value may be `null`.

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

Added in API level 31

public SearchResult.MatchInfo.Builder setExactMatchRange (SearchResult.MatchRange matchRange)

Sets the exact MatchRange corresponding to the given entry.

Parameters
`matchRange`	`SearchResult.MatchRange`: This value cannot be `null`.

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

Added in API level 31

public SearchResult.MatchInfo.Builder setSnippetRange (SearchResult.MatchRange matchRange)

Sets the snippet MatchRange corresponding to the given entry.

Parameters
`matchRange`	`SearchResult.MatchRange`: This value cannot be `null`.

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

public SearchResult.MatchInfo.Builder setSubmatchRange (SearchResult.MatchRange matchRange)

Sets the submatch MatchRange corresponding to the given entry.

Parameters
`matchRange`	`SearchResult.MatchRange`: This value cannot be `null`.

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