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 keyset. Keyset scrolling must be associated with a well-defined sort to be able to extract the keyset when resuming scrolling within the sorted result set.

Since:

3.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KeysetScrollPosition.Direction	Keyset scrolling direction.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
KeysetScrollPosition.Direction	getDirection()
Map<String,Object>	getKeys()
int	hashCode()
static KeysetScrollPosition	initial()	Creates a new initial KeysetScrollPosition to start scrolling using keyset-queries.
boolean	isInitial()	Returns whether the current scroll position is the initial one.
static KeysetScrollPosition	of(Map<String,?> keys)	Creates a new KeysetScrollPosition from a keyset.
static KeysetScrollPosition	of(Map<String,?> keys, KeysetScrollPosition.Direction direction)	Creates a new KeysetScrollPosition from a keyset and KeysetScrollPosition.Direction.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

initial

public static KeysetScrollPosition initial()

Creates a new initial KeysetScrollPosition to start scrolling using keyset-queries.

Returns:

a new initial KeysetScrollPosition to start scrolling using keyset-queries.

of

public static KeysetScrollPosition of(Map<String,?> keys)

Creates a new KeysetScrollPosition from a keyset.

Parameters:

keys - must not be null.

Returns:

a new KeysetScrollPosition for the given keyset.

of

public static KeysetScrollPosition of(Map<String,?> keys,
 KeysetScrollPosition.Direction direction)

Creates a new KeysetScrollPosition from a keyset and KeysetScrollPosition.Direction.

Parameters:

keys - must not be null.

direction - must not be null.

Returns:

a new KeysetScrollPosition for the given keyset and KeysetScrollPosition.Direction.

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:

getKeys

public Map<String,Object> getKeys()

Returns:

the keyset.

getDirection

public KeysetScrollPosition.Direction getDirection()

Returns:

the scroll direction.

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