Package org.apache.maven.search.api

Class SearchRequest

java.lang.Object

org.apache.maven.search.api.SearchRequest

public class SearchRequest
extends Object

A search request to perform search: defines paging and query.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Paging	paging
protected final Query	query

Constructor Summary

Constructors

Constructor	Description
SearchRequest(Paging paging, Query query)	Creates a request with given Query and Paging.
SearchRequest(Query query)	Creates a request with given Query instance and default page size of 50.

Method Summary

Modifier and Type	Method	Description
Paging	getPaging()	The Paging of this request: defines page size and page offset, never null.
Query	getQuery()	The Query of this request, never null.
SearchRequest	nextPage()	Returns a new SearchRequest instance for "next page" relative to this instance, never null.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

paging

protected final Paging paging

query

protected final Query query

Constructor Details

SearchRequest

public SearchRequest(Query query)

Creates a request with given Query instance and default page size of 50.

SearchRequest

public SearchRequest(Paging paging,
 Query query)

Creates a request with given Query and Paging.

Method Details

getPaging

public Paging getPaging()

The Paging of this request: defines page size and page offset, never null.

getQuery

public Query getQuery()

The Query of this request, never null.

nextPage

public SearchRequest nextPage()

Returns a new SearchRequest instance for "next page" relative to this instance, never null.

toString

public String toString()

Overrides:

toString in class Object