SearchResult.MatchInfo.Builder

public static final class SearchResult.MatchInfo.Builder
extends Object

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


Builder for SearchResult.MatchInfo objects.

Summary

Public constructors

Builder(String propertyPath)

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

Public methods

SearchResult.MatchInfo build()

Constructs a new SearchResult.MatchInfo.

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

Sets the exact SearchResult.MatchRange corresponding to the given entry.

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

Sets the snippet SearchResult.MatchRange corresponding to the given entry.

Inherited methods

Public constructors

Builder

public Builder (String propertyPath)

Creates a new SearchResult.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 {@code dot-delimited sequence of property names indicating which property in the document these snippets correspond to.

Public methods

build

public SearchResult.MatchInfo build ()

Constructs a new SearchResult.MatchInfo.

Returns
SearchResult.MatchInfo

Throws
IllegalStateException if the builder has already been used

setExactMatchRange

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

Sets the exact SearchResult.MatchRange corresponding to the given entry.

Parameters
matchRange SearchResult.MatchRange

Returns
SearchResult.MatchInfo.Builder

Throws
IllegalStateException if the builder has already been used

setSnippetRange

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

Sets the snippet SearchResult.MatchRange corresponding to the given entry.

Parameters
matchRange SearchResult.MatchRange

Returns
SearchResult.MatchInfo.Builder

Throws
IllegalStateException if the builder has already been used