Package org.hansken.plugin.extraction.api

Class SearchOptions.Builder

java.lang.Object

org.hansken.plugin.extraction.api.SearchOptions.Builder

Enclosing class:

SearchOptions

public static class SearchOptions.Builder
extends Object

Builder for creating SearchOptions instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchOptions	build()	Builds a new SearchOptions instance with the configured values.
SearchOptions.Builder	offset(int start)	Sets the starting offset for the search results.
SearchOptions.Builder	scope(SearchScope scope)	Sets the search scope.
SearchOptions.Builder	sort(List<SearchSortOption> sort)	Sets the sort options for the search results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

scope

public SearchOptions.Builder scope(SearchScope scope)

Sets the search scope.

Parameters:

scope - the SearchScope where the search should be performed.

Returns:

this builder instance for chaining.

offset

public SearchOptions.Builder offset(int start)

Sets the starting offset for the search results.

Parameters:

start - the start offset.

Returns:

this builder instance for chaining.

sort

public SearchOptions.Builder sort(List<SearchSortOption> sort)

Sets the sort options for the search results.

Parameters:

sort - the list of SearchSortOption.

Returns:

this builder instance for chaining.

build

public SearchOptions build()

Builds a new SearchOptions instance with the configured values.

Returns:

a new SearchOptions.