io.sphere.sdk.queries

Class PagedResultBase<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.queries.PagedResultBase<T>

All Implemented Interfaces:

PagedResult<T>

Direct Known Subclasses:

PagedQueryResultDsl

public abstract class PagedResultBase<T>
extends Base
implements PagedResult<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	count
protected Long	limit
protected Long	offset
protected List<T>	results
protected Long	total

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PagedResultBase(Long offset, Long limit, Long total, List<T> results, Long count)

Method Summary

Modifier and Type	Method and Description
Long	getCount() The actual number of results returned.
Long	getLimit() The limit supplied by the client or the server default.
Long	getOffset() The offset supplied by the client or the server default.
List<T>	getResults() List of results.
Long	getTotal() The total number of results matching the request.
Long	size() Deprecated. use getCount() instead

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.queries.PagedResult

getPageIndex, getTotalPages, head, isFirst, isLast

Field Detail

offset

protected final Long offset

limit

protected final Long limit

total

protected final Long total

results

protected final List<T> results

count

protected final Long count

Constructor Detail

PagedResultBase

protected PagedResultBase(Long offset,
                          Long limit,
                          Long total,
                          List<T> results,
                          Long count)

Method Detail

getOffset

public Long getOffset()

The offset supplied by the client or the server default.

Specified by:

getOffset in interface PagedResult<T>

Returns:

the amount of items (not pages) skipped

getLimit

public Long getLimit()

The limit supplied by the client or the server default.

Specified by:

getLimit in interface PagedResult<T>

Returns:

the maximum amount of items allowed to be included in the results

size

@Deprecated
public Long size()

Deprecated. use getCount() instead

The actual number of results returned.

Specified by:

size in interface PagedResult<T>

Returns:

the number of elements in this container

getCount

public Long getCount()

The actual number of results returned.

Specified by:

getCount in interface PagedResult<T>

Returns:

the number of elements in this container

getTotal

public Long getTotal()

The total number of results matching the request. Total is greater or equal to count.

Specified by:

getTotal in interface PagedResult<T>

Returns:

the number of elements that can be fetched matching the criteria

getResults

public List<T> getResults()

List of results. If getCount() is not equal to getTotal() the container contains only a subset of all elements that match the request.

Specified by:

getResults in interface PagedResult<T>

Returns:

getCount() elements matching the request