Package org.springframework.data.domain

Class KeysetScrollPosition

java.lang.Object

org.springframework.data.domain.KeysetScrollPosition

All Implemented Interfaces:

ScrollPosition

public final class KeysetScrollPosition
extends Object
implements ScrollPosition

A ScrollPosition based on the last seen key set. Keyset scrolling must be associated with a well-defined sort to be able to extract the key set when resuming scrolling within the sorted result set.

Since:

3.1

Author:

Mark Paluch, Oliver Drotbohm

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.domain.ScrollPosition

ScrollPosition.Direction

Method Summary

Modifier and Type	Method	Description
KeysetScrollPosition	backward()	Returns a KeysetScrollPosition based on the same keyset and scrolling backward.
boolean	equals(Object o)
KeysetScrollPosition	forward()	Returns a KeysetScrollPosition based on the same keyset and scrolling forward.
ScrollPosition.Direction	getDirection()
Map<String,Object>	getKeys()
int	hashCode()
boolean	isInitial()	Returns whether the current scroll position is the initial one.
KeysetScrollPosition	reverse()	Returns a new KeysetScrollPosition with the direction reversed.
boolean	scrollsBackward()	Returns whether the current KeysetScrollPosition scrolls backward.
boolean	scrollsForward()	Returns whether the current KeysetScrollPosition scrolls forward.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getKeys

public Map<String,Object> getKeys()

Returns:

the keyset.

getDirection

public ScrollPosition.Direction getDirection()

Returns:

the scroll direction.

scrollsForward

public boolean scrollsForward()

Returns whether the current KeysetScrollPosition scrolls forward.

Returns:

whether the current KeysetScrollPosition scrolls forward.

scrollsBackward

public boolean scrollsBackward()

Returns whether the current KeysetScrollPosition scrolls backward.

Returns:

whether the current KeysetScrollPosition scrolls backward.

forward

public KeysetScrollPosition forward()

Returns a KeysetScrollPosition based on the same keyset and scrolling forward.

Returns:

will never be null.

backward

public KeysetScrollPosition backward()

Returns a KeysetScrollPosition based on the same keyset and scrolling backward.

Returns:

will never be null.

reverse

public KeysetScrollPosition reverse()

Returns a new KeysetScrollPosition with the direction reversed.

Returns:

will never be null.

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:

equals

public boolean equals(@Nullable
 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