Accept PagingState when creating CassandraScrollPosition and in Query.pagingState.

Closes #1585

Author: mp911de

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/query/CassandraScrollPosition.java

@@ -18,19 +18,20 @@
 import java.nio.ByteBuffer;
 
 import org.springframework.data.cassandra.core.query.CassandraScrollPosition.Initial;
-import org.springframework.data.cassandra.core.query.CassandraScrollPosition.PagingState;
+import org.springframework.data.cassandra.core.query.CassandraScrollPosition.PagingScrollPosition;
 import org.springframework.data.domain.ScrollPosition;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 
+import com.datastax.oss.driver.api.core.cql.PagingState;
+
 /**
- * Cassandra-specific implementation of {@link ScrollPosition} using
- * {@link com.datastax.oss.driver.api.core.cql.PagingState}.
+ * Cassandra-specific implementation of {@link ScrollPosition} using {@link PagingState}.
  *
  * @author Mark Paluch
  * @since 4.2
  */
-public abstract sealed class CassandraScrollPosition implements ScrollPosition permits Initial,PagingState {
+public abstract sealed class CassandraScrollPosition implements ScrollPosition permits Initial, PagingScrollPosition {
 
 	/**
 	 * Returns an initial {@link CassandraScrollPosition}.
@@ -41,6 +42,19 @@ public static CassandraScrollPosition initial() {
 		return Initial.INSTANCE;
 	}
 
+	/**
+	 * Creates a continuation {@link CassandraScrollPosition} given {@link PagingScrollPosition}.
+	 *
+	 * @return a continuation {@link CassandraScrollPosition} given {@link PagingScrollPosition}.
+	 * @since 5.0
+	 */
+	public static CassandraScrollPosition of(PagingState pagingState) {
+
+		Assert.notNull(pagingState, "PagingState must not be null");
+
+		return of(pagingState.getRawPagingState());
+	}
+
 	/**
 	 * Creates a continuation {@link CassandraScrollPosition} given {@code pagingState}.
 	 *
@@ -50,7 +64,7 @@ public static CassandraScrollPosition of(ByteBuffer pagingState) {
 
 		Assert.notNull(pagingState, "PagingState must not be null");
 
-		return new PagingState(pagingState);
+		return new PagingScrollPosition(pagingState);
 	}
 
 	/**
@@ -78,11 +92,11 @@ public ByteBuffer getPagingState() {
 		}
 	}
 
-	static final class PagingState extends CassandraScrollPosition {
+	static final class PagingScrollPosition extends CassandraScrollPosition {
 
 		private final ByteBuffer pagingState;
 
-		PagingState(ByteBuffer pagingState) {
+		PagingScrollPosition(ByteBuffer pagingState) {
 			this.pagingState = pagingState;
 		}
 
@@ -103,7 +117,7 @@ public boolean equals(Object o) {
 			if (o == null || getClass() != o.getClass())
 				return false;
 
-			PagingState that = (PagingState) o;
+			PagingScrollPosition that = (PagingScrollPosition) o;
 
 			return ObjectUtils.nullSafeEquals(pagingState, that.pagingState);
 		}

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/query/Query.java

@@ -27,6 +27,7 @@
 import java.util.stream.StreamSupport;
 
 import org.jspecify.annotations.Nullable;
+
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.cassandra.core.cql.QueryOptions;
 import org.springframework.data.domain.Limit;
@@ -36,6 +37,8 @@
 import org.springframework.data.domain.Sort.Order;
 import org.springframework.util.Assert;
 
+import com.datastax.oss.driver.api.core.cql.PagingState;
+
 /**
  * Query object representing {@link CriteriaDefinition}s, {@link Columns}, {@link Sort}, {@link ByteBuffer paging state}
  * and {@link QueryOptions} for a CQL query. {@link Query} is created with a fluent API creating immutable objects.
@@ -256,6 +259,17 @@ public Query pagingState(CassandraScrollPosition scrollPosition) {
 				this.allowFiltering);
 	}
 
+	/**
+	 * Set the {@link PagingState paging state} to skip rows.
+	 *
+	 * @param pagingState must not be {@literal null}.
+	 * @return a new {@link Query} object containing the former settings with {@link PagingState paging state} applied.
+	 * @since 5.0
+	 */
+	public Query pagingState(PagingState pagingState) {
+		return pagingState(CassandraScrollPosition.of(pagingState));
+	}
+
 	/**
 	 * Set the {@link ByteBuffer paging state} to skip rows.
 	 *

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/core/query/QueryUnitTests.java

@@ -21,10 +21,13 @@
 import java.nio.ByteBuffer;
 
 import org.junit.jupiter.api.Test;
+
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.domain.Sort.Direction;
 
+import com.datastax.oss.driver.api.core.cql.PagingState;
+
 /**
  * Unit tests for {@link Query}.
  *
@@ -85,4 +88,15 @@ void shouldApplyPageRequests() {
 		assertThat(query.getQueryOptions())
 				.hasValueSatisfying(actual -> assertThat(actual).extracting("pageSize").isEqualTo(42));
 	}
+
+	@Test // GH-1585
+	void shouldApplyPagingState() {
+
+		PagingState pagingState = PagingState.fromString("00080006536b796c6572f07ffffffdf07ffffffd");
+		Query query = Query.empty().pagingState(pagingState);
+
+		assertThat(query.getPagingState())
+				.hasValueSatisfying(actual -> assertThat(actual).isEqualByComparingTo(pagingState.getRawPagingState()));
+	}
+
 }

src/main/antora/modules/ROOT/pages/cassandra/template.adoc

@@ -198,7 +198,8 @@ The `Query` class has some additional methods that you can use to provide option
 * `Query` *limit* `(Limit limit)`: Used to limit the size of the returned results to the provided limit (used `SELECT` limiting).
 * `Query` *limit* `(long limit)`: Used to limit the size of the returned results to the provided limit (used `SELECT` limiting).
 * `Query` *pageRequest* `(Pageable pageRequest)`: Used to associate `Sort`, `PagingState`, and `fetchSize` with the query (used for paging).
-* `Query` *pagingState* `(ByteBuffer pagingState)`: Used to associate a `ByteBuffer` with the query (used for paging).
+* `Query` *pagingState* `(CassandraScrollPosition pagingState)`: Used to associate a `CassandraScrollPosition` with the query (used for paging).
+* `Query` *pagingState* `(ByteBuffer pagingState)`: Used to associate a raw `ByteBuffer` with the query (used for paging).
 * `Query` *queryOptions* `(QueryOptions queryOptions)`: Used to associate `QueryOptions` with the query.
 * `Query` *sort* `(Sort sort)`: Used to provide a sort definition for the results.
 * `Query` *withAllowFiltering* `()`: Used to render `ALLOW FILTERING` queries.