Checkstyle changes

* Upgrade to Checkstyle 9.0
* apply some JavaDocs rules
* Fix JavaDocs rules violations
* Some other minor clean up in the affected classes
This commit is contained in:
Artem Bilan
2021-09-28 11:55:25 -04:00
parent d2e23c5f03
commit fe57fd281c
217 changed files with 742 additions and 581 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2021 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.
@@ -153,9 +153,6 @@ public abstract class AbstractInternetProtocolReceivingChannelAdapter
this.applicationEventPublisher = applicationEventPublisher;
}
/**
* Protected by lifecycleLock
*/
@Override
protected void doStart() {
String beanName = getComponentName();

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2021 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.
@@ -53,8 +53,8 @@ public abstract class AbstractInternetProtocolSendingMessageHandler extends Abst
/**
* @see java.net.DatagramSocket#setSoTimeout(int)
* @param timeout The timeout.
* @see java.net.DatagramSocket#setSoTimeout(int)
*/
@Override
public void setSoTimeout(int timeout) {
@@ -62,16 +62,16 @@ public abstract class AbstractInternetProtocolSendingMessageHandler extends Abst
}
/**
* @see java.net.DatagramSocket#setReceiveBufferSize(int)
* @param size The receive buffer size.
* @see java.net.DatagramSocket#setReceiveBufferSize(int)
*/
@Override
public void setSoReceiveBufferSize(int size) {
}
/**
* @see java.net.DatagramSocket#setSendBufferSize(int)
* @param size The send buffer size.
* @see java.net.DatagramSocket#setSendBufferSize(int)
*/
@Override
public void setSoSendBufferSize(int size) {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2001-2019 the original author or authors.
* Copyright 2001-2021 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.
@@ -23,26 +23,23 @@ package org.springframework.integration.ip;
public interface CommonSocketOptions {
/**
* @param soTimeout The timeout.
* @see java.net.Socket#setSoTimeout(int)
* @see java.net.DatagramSocket#setSoTimeout(int)
*
* @param soTimeout The timeout.
*/
void setSoTimeout(int soTimeout);
/**
* @param soReceiveBufferSize The receive buffer size.
* @see java.net.Socket#setReceiveBufferSize(int)
* @see java.net.DatagramSocket#setReceiveBufferSize(int)
*
* @param soReceiveBufferSize The receive buffer size.
*/
void setSoReceiveBufferSize(int soReceiveBufferSize);
/**
* @param soSendBufferSize The send buffer size.
* @see java.net.Socket#setSendBufferSize(int)
* @see java.net.DatagramSocket#setSendBufferSize(int)
*
* @param soSendBufferSize The send buffer size.
*/
void setSoSendBufferSize(int soSendBufferSize);

View File

@@ -457,7 +457,7 @@ public class TcpOutboundGateway extends AbstractReplyProducingMessageHandler
}
/**
* Sender blocks here until the reply is received, or we time out
* Sender blocks here until the reply is received, or we time out.
* @return The return message or null if we time out
*/
Message<?> getReply() {

View File

@@ -494,8 +494,8 @@ public abstract class AbstractConnectionFactory extends IntegrationObjectSupport
/**
* @return the handshake timeout.
* @see #setSslHandshakeTimeout(int)
* @since 4.3.6
* @see #setSslHandshakeTimeout(int)
*/
@Nullable
protected Integer getSslHandshakeTimeout() {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2021 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.
@@ -102,32 +102,32 @@ public class CachingClientConnectionFactory extends AbstractClientConnectionFact
}
/**
* @see SimplePool#getPoolSize()
* @return the pool size.
* @see SimplePool#getPoolSize()
*/
public int getPoolSize() {
return this.pool.getPoolSize();
}
/**
* @see SimplePool#getIdleCount()
* @return the idle count.
* @see SimplePool#getIdleCount()
*/
public int getIdleCount() {
return this.pool.getIdleCount();
}
/**
* @see SimplePool#getActiveCount()
* @return the active count.
* @see SimplePool#getActiveCount()
*/
public int getActiveCount() {
return this.pool.getActiveCount();
}
/**
* @see SimplePool#getAllocatedCount()
* @return the allocated count.
* @see SimplePool#getAllocatedCount()
*/
public int getAllocatedCount() {
return this.pool.getAllocatedCount();

View File

@@ -204,7 +204,7 @@ public class FailoverClientConnectionFactory extends AbstractClientConnectionFac
}
/**
* Returns true if all factories are running
* Return true if all factories are running.
*/
@Override
public boolean isRunning() {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2021 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.
@@ -179,7 +179,7 @@ public abstract class TcpConnectionInterceptorSupport extends TcpConnectionSuppo
}
/**
* Returns the underlying connection (or next interceptor)
* Return the underlying connection (or next interceptor).
* @return the connection
*/
public TcpConnectionSupport getTheConnection() {
@@ -187,7 +187,7 @@ public abstract class TcpConnectionInterceptorSupport extends TcpConnectionSuppo
}
/**
* Sets the underlying connection (or next interceptor)
* Set the underlying connection (or next interceptor).
* @param theConnection the connection
*/
public void setTheConnection(TcpConnectionSupport theConnection) {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2001-2019 the original author or authors.
* Copyright 2001-2021 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.
@@ -21,10 +21,11 @@ import org.springframework.messaging.Message;
/**
* Classes that implement this interface may register with a
* connection factory to receive messages retrieved from a
* {@link TcpConnection}
* @author Gary Russell
* @since 2.0
* {@link TcpConnection}.
*
* @author Gary Russell
*
* @since 2.0
*/
@FunctionalInterface
public interface TcpListener {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2021 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.
@@ -35,7 +35,7 @@ import org.springframework.lang.Nullable;
public interface TcpNioConnectionSupport {
/**
* Create a new {@link TcpNioConnection} object wrapping the {@link SocketChannel}
* Create a new {@link TcpNioConnection} object wrapping the {@link SocketChannel}.
* @param socketChannel the SocketChannel.
* @param server true if this connection is a server connection.
* @param lookupHost true if hostname lookup should be performed, otherwise the connection will

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2017-2019 the original author or authors.
* Copyright 2017-2021 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.
@@ -40,7 +40,7 @@ public class ByteArrayElasticRawDeserializer implements Deserializer<byte[]> {
/**
* Construct an instance that uses {@link ByteArrayOutputStream}s with an initial
* buffer size of 32;
* buffer size of 32.
*/
public ByteArrayElasticRawDeserializer() {
this(DEFAULT_INITIAL_SIZE);

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2021 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.
@@ -68,7 +68,7 @@ public class ByteArrayLengthHeaderSerializer extends AbstractByteArraySerializer
private int headerAdjust;
/**
* Construct the serializer using {@link #HEADER_SIZE_INT}
* Construct the serializer using {@link #HEADER_SIZE_INT}.
*/
public ByteArrayLengthHeaderSerializer() {
this(HEADER_SIZE_INT);