# Print output for @column tags ?> SearchResult.MatchInfo.Builder - Android SDK | Android Developers

Most visited

Recently visited

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.

Inherited methods

Public constructors

Builder

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 {@code dot-delimited sequence of property names indicating which property in the document these snippets correspond to. This value cannot be {@code null}.

Public methods

build

public SearchResult.MatchInfo build ()

Constructs a new MatchInfo.

Returns
SearchResult.MatchInfo This value cannot be null.

setExactMatchRange

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

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.