Add @CheckReturnValue to Query and Update API.

Closes #1609

Author: mp911de

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

@@ -32,6 +32,7 @@
 import org.springframework.data.cassandra.core.convert.CassandraVector;
 import org.springframework.data.cassandra.core.mapping.SimilarityFunction;
 import org.springframework.data.domain.Vector;
+import org.springframework.lang.CheckReturnValue;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
@@ -113,6 +114,7 @@ public static Columns from(CqlIdentifier... columnNames) {
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link Columns} object containing all column definitions and the included {@code columnName}.
 	 */
+	@CheckReturnValue
 	public Columns include(String columnName) {
 		return select(columnName, ColumnSelector.from(columnName));
 	}
@@ -124,6 +126,7 @@ public Columns include(String columnName) {
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link Columns} object containing all column definitions and the included {@code columnName}.
 	 */
+	@CheckReturnValue
 	public Columns include(CqlIdentifier columnName) {
 		return select(columnName, ColumnSelector.from(columnName));
 	}
@@ -135,6 +138,7 @@ public Columns include(CqlIdentifier columnName) {
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link Columns} object containing all column definitions and the TTL for {@code columnName}.
 	 */
+	@CheckReturnValue
 	public Columns ttl(String columnName) {
 		return select(columnName, FunctionCall.from("TTL", ColumnSelector.from(columnName)));
 	}
@@ -146,6 +150,7 @@ public Columns ttl(String columnName) {
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link Columns} object containing all column definitions and the TTL for {@code columnName}.
 	 */
+	@CheckReturnValue
 	public Columns ttl(CqlIdentifier columnName) {
 		return select(columnName, FunctionCall.from("TTL", ColumnSelector.from(columnName)));
 	}
@@ -157,6 +162,7 @@ public Columns ttl(CqlIdentifier columnName) {
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link Columns} object containing all column definitions and the selected {@code columnName}.
 	 */
+	@CheckReturnValue
 	public Columns select(String columnName, Selector selector) {
 		return select(ColumnName.from(columnName), selector);
 	}
