Package org.springframework.data.domain

Class OffsetScrollPosition

java.lang.Object

org.springframework.data.domain.OffsetScrollPosition

All Implemented Interfaces:

ScrollPosition

public final class OffsetScrollPosition
extends Object
implements ScrollPosition

A ScrollPosition based on the offsets within query results.

Since:

3.1

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
long	getOffset()
int	hashCode()
static OffsetScrollPosition	initial()	Creates a new initial OffsetScrollPosition to start scrolling using offset/limit.
boolean	isInitial()	Returns whether the current scroll position is the initial one.
static OffsetScrollPosition	of(long offset)	Creates a new OffsetScrollPosition from an offset.
static IntFunction<OffsetScrollPosition>	positionFunction(long startOffset)	Returns the position function to calculate.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

initial

public static OffsetScrollPosition initial()

Creates a new initial OffsetScrollPosition to start scrolling using offset/limit.

Returns:

a new initial OffsetScrollPosition to start scrolling using offset/limit.

of

public static OffsetScrollPosition of(long offset)

Creates a new OffsetScrollPosition from an offset.

Parameters:

offset -

Returns:

a new OffsetScrollPosition with the given offset.

positionFunction

public static IntFunction<OffsetScrollPosition> positionFunction(long startOffset)

Returns the position function to calculate.

Parameters:

startOffset - the start offset to be used. Must not be negative.

Returns:

the offset-based position function.

isInitial

public boolean isInitial()

Description copied from interface: ScrollPosition

Returns whether the current scroll position is the initial one.

Specified by:

isInitial in interface ScrollPosition

Returns:

getOffset

public long getOffset()

Returns:

the offset.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object