Package org.springframework.graphql.data.query

Class ScrollSubrange

java.lang.Object

org.springframework.graphql.data.pagination.Subrange<org.springframework.data.domain.ScrollPosition>

org.springframework.graphql.data.query.ScrollSubrange

public final class ScrollSubrange
extends Subrange<org.springframework.data.domain.ScrollPosition>

Container for parameters that limit result elements to a subrange including a relative ScrollPosition, number of elements, and direction.

For backward pagination, the offset of an OffsetScrollPosition is adjusted to point to the first item in the range by subtracting the count from it. Hence, for OffsetScrollPosition Subrange.forward() is always true.

Since:

1.2.0

Author:

Rossen Stoyanchev, Oliver Drotbohm

Constructor Summary

Constructors

Constructor	Description
ScrollSubrange(org.springframework.data.domain.ScrollPosition pos, Integer count, boolean forward)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of create(org.springframework.data.domain.ScrollPosition, java.lang.Integer, boolean), to be removed in 1.3.

Method Summary

Modifier and Type	Method	Description
static ScrollSubrange	create(org.springframework.data.domain.ScrollPosition position, Integer count, boolean forward)	Create a ScrollSubrange from the given inputs.

Methods inherited from class org.springframework.graphql.data.pagination.Subrange

count, forward, position

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScrollSubrange

@Deprecated(since="1.2.4",
            forRemoval=true)
public ScrollSubrange(@Nullable
 org.springframework.data.domain.ScrollPosition pos,
 @Nullable
 Integer count,
 boolean forward)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of create(org.springframework.data.domain.ScrollPosition, java.lang.Integer, boolean), to be removed in 1.3.

Public constructor.

Method Details

create

public static ScrollSubrange create(@Nullable
 org.springframework.data.domain.ScrollPosition position,
 @Nullable
 Integer count,
 boolean forward)

Create a ScrollSubrange from the given inputs.

Pagination with offset-based scrolling is always forward and inclusive of the referenced item. Therefore, an OffsetScrollPosition is adjusted as follows. For forward pagination, advanced by 1. For backward pagination, advanced back by the count, and switched to forward.

Parameters:

position - the reference position, or null if not specified

count - how many to return, or null if not specified

forward - whether scroll forward (true) or backward (false)

Returns:

the created instance

Since:

1.2.4