Package org.springframework.data.domain

Interface ScrollPosition

All Known Implementing Classes:

KeysetScrollPosition, OffsetScrollPosition

public interface ScrollPosition

Interface to specify a position within a total query result. Scroll positions are used to start scrolling from the beginning of a query result or to resume scrolling from a given position within the query result.

Since:

3.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ScrollPosition.Direction	Keyset scrolling direction.

Method Summary

Modifier and Type	Method	Description
static KeysetScrollPosition	backward(Map<String,?> keys)	Creates a new ScrollPosition from a key set scrolling backward.
static KeysetScrollPosition	forward(Map<String,?> keys)	Creates a new ScrollPosition from a key set scrolling forward.
boolean	isInitial()	Returns whether the current scroll position is the initial one.
static KeysetScrollPosition	keyset()	Creates a new initial ScrollPosition to start scrolling using keyset-queries.
static KeysetScrollPosition	of(Map<String,?> keys, ScrollPosition.Direction direction)	Creates a new ScrollPosition from a key set and ScrollPosition.Direction.
static OffsetScrollPosition	offset()	Creates a new initial ScrollPosition to start scrolling using offset / limit.
static OffsetScrollPosition	offset(long offset)	Creates a new ScrollPosition from an offset.

Method Details

isInitial

boolean isInitial()

Returns whether the current scroll position is the initial one.

Returns:

keyset

static KeysetScrollPosition keyset()

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

Returns:

will never be null.

offset

static OffsetScrollPosition offset()

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

Returns:

will never be null.

offset

static OffsetScrollPosition offset(long offset)

Creates a new ScrollPosition from an offset.

Parameters:

offset -

Returns:

a new OffsetScrollPosition with the given offset.

forward

static KeysetScrollPosition forward(Map<String,?> keys)

Creates a new ScrollPosition from a key set scrolling forward.

Parameters:

keys - must not be null.

Returns:

will never be null.

backward

static KeysetScrollPosition backward(Map<String,?> keys)

Creates a new ScrollPosition from a key set scrolling backward.

Parameters:

keys - must not be null.

Returns:

will never be null.

of

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

Creates a new ScrollPosition from a key set and ScrollPosition.Direction.

Parameters:

keys - must not be null.

direction - must not be null.

Returns:

will never be null.