navigation-ux-ev-platform/com.mapbox.ev.client.domain.model/SearchOptions/Builder

Builder

class Builder(resultLimit: Int = DEFAULT_SEARCH_RESULT_LIMIT, searchRadius: Double = DEFAULT_SEARCH_RADIUS, searchResultRankings: MutableList<Predicate<EVStation>> = mutableListOf(), searchResultFilters: MutableList<Predicate<EVStation>> = mutableListOf(), targetPointForSearchSorting: Point? = null)

Constructors

Link copied to clipboard
constructor(resultLimit: Int = DEFAULT_SEARCH_RESULT_LIMIT, searchRadius: Double = DEFAULT_SEARCH_RADIUS, searchResultRankings: MutableList<Predicate<EVStation>> = mutableListOf(), searchResultFilters: MutableList<Predicate<EVStation>> = mutableListOf(), targetPointForSearchSorting: Point? = null)

Functions

Link copied to clipboard
Link copied to clipboard
fun clearSearchResultFilters(): SearchOptions.Builder

Removes all of the search result filters

Link copied to clipboard
fun clearSearchResultRankings(): SearchOptions.Builder

Clears all of the search result rankings.

Link copied to clipboard
fun withResultLimit(limit: Int): SearchOptions.Builder

The search results should contain no more than the quantity indicated

Link copied to clipboard
fun withSearchRadius(radius: Double): SearchOptions.Builder

Indicates the EV search radius.

Link copied to clipboard
fun withSearchResultFilter(filter: Predicate<EVStation>): SearchOptions.Builder

Adds a search result filter. Any EVStations that don't meet the criteria of the filter will be filtered out of the search results before they are returned to the caller.

Link copied to clipboard
fun withSearchResultFilters(filters: List<Predicate<EVStation>>): SearchOptions.Builder

Appends search result filters.

Link copied to clipboard
fun withSearchResultRanking(ranking: Predicate<EVStation>): SearchOptions.Builder

Appends a ranking to EV search results that when true will put the result ahead of results that return a value of false for the predicate.

Link copied to clipboard
fun withSearchResultRankings(rankings: List<Predicate<EVStation>>): SearchOptions.Builder

Replaces all search rankings with the rankings provided.

Link copied to clipboard
fun withTargetPointForSearchSorting(target: Point?): SearchOptions.Builder

If provided the search results will be sorted by the distance from the target point in ascending order.