Enable checkstyle on main sources

Closes gh-1479

Author: snicoll

gradle/plugins/conventions-plugin/src/main/java/org/springframework/ws/gradle/conventions/CheckstyleConventions.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2005-2025 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.ws.gradle.conventions;
+
+import io.spring.javaformat.gradle.SpringJavaFormatPlugin;
+import org.gradle.api.Plugin;
+import org.gradle.api.Project;
+import org.gradle.api.artifacts.DependencySet;
+import org.gradle.api.plugins.JavaPlugin;
+import org.gradle.api.plugins.quality.Checkstyle;
+import org.gradle.api.plugins.quality.CheckstyleExtension;
+import org.gradle.api.plugins.quality.CheckstylePlugin;
+
+/**
+ * {@link Plugin} that applies conventions for checkstyle.
+ *
+ * @author Brian Clozel
+ * @author Stephane Nicoll
+ */
+public class CheckstyleConventions {
+
+	/**
+	 * Applies the Spring Java Format and Checkstyle plugins with the project conventions.
+	 * @param project the current project
+	 */
+	public void apply(Project project) {
+		project.getPlugins().withType(JavaPlugin.class, (java) -> {
+			project.getPlugins().apply(CheckstylePlugin.class);
+			project.getTasks().withType(Checkstyle.class).forEach(checkstyle -> checkstyle.getMaxHeapSize().set("1g"));
+			project.getTasks().named("checkstyleTest").configure(task -> task.setEnabled(false));
+			CheckstyleExtension checkstyle = project.getExtensions().getByType(CheckstyleExtension.class);
+			checkstyle.setToolVersion("10.21.1");
+			checkstyle.getConfigDirectory().set(project.getRootProject().file("src/checkstyle"));
+			String version = SpringJavaFormatPlugin.class.getPackage().getImplementationVersion();
+			DependencySet checkstyleDependencies = project.getConfigurations()
+				.getByName("checkstyle")
+				.getDependencies();
+			checkstyleDependencies.add(
+					project.getDependencies().create("com.puppycrawl.tools:checkstyle:" + checkstyle.getToolVersion()));
+			checkstyleDependencies
+				.add(project.getDependencies().create("io.spring.javaformat:spring-javaformat-checkstyle:" + version));
+		});
+	}
+
+}

gradle/plugins/conventions-plugin/src/main/java/org/springframework/ws/gradle/conventions/ConventionsPlugin.java

@@ -33,9 +33,10 @@ public class ConventionsPlugin implements Plugin<Project> {
 	@Override
 	public void apply(Project project) {
 		project.setGroup("org.springframework.ws");
-		project.getPlugins()
-			.withType(JavaBasePlugin.class)
-			.all((plugin) -> new JavaBasePluginConventions().apply(project));
+		project.getPlugins().withType(JavaBasePlugin.class).all((plugin) -> {
+			new JavaBasePluginConventions().apply(project);
+			new CheckstyleConventions().apply(project);
+		});
 		project.getPlugins().withType(JavaPlugin.class).all((plugin) -> new JavaPluginConventions().apply(project));
 		project.getPlugins()
 			.withType(MavenPublishPlugin.class)

spring-ws-core/src/main/java/org/springframework/ws/FaultAwareWebServiceMessage.java

@@ -24,8 +24,8 @@
  * often require different processing rules.
  *
  * @author Arjen Poutsma
- * @see org.springframework.ws.soap.SoapMessage
  * @since 1.0.0
+ * @see org.springframework.ws.soap.SoapMessage
  */
 public interface FaultAwareWebServiceMessage extends WebServiceMessage {
 

spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessage.java

@@ -28,9 +28,9 @@
  * Contains methods that provide access to the payload of the message.
  *
  * @author Arjen Poutsma
+ * @since 1.0.0
  * @see org.springframework.ws.soap.SoapMessage
  * @see WebServiceMessageFactory
- * @since 1.0.0
  */
 public interface WebServiceMessage {
 

spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageFactory.java

@@ -26,8 +26,8 @@
  * Allows the creation of empty messages, or messages based on {@code InputStream}s.
  *
  * @author Arjen Poutsma
- * @see org.springframework.ws.WebServiceMessage
  * @since 1.0.0
+ * @see org.springframework.ws.WebServiceMessage
  */
 public interface WebServiceMessageFactory {
 

spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceFaultException.java

@@ -32,7 +32,7 @@ public class WebServiceFaultException extends WebServiceClientException {
 	/** Create a new instance of the {@code WebServiceFaultException} class. */
 	public WebServiceFaultException(String msg) {
 		super(msg);
-		faultMessage = null;
+		this.faultMessage = null;
 	}
 
 	/**
@@ -46,7 +46,7 @@ public WebServiceFaultException(FaultAwareWebServiceMessage faultMessage) {
 
 	/** Returns the fault message. */
 	public FaultAwareWebServiceMessage getWebServiceMessage() {
-		return faultMessage;
+		return this.faultMessage;
 	}
 
 }

spring-ws-core/src/main/java/org/springframework/ws/client/core/SimpleFaultMessageResolver.java

@@ -25,8 +25,8 @@
  * fault occurs.
  *
  * @author Arjen Poutsma
- * @see WebServiceFaultException
  * @since 1.0.0
+ * @see WebServiceFaultException
  */
 public class SimpleFaultMessageResolver implements FaultMessageResolver {
 

spring-ws-core/src/main/java/org/springframework/ws/client/core/SourceExtractor.java

@@ -34,9 +34,10 @@
  * Implementations of this interface perform the actual work of extracting results, but
  * don't need to worry about exception handling, or resource handling.
  *
+ * @param <T> the type of the source
  * @author Arjen Poutsma
- * @see org.springframework.ws.client.core.WebServiceTemplate
  * @since 1.0.0
+ * @see org.springframework.ws.client.core.WebServiceTemplate
  */
 public interface SourceExtractor<T> {
 

spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageExtractor.java

@@ -35,6 +35,7 @@
  * Implementations of this interface perform the actual work of extracting results, but
  * don't need to worry about exception handling, or resource handling.
  *
+ * @param <T> the type of the result object
  * @author Arjen Poutsma
  * @since 1.0.0
  */

spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceOperations.java

@@ -28,8 +28,8 @@
  * testability, as it can easily be mocked or stubbed.
  *
  * @author Arjen Poutsma
- * @see WebServiceTemplate
  * @since 1.0.0
+ * @see WebServiceTemplate
  */
 public interface WebServiceOperations {