Apply checkstyle changes to spring-graphql

See gh-943

Author: bclozel

spring-graphql/src/main/java/org/springframework/graphql/GraphQlRequest.java

@@ -61,7 +61,7 @@ public interface GraphQlRequest {
 	/**
 	 * Convert the request to a {@link Map} as defined in
 	 * <a href="https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md">GraphQL over HTTP</a> and
-	 * <a href="https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md">GraphQL over WebSocket</a>:
+	 * <a href="https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md">GraphQL over WebSocket</a>.
 	 * <table>
 	 * <tr><th>Key</th><th>Value</th></tr>
 	 * <tr><td>query</td><td>{@link #getDocument() document}</td></tr>

spring-graphql/src/main/java/org/springframework/graphql/ResponseError.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package org.springframework.graphql;
 
 import java.util.List;

spring-graphql/src/main/java/org/springframework/graphql/ResponseField.java

@@ -43,7 +43,7 @@ public interface ResponseField {
 	 * </ul>
 	 * @deprecated as of 1.0.3 in favor of checking via {@link #getValue()}
 	 */
-	@Deprecated
+	@Deprecated(since = "1.0.3", forRemoval = true)
 	boolean hasValue();
 
 	/**
@@ -90,7 +90,7 @@ public interface ResponseField {
 	 * @deprecated since 1.0.3 in favor of {@link #getErrors()}
 	 */
 	@Nullable
-	@Deprecated
+	@Deprecated(since = "1.0.3", forRemoval = true)
 	ResponseError getError();
 
 	/**

spring-graphql/src/main/java/org/springframework/graphql/client/AbstractGraphQlClientBuilder.java

@@ -46,6 +46,7 @@
  * agnostic {@code GraphQlClient}. A transport specific extension can then wrap
  * this default tester by extending {@link AbstractDelegatingGraphQlClient}.
  *
+ * @param <B> the builder type
  * @author Rossen Stoyanchev
  * @since 1.0.0
  * @see AbstractDelegatingGraphQlClient
@@ -114,6 +115,8 @@ private <T extends B> T self() {
 	 * Transport-specific subclasses can provide their JSON {@code Encoder} and
 	 * {@code Decoder} for use at the client level, for mapping response data
 	 * to some target entity type.
+	 * @param encoder the JSON encoder to use
+	 * @param decoder the JSON decoder to use
 	 */
 	protected void setJsonCodecs(Encoder<?> encoder, Decoder<?> decoder) {
 		this.jsonEncoder = encoder;
@@ -122,6 +125,7 @@ protected void setJsonCodecs(Encoder<?> encoder, Decoder<?> decoder) {
 
 	/**
 	 * Variant of {@link #setJsonCodecs} for setting each codec individually.
+	 * @param encoder the JSON encoder to use
 	 */
 	protected void setJsonEncoder(Encoder<?> encoder) {
 		this.jsonEncoder = encoder;
@@ -137,6 +141,7 @@ protected Encoder<?> getJsonEncoder() {
 
 	/**
 	 * Variant of {@link #setJsonCodecs} for setting each codec individually.
+	 * @param decoder the JSON decoder to use
 	 */
 	protected void setJsonDecoder(Decoder<?> decoder) {
 		this.jsonDecoder = decoder;
@@ -161,12 +166,13 @@ protected List<GraphQlClientInterceptor> getInterceptors() {
 	/**
 	 * Build the default transport-agnostic client that subclasses can then wrap
 	 * with {@link AbstractDelegatingGraphQlClient}.
+	 * @param transport the GraphQL transport to be used by the client
 	 */
 	protected GraphQlClient buildGraphQlClient(GraphQlTransport transport) {
 
 		if (jackson2Present) {
-			this.jsonEncoder = (this.jsonEncoder == null ? DefaultJackson2Codecs.encoder() : this.jsonEncoder);
-			this.jsonDecoder = (this.jsonDecoder == null ? DefaultJackson2Codecs.decoder() : this.jsonDecoder);
+			this.jsonEncoder = (this.jsonEncoder == null) ? DefaultJackson2Codecs.encoder() : this.jsonEncoder;
+			this.jsonDecoder = (this.jsonDecoder == null) ? DefaultJackson2Codecs.decoder() : this.jsonDecoder;
 		}
 
 		return new DefaultGraphQlClient(
@@ -177,32 +183,32 @@ protected GraphQlClient buildGraphQlClient(GraphQlTransport transport) {
 	 * Return a {@code Consumer} to initialize new builders from "this" builder.
 	 */
 	protected Consumer<AbstractGraphQlClientBuilder<?>> getBuilderInitializer() {
-		return builder -> {
-			builder.interceptors(interceptorList -> interceptorList.addAll(interceptors));
-			builder.documentSource(documentSource);
+		return (builder) -> {
+			builder.interceptors((interceptorList) -> interceptorList.addAll(this.interceptors));
+			builder.documentSource(this.documentSource);
 			builder.setJsonCodecs(getEncoder(), getDecoder());
 		};
 	}
 
 	private Chain createExecuteChain(GraphQlTransport transport) {
 
-		Chain chain = request -> transport.execute(request).map(response ->
+		Chain chain = (request) -> transport.execute(request).map((response) ->
 				new DefaultClientGraphQlResponse(request, response, getEncoder(), getDecoder()));
 
 		return this.interceptors.stream()
 				.reduce(GraphQlClientInterceptor::andThen)
-				.map(interceptor -> (Chain) (request) -> interceptor.intercept(request, chain))
+				.map((interceptor) -> (Chain) (request) -> interceptor.intercept(request, chain))
 				.orElse(chain);
 	}
 
 	private SubscriptionChain createExecuteSubscriptionChain(GraphQlTransport transport) {
 
-		SubscriptionChain chain = request -> transport.executeSubscription(request)
-				.map(response -> new DefaultClientGraphQlResponse(request, response, getEncoder(), getDecoder()));
+		SubscriptionChain chain = (request) -> transport.executeSubscription(request)
+				.map((response) -> new DefaultClientGraphQlResponse(request, response, getEncoder(), getDecoder()));
 
 		return this.interceptors.stream()
 				.reduce(GraphQlClientInterceptor::andThen)
-				.map(interceptor -> (SubscriptionChain) (request) -> interceptor.interceptSubscription(request, chain))
+				.map((interceptor) -> (SubscriptionChain) (request) -> interceptor.interceptSubscription(request, chain))
 				.orElse(chain);
 	}
 

spring-graphql/src/main/java/org/springframework/graphql/client/ClientGraphQlResponse.java

@@ -32,10 +32,12 @@ public interface ClientGraphQlResponse extends GraphQlResponse {
 	/**
 	 * {@inheritDoc}
 	 */
+	@Override
 	ClientResponseField field(String path);
 
 	/**
 	 * Decode the full response map to the given target type.
+	 * @param <D> the target type
 	 * @param type the target class
 	 * @return the decoded value, or never {@code null}
 	 * @throws FieldAccessException if the response is not {@link #isValid() valid}
@@ -44,7 +46,8 @@ public interface ClientGraphQlResponse extends GraphQlResponse {
 
 	/**
 	 * Variant of {@link #toEntity(Class)} with a {@link ParameterizedTypeReference}.
-	 * @param type the target type
+	 * @param <D> the target type
+	 * @param type the target parameterized type
 	 * @return the decoded value, or never {@code null}
 	 * @throws FieldAccessException if the response is not {@link #isValid() valid}
 	 */

spring-graphql/src/main/java/org/springframework/graphql/client/ClientResponseField.java

@@ -34,6 +34,7 @@ public interface ClientResponseField extends ResponseField {
 
 	/**
 	 * Decode the field to an entity of the given type.
+	 * @param <D> the entity type
 	 * @param entityType the type to convert to
 	 * @return the decoded entity, or {@code null} if the field is {@code null}
 	 * but otherwise there are no errors
@@ -46,12 +47,15 @@ public interface ClientResponseField extends ResponseField {
 
 	/**
 	 * Variant of {@link #toEntity(Class)} with a {@link ParameterizedTypeReference}.
+	 * @param <D> the entity type
+	 * @param entityType the type to convert to
 	 */
 	@Nullable
 	<D> D toEntity(ParameterizedTypeReference<D> entityType);
 
 	/**
 	 * Variant of {@link #toEntity(Class)} to decode to a list of entities.
+	 * @param <D> the entity type
 	 * @param elementType the type of elements in the list
 	 * @return the list of decoded entities, or an empty list if the field is
 	 * {@code null} but otherwise there are no errors
@@ -61,15 +65,16 @@ public interface ClientResponseField extends ResponseField {
 	 */
 	<D> List<D> toEntityList(Class<D> elementType);
 
-		/**
-		 * Variant of {@link #toEntity(Class)} to decode to a list of entities.
-		 * @param elementType the type of elements in the list
-		 * @return the list of decoded entities, or an empty list if the field is
-		 * {@code null} but otherwise there are no errors
-		 * @throws FieldAccessException if the target field is {@code null} and the
-		 * response is not {@link GraphQlResponse#isValid() valid} or the field has
-		 * {@link ResponseField#getErrors() errors}.
-		 */
+	/**
+	 * Variant of {@link #toEntity(Class)} to decode to a list of entities.
+	 * @param <D> the entity type
+	 * @param elementType the type of elements in the list
+	 * @return the list of decoded entities, or an empty list if the field is
+	 * {@code null} but otherwise there are no errors
+	 * @throws FieldAccessException if the target field is {@code null} and the
+	 * response is not {@link GraphQlResponse#isValid() valid} or the field has
+	 * {@link ResponseField#getErrors() errors}.
+	 */
 	<D> List<D> toEntityList(ParameterizedTypeReference<D> elementType);
 
 }

spring-graphql/src/main/java/org/springframework/graphql/client/CodecDelegate.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.graphql.client;
 
 import java.util.List;
@@ -37,7 +38,6 @@
  * Helper class for encoding and decoding GraphQL messages.
  *
  * @author Rossen Stoyanchev
- * @since 1.0.0
  */
 final class CodecDelegate {
 
@@ -60,14 +60,14 @@ final class CodecDelegate {
 
 	static Encoder<?> findJsonEncoder(CodecConfigurer configurer) {
 		return findJsonEncoder(configurer.getWriters().stream()
-				.filter(writer -> writer instanceof EncoderHttpMessageWriter)
-				.map(writer -> ((EncoderHttpMessageWriter<?>) writer).getEncoder()));
+				.filter((writer) -> writer instanceof EncoderHttpMessageWriter)
+				.map((writer) -> ((EncoderHttpMessageWriter<?>) writer).getEncoder()));
 	}
 
 	static Decoder<?> findJsonDecoder(CodecConfigurer configurer) {
 		return findJsonDecoder(configurer.getReaders().stream()
-				.filter(reader -> reader instanceof DecoderHttpMessageReader)
-				.map(reader -> ((DecoderHttpMessageReader<?>) reader).getDecoder()));
+				.filter((reader) -> reader instanceof DecoderHttpMessageReader)
+				.map((reader) -> ((DecoderHttpMessageReader<?>) reader).getDecoder()));
 	}
 
 	static Encoder<?> findJsonEncoder(List<Encoder<?>> encoders) {
@@ -80,26 +80,26 @@ static Decoder<?> findJsonDecoder(List<Decoder<?>> decoders) {
 
 	private static Encoder<?> findJsonEncoder(Stream<Encoder<?>> stream) {
 		return stream
-				.filter(encoder -> encoder.canEncode(MESSAGE_TYPE, MediaType.APPLICATION_JSON))
+				.filter((encoder) -> encoder.canEncode(MESSAGE_TYPE, MediaType.APPLICATION_JSON))
 				.findFirst()
 				.orElseThrow(() -> new IllegalArgumentException("No JSON Encoder"));
 	}
 
 	private static Decoder<?> findJsonDecoder(Stream<Decoder<?>> decoderStream) {
 		return decoderStream
-				.filter(decoder -> decoder.canDecode(MESSAGE_TYPE, MediaType.APPLICATION_JSON))
+				.filter((decoder) -> decoder.canDecode(MESSAGE_TYPE, MediaType.APPLICATION_JSON))
 				.findFirst()
 				.orElseThrow(() -> new IllegalArgumentException("No JSON Decoder"));
 	}
 
 
-	public CodecConfigurer getCodecConfigurer() {
+	CodecConfigurer getCodecConfigurer() {
 		return this.codecConfigurer;
 	}
 
 
 	@SuppressWarnings("unchecked")
-	public <T> WebSocketMessage encode(WebSocketSession session, GraphQlWebSocketMessage message) {
+	<T> WebSocketMessage encode(WebSocketSession session, GraphQlWebSocketMessage message) {
 
 		DataBuffer buffer = ((Encoder<T>) this.encoder).encodeValue(
 				(T) message, session.bufferFactory(), MESSAGE_TYPE, MimeTypeUtils.APPLICATION_JSON, null);
@@ -108,7 +108,7 @@ public <T> WebSocketMessage encode(WebSocketSession session, GraphQlWebSocketMes
 	}
 
 	@SuppressWarnings("ConstantConditions")
-	public GraphQlWebSocketMessage decode(WebSocketMessage webSocketMessage) {
+	GraphQlWebSocketMessage decode(WebSocketMessage webSocketMessage) {
 		DataBuffer buffer = DataBufferUtils.retain(webSocketMessage.getPayload());
 		return (GraphQlWebSocketMessage) this.decoder.decode(buffer, MESSAGE_TYPE, null, null);
 	}

spring-graphql/src/main/java/org/springframework/graphql/client/DefaultClientGraphQlRequest.java

@@ -27,7 +27,6 @@
  * Default implementation of {@link ClientGraphQlRequest}.
  *
  * @author Rossen Stoyanchev
- * @since 1.0.0
  */
 final class DefaultClientGraphQlRequest extends DefaultGraphQlRequest implements ClientGraphQlRequest {
 

spring-graphql/src/main/java/org/springframework/graphql/client/DefaultClientGraphQlResponse.java

@@ -26,7 +26,6 @@
  * Default implementation of {@link ClientGraphQlResponse}.
  *
  * @author Rossen Stoyanchev
- * @since 1.0.0
  */
 final class DefaultClientGraphQlResponse extends ResponseMapGraphQlResponse implements ClientGraphQlResponse {
 

spring-graphql/src/main/java/org/springframework/graphql/client/DefaultClientResponseField.java

@@ -40,7 +40,6 @@
  * support for decoding.
  *
  * @author Rossen Stoyanchev
- * @since 1.0.0
  */
 final class DefaultClientResponseField implements ClientResponseField {
 
@@ -55,7 +54,7 @@ final class DefaultClientResponseField implements ClientResponseField {
 	}
 
 
-	@SuppressWarnings("deprecation")
+	@SuppressWarnings("removal")
 	@Override
 	public boolean hasValue() {
 		return (this.field.getValue() != null);
@@ -76,7 +75,7 @@ public <T> T getValue() {
 		return this.field.getValue();
 	}
 
-	@SuppressWarnings("deprecation")
+	@SuppressWarnings("removal")
 	@Override
 	public ResponseError getError() {
 		return this.field.getError();
@@ -100,13 +99,13 @@ public <D> D toEntity(ParameterizedTypeReference<D> entityType) {
 	@Override
 	public <D> List<D> toEntityList(Class<D> elementType) {
 		List<D> list = toEntity(ResolvableType.forClassWithGenerics(List.class, elementType));
-		return (list != null ? list : Collections.emptyList());
+		return (list != null) ? list : Collections.emptyList();
 	}
 
 	@Override
 	public <D> List<D> toEntityList(ParameterizedTypeReference<D> elementType) {
 		List<D> list = toEntity(ResolvableType.forClassWithGenerics(List.class, ResolvableType.forType(elementType)));
-		return (list != null ? list : Collections.emptyList());
+		return (list != null) ? list : Collections.emptyList();
 	}
 
 		@SuppressWarnings("unchecked")