SearchResult.MatchInfo.Builder


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 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 start and end of a submatch MatchRange corresponding to the given entry.

Inherited methods

Public constructors

Builder

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.

Public methods

build

Added in API level 31
public SearchResult.MatchInfo build ()

Constructs a new MatchInfo.

Returns
SearchResult.MatchInfo This value cannot be null.

setExactMatchRange

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.

setSnippetRange

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.

setSubmatchRange

Added in API level 33
public SearchResult.MatchInfo.Builder setSubmatchRange (SearchResult.MatchRange matchRange)

Sets the start and end of a 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.