Package com.atlassian.confluence.api.model.pagination

Class LimitedRequestImpl

java.lang.Object

com.atlassian.confluence.api.model.pagination.LimitedRequestImpl

All Implemented Interfaces:

LimitedRequest, SkipDiscardLimitedRequest

@ExperimentalApi
public class LimitedRequestImpl
extends Object
implements SkipDiscardLimitedRequest

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LimitedRequestImpl(int start, int limit, int maxLimit)
protected	LimitedRequestImpl(int start, int limit, int needed, int maxLimit)
protected	LimitedRequestImpl(int start, int limit, int needed, int maxLimit, boolean shouldSkipDiscardingThreshold)
protected	LimitedRequestImpl(int start, Cursor cursor, int limit, int needed, int maxLimit, boolean shouldSkipDiscardingThreshold)
protected	LimitedRequestImpl(PageRequest request, int maxLimit)

Method Summary

Modifier and Type	Method	Description
static LimitedRequest	create(int maxLimit)
static LimitedRequest	create(int start, int limit, int maxLimit)
static LimitedRequest	create(int start, int limit, int maxLimit, boolean shouldSkipDiscardingThreshold)
static LimitedRequest	create(Cursor cursor, int limit, int maxLimit)
static LimitedRequest	create(PageRequest request, int maxLimit)
boolean	equals(Object obj)
Cursor	getCursor()
int	getLimit()
int	getMaxLimit()
int	getNeeded()	Deprecated. since 5.7.2.
int	getStart()
int	hashCode()
boolean	shouldSkipDiscardingThreshold()	Return whether PaginationServiceImpl should skip DiscardingThreshold by set it threshold to 0
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitedRequestImpl

protected LimitedRequestImpl(PageRequest request,
                             int maxLimit)

LimitedRequestImpl

protected LimitedRequestImpl(int start,
                             int limit,
                             int maxLimit)

LimitedRequestImpl

protected LimitedRequestImpl(int start,
                             int limit,
                             int needed,
                             int maxLimit)

LimitedRequestImpl

protected LimitedRequestImpl(int start,
                             int limit,
                             int needed,
                             int maxLimit,
                             boolean shouldSkipDiscardingThreshold)

LimitedRequestImpl

protected LimitedRequestImpl(int start,
                             Cursor cursor,
                             int limit,
                             int needed,
                             int maxLimit,
                             boolean shouldSkipDiscardingThreshold)

Method Detail

create

public static LimitedRequest create(PageRequest request,
                                    int maxLimit)

create

public static LimitedRequest create(int maxLimit)

create

public static LimitedRequest create(int start,
                                    int limit,
                                    int maxLimit)

create

public static LimitedRequest create(int start,
                                    int limit,
                                    int maxLimit,
                                    boolean shouldSkipDiscardingThreshold)

create

public static LimitedRequest create(Cursor cursor,
                                    int limit,
                                    int maxLimit)

getNeeded

@Deprecated
public int getNeeded()

Deprecated.

since 5.7.2. No longer used.

Specified by:

getNeeded in interface LimitedRequest

Returns:

the number of results needed to return to fulfill this request, may exceed getLimit

getStart

public int getStart()

Specified by:

getStart in interface LimitedRequest

Returns:

zero-based start index for the page of results (first result is 0)

getLimit

public int getLimit()

Specified by:

getLimit in interface LimitedRequest

Returns:

the maximum results to fetch to attempt to fulfil the request

getMaxLimit

public int getMaxLimit()

Specified by:

getMaxLimit in interface LimitedRequest

Returns:

the maximum limit for this request

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

shouldSkipDiscardingThreshold

public boolean shouldSkipDiscardingThreshold()

Description copied from interface: SkipDiscardLimitedRequest

Return whether PaginationServiceImpl should skip DiscardingThreshold by set it threshold to 0

Specified by:

shouldSkipDiscardingThreshold in interface SkipDiscardLimitedRequest

Returns:

getCursor

public Cursor getCursor()

Specified by:

getCursor in interface LimitedRequest

Returns:

the identifier which is used to skip results from a previous query when paginating.