@@ -170,6 +176,7 @@ public Columns select(String columnName, Selector selector) {
 	 * @return a new {@link Columns} object containing all column definitions and the selected {@code columnName}.
 	 * @since 4.5
 	 */
+	@CheckReturnValue
 	public Columns select(CqlIdentifier columnName, Function<SelectorBuilder, Selector> builder) {
 
 		ColumnName from = ColumnName.from(columnName);
@@ -185,6 +192,7 @@ public Columns select(CqlIdentifier columnName, Function<SelectorBuilder, Select
 	 * @return a new {@link Columns} object containing all column definitions and the selected {@code columnName}.
 	 * @since 4.5
 	 */
+	@CheckReturnValue
 	public Columns select(String columnName, Function<SelectorBuilder, Selector> builder) {
 
 		ColumnName from = ColumnName.from(columnName);
@@ -198,6 +206,7 @@ public Columns select(String columnName, Function<SelectorBuilder, Selector> bui
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link Columns} object containing all column definitions and the selected {@code columnName}.
 	 */
+	@CheckReturnValue
 	public Columns select(CqlIdentifier columnName, Selector selector) {
 		return select(ColumnName.from(columnName), selector);
 	}
@@ -231,6 +240,7 @@ public boolean isEmpty() {
 	 * @param columns must not be {@literal null}.
 	 * @return a new {@link Columns} with the merged result of the configured and given {@link Columns}.
 	 */
+	@CheckReturnValue
 	public Columns and(Columns columns) {
 
 		Map<ColumnName, List<Selector>> result = new LinkedHashMap<>(this.columns);

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

@@ -25,7 +25,7 @@
 
 /**
  * Basic class for creating queries. It follows a fluent API style so that you can easily create a
- * {@link CriteriaDefinition}. Static import of the 'Criteria.where' method will improve readability.
+ * {@link CriteriaDefinition}. Static import of the {@code Criteria.where} method will improve readability.
  *
  * @author Mark Paluch
  * @since 2.0

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

@@ -35,6 +35,7 @@
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.domain.Sort.Order;
+import org.springframework.lang.CheckReturnValue;
 import org.springframework.util.Assert;
 
 import com.datastax.oss.driver.api.core.cql.PagingState;
@@ -136,6 +137,7 @@ public static Query query(Iterable<? extends CriteriaDefinition> criteriaDefinit
 	 * @param criteriaDefinition must not be {@literal null}.
 	 * @return a new {@link Query} object containing the former settings with {@link CriteriaDefinition} applied.
 	 */
+	@CheckReturnValue
 	public Query and(CriteriaDefinition criteriaDefinition) {
 
 		Assert.notNull(criteriaDefinition, "Criteria must not be null");
@@ -164,6 +166,7 @@ public Iterable<CriteriaDefinition> getCriteriaDefinitions() {
 	 * @param columns must not be {@literal null}.
 	 * @return a new {@link Query} object containing the former settings with {@link Columns} applied.
 	 */
+	@CheckReturnValue
 	public Query columns(Columns columns) {
 
 		Assert.notNull(columns, "Columns must not be null");
@@ -185,6 +188,7 @@ public Columns getColumns() {
 	 * @param sort must not be {@literal null}.
 	 * @return a new {@link Query} object containing the former settings with {@link Sort} applied.
 	 */
+	@CheckReturnValue
 	public Query sort(Sort sort) {
 
 		Assert.notNull(sort, "Sort must not be null");
@@ -226,6 +230,7 @@ public Sort getSort() {
 	 * @return a new {@link Query} object containing the former settings with {@link PageRequest} applied.
 	 * @see CassandraPageRequest
 	 */
+	@CheckReturnValue
 	public Query pageRequest(Pageable pageable) {
 
 		Assert.notNull(pageable, "Pageable must not be null");
@@ -255,6 +260,7 @@ public Query pageRequest(Pageable pageable) {
 	 * @param scrollPosition must not be {@literal null}.
 	 * @return a new {@link Query} object containing the former settings with paging state applied.
 	 */
+	@CheckReturnValue
 	public Query pagingState(CassandraScrollPosition scrollPosition) {
 
 		Assert.notNull(scrollPosition, "CassandraScrollPosition must not be null");
@@ -270,6 +276,7 @@ public Query pagingState(CassandraScrollPosition scrollPosition) {
 	 * @return a new {@link Query} object containing the former settings with {@link PagingState paging state} applied.
 	 * @since 5.0
 	 */
+	@CheckReturnValue
 	public Query pagingState(PagingState pagingState) {
 		return pagingState(CassandraScrollPosition.of(pagingState));
 	}
@@ -280,6 +287,7 @@ public Query pagingState(PagingState pagingState) {
 	 * @param pagingState must not be {@literal null}.
 	 * @return a new {@link Query} object containing the former settings with {@link ByteBuffer paging state} applied.
 	 */
+	@CheckReturnValue
 	public Query pagingState(ByteBuffer pagingState) {
 
 		Assert.notNull(pagingState, "PagingState must not be null");
@@ -306,6 +314,7 @@ public Optional<ByteBuffer> getPagingState() {
 	 * @param queryOptions must not be {@literal null}.
 	 * @return a new {@link Query} object containing the former settings with {@link QueryOptions} applied.
 	 */
+	@CheckReturnValue
 	public Query queryOptions(QueryOptions queryOptions) {
 
 		Assert.notNull(queryOptions, "QueryOptions must not be null");
@@ -327,6 +336,7 @@ public Optional<QueryOptions> getQueryOptions() {
 	 * @param limit
 	 * @return a new {@link Query} object containing the former settings with {@code limit} applied.
 	 */
+	@CheckReturnValue
 	public Query limit(long limit) {
 		return new Query(this.criteriaDefinitions, this.columns, this.sort, this.scrollPosition, this.queryOptions,
 				Limit.of(Math.toIntExact(limit)), this.allowFiltering);
@@ -338,6 +348,7 @@ public Query limit(long limit) {
 	 * @param limit
 	 * @return a new {@link Query} object containing the former settings with {@code limit} applied.
 	 */
+	@CheckReturnValue
 	public Query limit(Limit limit) {
 		return new Query(this.criteriaDefinitions, this.columns, this.sort, this.scrollPosition, this.queryOptions, limit,
 				this.allowFiltering);
@@ -362,6 +373,7 @@ public boolean isLimited() {
 	 *
 	 * @return a new {@link Query} object containing the former settings with {@code allowFiltering} applied.
 	 */
+	@CheckReturnValue
 	public Query withAllowFiltering() {
 		return new Query(this.criteriaDefinitions, this.columns, this.sort, this.scrollPosition, this.queryOptions,
 				this.limit, true);

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

@@ -27,6 +27,7 @@
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.data.cassandra.core.query.Update.AddToOp.Mode;
+import org.springframework.lang.CheckReturnValue;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
@@ -98,6 +99,7 @@ private Update(List<AssignmentOp> updateOperations) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update set(String columnName, @Nullable Object value) {
 		return add(new SetOp(ColumnName.from(columnName), value));
 	}
@@ -106,8 +108,9 @@ public Update set(String columnName, @Nullable Object value) {
 	 * Create a new {@link SetBuilder} to set a collection item for {@code columnName} in a fluent style.
 	 *
 	 * @param columnName must not be {@literal null}.
-	 * @return a new {@link AddToBuilder} to build an set assignment.
+	 * @return a new {@link AddToBuilder} to build a set assignment.
 	 */
+	@CheckReturnValue
 	public SetBuilder set(String columnName) {
 		return new DefaultSetBuilder(ColumnName.from(columnName));
 	}
@@ -118,6 +121,7 @@ public SetBuilder set(String columnName) {
 	 * @param columnName must not be {@literal null}.
 	 * @return a new {@link AddToBuilder} to build an add-to assignment.
 	 */
+	@CheckReturnValue
 	public AddToBuilder addTo(String columnName) {
 		return new DefaultAddToBuilder(ColumnName.from(columnName));
 	}
@@ -129,6 +133,7 @@ public AddToBuilder addTo(String columnName) {
 	 * @return a new {@link RemoveFromBuilder} to build an remove-from assignment.
 	 * @since 3.1.4
 	 */
+	@CheckReturnValue
 	public RemoveFromBuilder removeFrom(String columnName) {
 		return new DefaultRemoveFromBuilder(ColumnName.from(columnName));
 	}
@@ -141,6 +146,7 @@ public RemoveFromBuilder removeFrom(String columnName) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update remove(String columnName, Object value) {
 		return add(new RemoveOp(ColumnName.from(columnName), Collections.singletonList(value)));
 	}
@@ -152,6 +158,7 @@ public Update remove(String columnName, Object value) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update clear(String columnName) {
 		return add(new SetOp(ColumnName.from(columnName), Collections.emptyList()));
 	}
@@ -163,6 +170,7 @@ public Update clear(String columnName) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update increment(String columnName) {
 		return increment(columnName, 1);
 	}
@@ -175,6 +183,7 @@ public Update increment(String columnName) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update increment(String columnName, Number delta) {
 		return add(new IncrOp(ColumnName.from(columnName), delta));
 	}
@@ -186,6 +195,7 @@ public Update increment(String columnName, Number delta) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update decrement(String columnName) {
 		return decrement(columnName, 1);
 	}
@@ -198,6 +208,7 @@ public Update decrement(String columnName) {
 	 * @return a new {@link Update} object containing the merge result of the existing assignments and the current
 	 *         assignment.
 	 */
+	@CheckReturnValue
 	public Update decrement(String columnName, Number delta) {
 
 		if (delta instanceof Integer || delta instanceof Long) {