Review checkstyle rules of spring-ws-support

snicoll · snicoll · commit 19ae0073cee9 · 2025-03-07T15:36:50.000+01:00
See gh-1479
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java
@@ -109,7 +109,7 @@ public Iterator<String> getRequestHeaderNames() throws IOException {
 	@Override
 	public Iterator<String> getRequestHeaders(String name) throws IOException {
 		List<String> headers = this.httpExchange.getRequestHeaders().get(name);
-		return headers != null ? headers.iterator() : Collections.emptyIterator();
+		return (headers != null) ? headers.iterator() : Collections.emptyIterator();
 	}
 
 	@Override
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/WsdlDefinitionHttpHandler.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/WsdlDefinitionHttpHandler.java
@@ -33,6 +33,8 @@
 import org.springframework.xml.transform.TransformerObjectSupport;
 
 /**
+ * {@link HttpHandler} implementation for WSDL documents.
+ *
  * @author Arjen Poutsma
  * @since 1.5.0
  */
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsSenderConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsSenderConnection.java
@@ -262,7 +262,7 @@ protected void onReceiveBeforeRead() throws IOException {
 				String messageSelector = "JMSCorrelationID = '" + messageId + "'";
 				messageConsumer = this.session.createConsumer(this.responseDestination, messageSelector);
 			}
-			Message message = this.receiveTimeout >= 0 ? messageConsumer.receive(this.receiveTimeout)
+			Message message = (this.receiveTimeout >= 0) ? messageConsumer.receive(this.receiveTimeout)
 					: messageConsumer.receive();
 			if (message instanceof BytesMessage || message instanceof TextMessage) {
 				this.responseMessage = message;
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsTransportConstants.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsTransportConstants.java
@@ -29,28 +29,44 @@
  */
 public interface JmsTransportConstants extends TransportConstants {
 
-	/** The "jms" URI scheme" */
+	/**
+	 * The "jms" URI scheme".
+	 */
 	String JMS_URI_SCHEME = "jms";
 
-	/** Indicates a {@link BytesMessage} type. */
+	/**
+	 * Indicates a {@link BytesMessage} type.
+	 */
 	int BYTES_MESSAGE_TYPE = 1;
 
-	/** Indicates a {@link TextMessage} type. */
+	/**
+	 * Indicates a {@link TextMessage} type.
+	 */
 	int TEXT_MESSAGE_TYPE = 2;
 
-	/** Prefix for JMS properties that map to transport headers. */
+	/**
+	 * Prefix for JMS properties that map to transport headers.
+	 */
 	String PROPERTY_PREFIX = "SOAPJMS_";
 
-	/** JMS property used for storing {@link #HEADER_ACCEPT_ENCODING}. */
+	/**
+	 * JMS property used for storing {@link #HEADER_ACCEPT_ENCODING}.
+	 */
 	String PROPERTY_ACCEPT_ENCODING = PROPERTY_PREFIX + "acceptEncoding";
 
-	/** JMS property used for storing {@link #HEADER_SOAP_ACTION}. */
+	/**
+	 * JMS property used for storing {@link #HEADER_SOAP_ACTION}.
+	 */
 	String PROPERTY_SOAP_ACTION = PROPERTY_PREFIX + "soapAction";
 
-	/** JMS property used for storing {@link #HEADER_CONTENT_LENGTH}. */
+	/**
+	 * JMS property used for storing {@link #HEADER_CONTENT_LENGTH}.
+	 */
 	String PROPERTY_CONTENT_LENGTH = PROPERTY_PREFIX + "contentLength";
 
-	/** JMS property used for storing {@link #HEADER_CONTENT_TYPE}. */
+	/**
+	 * JMS property used for storing {@link #HEADER_CONTENT_TYPE}.
+	 */
 	String PROPERTY_CONTENT_TYPE = PROPERTY_PREFIX + "contentType";
 
 }
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/TextMessageInputStream.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/TextMessageInputStream.java
@@ -43,7 +43,7 @@ private static InputStream createInputStream(TextMessage message, String encodin
 		Assert.notNull(encoding, "'encoding' must not be null");
 		try {
 			String text = message.getText();
-			byte[] contents = text != null ? text.getBytes(encoding) : new byte[0];
+			byte[] contents = (text != null) ? text.getBytes(encoding) : new byte[0];
 			return new ByteArrayInputStream(contents);
 		}
 		catch (JMSException ex) {
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java
@@ -265,7 +265,7 @@ private final class MessageHandler implements SchedulingAwareRunnable {
 
 		private final Message message;
 
-		public MessageHandler(Message message) {
+		MessageHandler(Message message) {
 			this.message = message;
 		}
 
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailReceiverConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailReceiverConnection.java
@@ -235,7 +235,7 @@ private static final class ByteArrayDataSource implements DataSource {
 
 		private String contentType;
 
-		public ByteArrayDataSource(String contentType, byte[] data) {
+		ByteArrayDataSource(String contentType, byte[] data) {
 			this.data = data;
 			this.contentType = contentType;
 		}
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailSenderConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailSenderConnection.java
@@ -211,7 +211,7 @@ protected void onReceiveBeforeRead() throws IOException {
 			try {
 				Thread.sleep(this.receiveTimeout);
 			}
-			catch (InterruptedException e) {
+			catch (InterruptedException ex) {
 				// Re-interrupt current thread, to allow other threads to react.
 				Thread.currentThread().interrupt();
 			}
@@ -313,7 +313,7 @@ private static final class ByteArrayDataSource implements DataSource {
 
 		private String contentType;
 
-		public ByteArrayDataSource(String contentType, byte[] data) {
+		ByteArrayDataSource(String contentType, byte[] data) {
 			this.data = data;
 			this.contentType = contentType;
 		}
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java
@@ -132,7 +132,7 @@ protected Message[] searchForNewMessages(Folder folder) throws MessagingExceptio
 				}
 			}
 		}
-		return searchTerm != null ? folder.search(searchTerm) : folder.getMessages();
+		return (searchTerm != null) ? folder.search(searchTerm) : folder.getMessages();
 	}
 
 	/**
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java
@@ -59,7 +59,7 @@ public static InternetAddress getTo(URI uri) {
 					try {
 						return new InternetAddress(group);
 					}
-					catch (AddressException e) {
+					catch (AddressException ex) {
 						// try next group
 					}
 				}
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java
@@ -72,7 +72,7 @@ public void afterPropertiesSet() throws Exception {
 	 * @see org.springframework.core.task.SimpleAsyncTaskExecutor#SimpleAsyncTaskExecutor(String)
 	 */
 	protected TaskExecutor createDefaultTaskExecutor() {
-		String threadNamePrefix = this.beanName != null ? this.beanName + "-" : this.DEFAULT_THREAD_NAME_PREFIX;
+		String threadNamePrefix = (this.beanName != null) ? this.beanName + "-" : this.DEFAULT_THREAD_NAME_PREFIX;
 		return new SimpleAsyncTaskExecutor(threadNamePrefix);
 	}
 
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/MessageInputStream.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/MessageInputStream.java
@@ -42,7 +42,7 @@ private static InputStream createInputStream(Message message, String encoding) t
 		Assert.notNull(message, "'message' must not be null");
 		Assert.notNull(encoding, "'encoding' must not be null");
 		String text = message.getBody();
-		byte[] contents = text != null ? text.getBytes(encoding) : new byte[0];
+		byte[] contents = (text != null) ? text.getBytes(encoding) : new byte[0];
 		return new ByteArrayInputStream(contents);
 	}
 
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageReceiver.java
@@ -71,8 +71,8 @@ protected void onActivate() throws XMPPException, IOException, SmackException {
 			try {
 				this.connection.connect();
 			}
-			catch (InterruptedException e) {
-				throw new IOException(e);
+			catch (InterruptedException ex) {
+				throw new IOException(ex);
 			}
 		}
 	}
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppReceiverConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppReceiverConnection.java
@@ -145,8 +145,8 @@ protected void onSendAfterWrite(WebServiceMessage message) throws IOException {
 		try {
 			this.connection.sendStanza(this.responseMessage);
 		}
-		catch (SmackException.NotConnectedException | InterruptedException e) {
-			throw new IOException(e);
+		catch (SmackException.NotConnectedException | InterruptedException ex) {
+			throw new IOException(ex);
 		}
 	}
 
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppSenderConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppSenderConnection.java
@@ -70,8 +70,8 @@ protected XmppSenderConnection(XMPPConnection connection, String to, String thre
 		try {
 			this.requestMessage = new Message(JidCreate.from(to), Message.Type.chat);
 		}
-		catch (XmppStringprepException e) {
-			throw new RuntimeException(e);
+		catch (XmppStringprepException ex) {
+			throw new RuntimeException(ex);
 		}
 		this.requestMessage.setThread(thread);
 	}
@@ -141,8 +141,8 @@ protected void onSendAfterWrite(WebServiceMessage message) throws IOException {
 		try {
 			this.connection.sendStanza(this.requestMessage);
 		}
-		catch (SmackException.NotConnectedException | InterruptedException e) {
-			throw new IOException(e);
+		catch (SmackException.NotConnectedException | InterruptedException ex) {
+			throw new IOException(ex);
 		}
 	}
 
@@ -156,7 +156,7 @@ protected void onReceiveBeforeRead() throws IOException {
 
 		StanzaCollector collector = this.connection.createStanzaCollector(packetFilter);
 		try {
-			Stanza packet = this.receiveTimeout >= 0 ? collector.nextResult(this.receiveTimeout)
+			Stanza packet = (this.receiveTimeout >= 0) ? collector.nextResult(this.receiveTimeout)
 					: collector.nextResult();
 			if (packet instanceof Message) {
 				this.responseMessage = (Message) packet;
@@ -166,8 +166,8 @@ else if (packet != null) {
 						"Wrong packet type: [" + packet.getClass() + "]. Only Messages can be handled.");
 			}
 		}
-		catch (InterruptedException e) {
-			throw new IOException(e);
+		catch (InterruptedException ex) {
+			throw new IOException(ex);
 		}
 	}
 
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java
@@ -33,7 +33,7 @@
 
 /**
  * Factory to make {@link org.jivesoftware.smack.XMPPConnection} and perform connection
- * and login on the XMPP server
+ * and login on the XMPP server.
  *
  * @author Gildas Cuisinier
  * @author Arjen Poutsma
@@ -107,8 +107,8 @@ public void afterPropertiesSet() throws XMPPException, IOException, SmackExcepti
 				this.connection.login(this.username, this.password);
 			}
 		}
-		catch (InterruptedException e) {
-			throw new IOException(e);
+		catch (InterruptedException ex) {
+			throw new IOException(ex);
 		}
 	}
 
diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/package-info.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/package-info.java
@@ -17,4 +17,4 @@
 /**
  * Support classes for handling messages via XMPP.
  */
-package org.springframework.ws.transport.xmpp.support;
+package org.springframework.ws.transport.xmpp.support;
diff --git a/src/checkstyle/checkstyle-suppressions.xml b/src/checkstyle/checkstyle-suppressions.xml
@@ -7,6 +7,7 @@
 	<suppress files="." checks="SpringLambdaCheck"/>
 	<suppress files="." checks="SpringMethodVisibility"/>
 
-	<suppress files="HttpTransportConstants\.java" checks="InterfaceIsType"/>
-	<suppress files="TransportConstants\.java" checks="InterfaceIsType"/>
+	<suppress files=".+TransportConstants\.java" checks="InterfaceIsType"/>
+	<suppress files="spring-ws-support[\\/]src[\\/]main[\\/]java[\\/]org[\\/]springframework[\\/]ws[\\/]transport[\\/]http[\\/]" checks="JavadocPackage"/>
+	<suppress files="spring-ws-support[\\/]src[\\/]main[\\/]java[\\/]org[\\/]springframework[\\/]ws[\\/]transport[\\/]support[\\/]" checks="JavadocPackage"/>
 </suppressions>

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public Iterator<String> getRequestHeaderNames() throws IOException {`
`109`	`109`	`@Override`
`110`	`110`	`public Iterator<String> getRequestHeaders(String name) throws IOException {`
`111`	`111`	`List<String> headers = this.httpExchange.getRequestHeaders().get(name);`
`112`		`- return headers != null ? headers.iterator() : Collections.emptyIterator();`
	`112`	`+ return (headers != null) ? headers.iterator() : Collections.emptyIterator();`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ protected void onReceiveBeforeRead() throws IOException {`
`262`	`262`	`String messageSelector = "JMSCorrelationID = '" + messageId + "'";`
`263`	`263`	`messageConsumer = this.session.createConsumer(this.responseDestination, messageSelector);`
`264`	`264`	`}`
`265`		`- Message message = this.receiveTimeout >= 0 ? messageConsumer.receive(this.receiveTimeout)`
	`265`	`+ Message message = (this.receiveTimeout >= 0) ? messageConsumer.receive(this.receiveTimeout)`
`266`	`266`	`: messageConsumer.receive();`
`267`	`267`	`if (message instanceof BytesMessage \|\| message instanceof TextMessage) {`
`268`	`268`	`this.responseMessage = message;`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ private static InputStream createInputStream(TextMessage message, String encodin`
`43`	`43`	`Assert.notNull(encoding, "'encoding' must not be null");`
`44`	`44`	`try {`
`45`	`45`	`String text = message.getText();`
`46`		`- byte[] contents = text != null ? text.getBytes(encoding) : new byte[0];`
	`46`	`+ byte[] contents = (text != null) ? text.getBytes(encoding) : new byte[0];`
`47`	`47`	`return new ByteArrayInputStream(contents);`
`48`	`48`	`}`
`49`	`49`	`catch (JMSException ex) {`
Original file line number	Diff line number	Diff line change
`@@ -265,7 +265,7 @@ private final class MessageHandler implements SchedulingAwareRunnable {`
`265`	`265`
`266`	`266`	`private final Message message;`
`267`	`267`
`268`		`- public MessageHandler(Message message) {`
	`268`	`+ MessageHandler(Message message) {`
`269`	`269`	`this.message = message;`
`270`	`270`	`}`
`271`	`271`
Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ private static final class ByteArrayDataSource implements DataSource {`
`235`	`235`
`236`	`236`	`private String contentType;`
`237`	`237`
`238`		`- public ByteArrayDataSource(String contentType, byte[] data) {`
	`238`	`+ ByteArrayDataSource(String contentType, byte[] data) {`
`239`	`239`	`this.data = data;`
`240`	`240`	`this.contentType = contentType;`
`241`	`241`	`}`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ protected void onReceiveBeforeRead() throws IOException {`
`211`	`211`	`try {`
`212`	`212`	`Thread.sleep(this.receiveTimeout);`
`213`	`213`	`}`
`214`		`- catch (InterruptedException e) {`
	`214`	`+ catch (InterruptedException ex) {`
`215`	`215`	`// Re-interrupt current thread, to allow other threads to react.`
`216`	`216`	`Thread.currentThread().interrupt();`
`217`	`217`	`}`
`@@ -313,7 +313,7 @@ private static final class ByteArrayDataSource implements DataSource {`
`313`	`313`
`314`	`314`	`private String contentType;`
`315`	`315`
`316`		`- public ByteArrayDataSource(String contentType, byte[] data) {`
	`316`	`+ ByteArrayDataSource(String contentType, byte[] data) {`
`317`	`317`	`this.data = data;`
`318`	`318`	`this.contentType = contentType;`
`319`	`319`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ protected Message[] searchForNewMessages(Folder folder) throws MessagingExceptio`
`132`	`132`	`}`
`133`	`133`	`}`
`134`	`134`	`}`
`135`		`- return searchTerm != null ? folder.search(searchTerm) : folder.getMessages();`
	`135`	`+ return (searchTerm != null) ? folder.search(searchTerm) : folder.getMessages();`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public static InternetAddress getTo(URI uri) {`
`59`	`59`	`try {`
`60`	`60`	`return new InternetAddress(group);`
`61`	`61`	`}`
`62`		`- catch (AddressException e) {`
	`62`	`+ catch (AddressException ex) {`
`63`	`63`	`// try next group`
`64`	`64`	`}`
`65`	`65`	`}`