java.lang.Object
- org.oxerr.commons.ws.rs.data.OffsetPageRequest

All Implemented Interfaces:

Serializable, org.springframework.data.domain.Pageable
```
public class OffsetPageRequest
extends Object
implements org.springframework.data.domain.Pageable, Serializable
```
Pageable implementation using limit-offset mode.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`private static int`	`DEFAULT_LIMIT`
`private static String`	`DEFAULT_LIMIT_STRING`
`private static int`	`DEFAULT_MAX_LIMIT`
`private static String`	`DEFAULT_PROPERTY_DELIMITER`
`private int`	`limit`
`private int`	`maxLimit`
`private long`	`offset`
`private String`	`propertyDelimiter`
`private static long`	`serialVersionUID`
`private org.springframework.data.domain.Sort`	`sort`

Constructor Summary

Constructors
Constructor	Description
`OffsetPageRequest()`
`OffsetPageRequest(int limit, long offset)`
`OffsetPageRequest(int limit, long offset, org.springframework.data.domain.Sort sort)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`check(int limit)`
`OffsetPageRequest`	`defaultSort(org.springframework.data.domain.Sort.Direction direction, String... properties)`
`boolean`	`equals(Object obj)`
`protected String`	`filterProperty(String property)`
`OffsetPageRequest`	`first()`
`protected int`	`getMaxLimit()`
`long`	`getOffset()`
`int`	`getPageNumber()`
`int`	`getPageSize()`
`protected String`	`getPropertyDelimiter()`
`org.springframework.data.domain.Sort`	`getSort()`
`int`	`hashCode()`
`boolean`	`hasPrevious()`
`OffsetPageRequest`	`next()`
`static OffsetPageRequest`	`of()`
`static OffsetPageRequest`	`of(int limit, long offset)`
`static OffsetPageRequest`	`of(int limit, long offset, org.springframework.data.domain.Sort sort)`
`protected Optional<org.springframework.data.domain.Sort.Direction>`	`parseDirection(String value)`
`protected List<org.springframework.data.domain.Sort.Order>`	`parseOrders(List<String> source)`
`protected org.springframework.data.domain.Sort`	`parseSort(List<String> sorts)`
`OffsetPageRequest`	`previous()`
`OffsetPageRequest`	`previousOrFirst()`
`void`	`setLimit(int limit)`	Sets limit.
`void`	`setOffset(long offset)`	Sets offset.
`void`	`setSort(List<String> sorts)`	Sets sorts.
`String`	`toString()`
`OffsetPageRequest`	`withPage(int pageNumber)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.domain.Pageable
getSortOr, isPaged, isUnpaged, toOptional

Field Detail

serialVersionUID
```
private static final long serialVersionUID
```
See Also:

Constant Field Values

DEFAULT_MAX_LIMIT
```
private static final int DEFAULT_MAX_LIMIT
```
See Also:

Constant Field Values

DEFAULT_LIMIT
```
private static final int DEFAULT_LIMIT
```
See Also:

Constant Field Values

DEFAULT_LIMIT_STRING

private static final String DEFAULT_LIMIT_STRING

See Also:: Constant Field Values

DEFAULT_PROPERTY_DELIMITER

private static final String DEFAULT_PROPERTY_DELIMITER

See Also:: Constant Field Values

maxLimit
```
private int maxLimit
```

propertyDelimiter
```
private String propertyDelimiter
```

limit
```
private int limit
```

offset
```
private long offset
```

sort

private org.springframework.data.domain.Sort sort

Constructor Detail

OffsetPageRequest
```
public OffsetPageRequest()
```

OffsetPageRequest

public OffsetPageRequest(int limit,
                         long offset)

OffsetPageRequest

public OffsetPageRequest(int limit,
                         long offset,
                         org.springframework.data.domain.Sort sort)

Method Detail

of
```
public static OffsetPageRequest of()
```

of

public static OffsetPageRequest of(int limit,
                                   long offset)

of

public static OffsetPageRequest of(int limit,
                                   long offset,
                                   org.springframework.data.domain.Sort sort)

defaultSort

public OffsetPageRequest defaultSort(org.springframework.data.domain.Sort.Direction direction,
                                     String... properties)

setLimit

@QueryParam("limit")
@DefaultValue("10")
public void setLimit(int limit)

Sets limit.

Parameters:: limit - the size of the page to be returned.

setOffset
```
@QueryParam("offset")
@DefaultValue("0")
public void setOffset(long offset)
```
Sets offset.

Parameters:

offset - number of records to be skipped from the result set.

setSort
```
@QueryParam("sort[]")
public void setSort(List<String> sorts)
```
Sets sorts.

Parameters:

sorts - the sorting strings. One sorting string is a comma separated string of property and direction, such as property,asc, property,desc.

getPageNumber
```
public int getPageNumber()
```
Specified by:

getPageNumber in interface org.springframework.data.domain.Pageable

getPageSize
```
public int getPageSize()
```
Specified by:

getPageSize in interface org.springframework.data.domain.Pageable

getOffset
```
public long getOffset()
```
Specified by:

getOffset in interface org.springframework.data.domain.Pageable

getSort
```
public org.springframework.data.domain.Sort getSort()
```
Specified by:

getSort in interface org.springframework.data.domain.Pageable

next
```
public OffsetPageRequest next()
```
Specified by:

next in interface org.springframework.data.domain.Pageable

previous
```
public OffsetPageRequest previous()
```

previousOrFirst
```
public OffsetPageRequest previousOrFirst()
```
Specified by:

previousOrFirst in interface org.springframework.data.domain.Pageable

first
```
public OffsetPageRequest first()
```
Specified by:

first in interface org.springframework.data.domain.Pageable

withPage
```
public OffsetPageRequest withPage(int pageNumber)
```
Specified by:

withPage in interface org.springframework.data.domain.Pageable

hasPrevious
```
public boolean hasPrevious()
```
Specified by:

hasPrevious in interface org.springframework.data.domain.Pageable

getMaxLimit
```
protected int getMaxLimit()
```

getPropertyDelimiter

protected String getPropertyDelimiter()

filterProperty

protected String filterProperty(String property)

parseDirection

protected Optional<org.springframework.data.domain.Sort.Direction> parseDirection(String value)

parseOrders

protected List<org.springframework.data.domain.Sort.Order> parseOrders(List<String> source)

parseSort

protected org.springframework.data.domain.Sort parseSort(List<String> sorts)

check
```
private void check(int limit)
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class OffsetPageRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.data.domain.Pageable

Field Detail

serialVersionUID

DEFAULT_MAX_LIMIT

DEFAULT_LIMIT

DEFAULT_LIMIT_STRING

DEFAULT_PROPERTY_DELIMITER

maxLimit

propertyDelimiter

limit

offset

sort

Constructor Detail

OffsetPageRequest

OffsetPageRequest

OffsetPageRequest

Method Detail

of

of

of

defaultSort

setLimit

setOffset

setSort

getPageNumber

getPageSize

getOffset

getSort

next

previous

previousOrFirst

first

withPage

hasPrevious

getMaxLimit

getPropertyDelimiter

filterProperty

parseDirection

parseOrders

parseSort

check

hashCode

equals

toString