Package org.apache.maven.search.api.support

Class SearchResponseSupport

java.lang.Object

org.apache.maven.search.api.support.SearchResponseSupport

All Implemented Interfaces:

SearchResponse

public abstract class SearchResponseSupport
extends Object
implements SearchResponse

A search response support class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Record>	page
protected final SearchRequest	searchRequest
protected final int	totalHits

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchResponseSupport(SearchRequest searchRequest, int totalHits, List<Record> page)

Method Summary

Modifier and Type	Method	Description
int	getCurrentHits()	Returns the count of current hits in current "page".
List<Record>	getPage()	Returns current "page" of results as list of records, never null.
SearchRequest	getSearchRequest()	Returns the SearchRequest used for this response, never null.
int	getTotalHits()	Returns the total count of hits produced by SearchResponse.getSearchRequest().
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

searchRequest

protected final SearchRequest searchRequest

totalHits

protected final int totalHits

page

protected final List<Record> page

Constructor Details

SearchResponseSupport

protected SearchResponseSupport(SearchRequest searchRequest,
 int totalHits,
 List<Record> page)

Method Details

getSearchRequest

public SearchRequest getSearchRequest()

Description copied from interface: SearchResponse

Returns the SearchRequest used for this response, never null.

Specified by:

getSearchRequest in interface SearchResponse

getTotalHits

public int getTotalHits()

Description copied from interface: SearchResponse

Returns the total count of hits produced by SearchResponse.getSearchRequest().

Specified by:

getTotalHits in interface SearchResponse

getCurrentHits

public int getCurrentHits()

Description copied from interface: SearchResponse

Returns the count of current hits in current "page". It may be less or equal to page size of SearchRequest.getPaging().

Specified by:

getCurrentHits in interface SearchResponse

getPage

public List<Record> getPage()

Description copied from interface: SearchResponse

Returns current "page" of results as list of records, never null.

Specified by:

getPage in interface SearchResponse

toString

public String toString()

Overrides:

toString in class Object