Package net.solarnetwork.central.support

Class BasicFilterResults<T>

java.lang.Object

net.solarnetwork.central.support.BasicFilterResults<T>

Record Components:

T - the result type

All Implemented Interfaces:

Iterable<T>, FilterResults<T>

public class BasicFilterResults<T>
extends Object
implements FilterResults<T>

Basic implementation of FilterResults.

Constructor Summary

Constructors

Constructor	Description
BasicFilterResults(Iterable<T> results)
BasicFilterResults(Iterable<T> results, Long totalResults, Integer startingOffset, Integer returnedResultCount)

Method Summary

Modifier and Type	Method	Description
Iterable<T>	getResults()	Get the actual results.
Integer	getReturnedResultCount()	Get the number of results that matched the query.
Integer	getStartingOffset()	Get the starting offset of the returned results.
Long	getTotalResults()	If available, a total number of results.
Iterator<T>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

BasicFilterResults

public BasicFilterResults(Iterable<T> results,
 Long totalResults,
 Integer startingOffset,
 Integer returnedResultCount)

BasicFilterResults

public BasicFilterResults(Iterable<T> results)

Method Details

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

getResults

public Iterable<T> getResults()

Description copied from interface: FilterResults

Get the actual results.

These are the same results returned by Iterable.iterator().

Specified by:

getResults in interface FilterResults<T>

Returns:

the results, never null

getTotalResults

public Long getTotalResults()

Description copied from interface: FilterResults

If available, a total number of results.

Specified by:

getTotalResults in interface FilterResults<T>

Returns:

total results

getStartingOffset

public Integer getStartingOffset()

Description copied from interface: FilterResults

Get the starting offset of the returned results.

Specified by:

getStartingOffset in interface FilterResults<T>

Returns:

the starting offset, never null

getReturnedResultCount

public Integer getReturnedResultCount()

Description copied from interface: FilterResults

Get the number of results that matched the query.

Specified by:

getReturnedResultCount in interface FilterResults<T>

Returns:

the number of returned results, never null