From fe57fd281c013e6746bae760d3e3eeaae6846c8a Mon Sep 17 00:00:00 2001 From: Artem Bilan Date: Tue, 28 Sep 2021 11:55:25 -0400 Subject: [PATCH] Checkstyle changes * Upgrade to Checkstyle 9.0 * apply some JavaDocs rules * Fix JavaDocs rules violations * Some other minor clean up in the affected classes --- build.gradle | 2 +- .../amqp/channel/AbstractAmqpChannel.java | 6 +-- .../AbstractSubscribableAmqpChannel.java | 6 +-- .../PointToPointSubscribableAmqpChannel.java | 4 +- .../amqp/channel/PollableAmqpChannel.java | 4 +- .../channel/PublishSubscribeAmqpChannel.java | 4 +- .../AbstractMessageListenerContainerSpec.java | 5 +- .../integration/amqp/dsl/Amqp.java | 6 +-- .../amqp/dsl/AmqpMessageChannelSpec.java | 3 +- .../dsl/AmqpOutboundChannelAdapterSpec.java | 4 +- .../dsl/AmqpPollableMessageChannelSpec.java | 3 +- .../SimpleMessageListenerContainerSpec.java | 4 +- .../amqp/support/DefaultAmqpHeaderMapper.java | 6 +-- .../aggregator/CorrelatingMessageBarrier.java | 2 +- .../MethodInvokingMessageListProcessor.java | 4 +- .../ResequencingMessageHandler.java | 4 +- .../integration/annotation/Router.java | 2 +- .../integration/channel/DirectChannel.java | 4 +- .../integration/channel/PriorityChannel.java | 4 +- .../integration/codec/Codec.java | 10 ++-- .../codec/CodecMessageConverter.java | 5 +- ...stractSimpleMessageHandlerFactoryBean.java | 4 +- .../config/IntegrationConfigUtils.java | 2 +- ...AbstractMethodAnnotationPostProcessor.java | 2 + .../MethodAnnotationPostProcessor.java | 6 ++- .../config/xml/GlobalWireTapParser.java | 4 +- .../ResourceInboundChannelAdapterParser.java | 4 +- ...ansactionSynchronizationFactoryParser.java | 5 +- .../context/IntegrationObjectSupport.java | 5 +- .../integration/core/MessageSource.java | 4 +- .../OrderedAwareCopyOnWriteArraySet.java | 4 +- .../dsl/BaseIntegrationFlowDefinition.java | 4 +- .../dsl/CorrelationHandlerSpec.java | 4 +- .../integration/dsl/DelayerEndpointSpec.java | 12 ++--- .../integration/dsl/EnricherSpec.java | 6 +-- .../integration/dsl/GatewayProxySpec.java | 4 +- .../integration/dsl/HeaderEnricherSpec.java | 22 ++++----- .../integration/dsl/MessageProducerSpec.java | 6 +-- .../dsl/ReactiveMessageHandlerSpec.java | 5 +- .../integration/dsl/RouterSpec.java | 4 +- .../dsl/context/IntegrationFlowContext.java | 4 +- .../AbstractFetchLimitingMessageSource.java | 8 ++-- .../ExpressionEvaluatingMessageSource.java | 5 +- .../ReactiveMessageSourceProducer.java | 4 +- ...oadableResourceBundleExpressionSource.java | 8 ++-- .../expression/ValueExpression.java | 7 ++- .../RequestReplyMessageHandlerAdapter.java | 6 +-- .../handler/AbstractMessageProcessor.java | 4 +- .../AbstractMessageProducingHandler.java | 2 +- .../integration/handler/DelayHandler.java | 8 ++-- .../ExpressionEvaluatingMessageHandler.java | 13 ++--- .../ExpressionEvaluatingMessageProcessor.java | 4 +- .../handler/MessageHandlerChain.java | 4 -- .../integration/handler/MessageProcessor.java | 4 +- .../MethodInvokingMessageProcessor.java | 4 +- .../advice/IdempotentReceiverInterceptor.java | 4 +- .../json/ObjectToJsonTransformer.java | 5 +- .../mapping/AbstractHeaderMapper.java | 2 + .../mapping/ConvertingBytesMessageMapper.java | 4 +- .../integration/mapping/HeaderMapper.java | 6 +-- .../mapping/InboundMessageMapper.java | 4 +- .../mapping/OutboundMessageMapper.java | 4 +- .../integration/message/AdviceMessage.java | 6 ++- .../metadata/ListenableMetadataStore.java | 9 ++-- .../metadata/MetadataStoreListener.java | 12 ++--- .../router/AbstractMessageRouter.java | 4 +- .../store/AbstractKeyValueMessageStore.java | 2 +- .../store/BasicMessageGroupStore.java | 14 ++---- .../integration/store/MessageGroup.java | 2 +- .../integration/store/MessageGroupQueue.java | 4 +- .../integration/store/SimpleMessageStore.java | 8 ++-- .../AbstractIntegrationMessageBuilder.java | 4 +- .../integration/support/IdGenerators.java | 5 +- .../integration/support/MessageBuilder.java | 4 +- .../integration/support/MutableMessage.java | 4 +- .../support/MutableMessageBuilder.java | 4 +- .../support/PartialSuccessException.java | 6 +-- .../AbstractJacksonJsonMessageParser.java | 4 +- .../AbstractJsonInboundMessageMapper.java | 10 ++-- .../json/MessageJacksonDeserializer.java | 4 +- .../leader/LockRegistryLeaderInitiator.java | 2 +- .../support/locks/LockRegistry.java | 5 +- .../management/IntegrationManagement.java | 4 +- .../support/utils/IntegrationUtils.java | 4 +- .../support/utils/PatternMatchUtils.java | 4 +- .../IntegrationResourceHolder.java | 11 ++--- .../TransactionSynchronizationFactory.java | 7 ++- .../TransactionSynchronizationProcessor.java | 5 +- .../AbstractPayloadTransformer.java | 5 +- .../transformer/ContentEnricher.java | 2 +- .../transformer/DecodingTransformer.java | 8 ++-- .../EncodingPayloadTransformer.java | 8 ++-- .../PayloadTypeConvertingTransformer.java | 5 +- .../AbstractHeaderValueMessageProcessor.java | 8 +++- ...EvaluatingHeaderValueMessageProcessor.java | 8 ++-- .../support/HeaderValueMessageProcessor.java | 5 +- .../StaticHeaderValueMessageProcessor.java | 7 ++- .../util/AcceptOnceCollectionFilter.java | 7 ++- .../util/AnnotatedMethodFilter.java | 10 ++-- .../integration/util/CloseableIterator.java | 4 +- .../integration/util/CollectionFilter.java | 5 +- .../integration/util/FunctionIterator.java | 6 ++- .../integration/util/Pool.java | 22 +++++---- .../integration/util/SimplePool.java | 17 ++++--- .../util/WhileLockedProcessor.java | 8 ++-- .../file/DefaultDirectoryScanner.java | 6 +-- .../integration/file/FileHeaders.java | 10 ++-- .../file/FileReadingMessageSource.java | 2 +- .../file/FileWritingMessageHandler.java | 8 ++-- ...eTailInboundChannelAdapterFactoryBean.java | 4 +- .../dsl/FileInboundChannelAdapterSpec.java | 2 +- .../dsl/FileWritingMessageHandlerSpec.java | 4 +- .../file/filters/AbstractFileListFilter.java | 4 +- ...stractMarkerFilePresentFileListFilter.java | 7 ++- .../AbstractRegexPatternFileListFilter.java | 4 +- .../AbstractSimplePatternFileListFilter.java | 10 ++-- .../file/filters/AcceptAllFileListFilter.java | 6 +-- .../filters/AcceptOnceFileListFilter.java | 4 +- .../filters/DiscardAwareFileListFilter.java | 4 +- .../filters/ExpressionFileListFilter.java | 4 +- .../file/filters/FileListFilter.java | 2 + .../filters/ResettableFileListFilter.java | 10 ++-- .../filters/ReversibleFileListFilter.java | 8 ++-- .../file/remote/AbstractFileInfo.java | 21 +++++---- ...tractRemoteFileStreamingMessageSource.java | 4 +- .../file/remote/ClientCallback.java | 8 ++-- .../remote/ClientCallbackWithoutResult.java | 6 +-- .../integration/file/remote/FileInfo.java | 8 +++- .../file/remote/MessageSessionCallback.java | 6 ++- .../file/remote/RemoteFileOperations.java | 8 ++-- .../file/remote/RemoteFileTemplate.java | 6 ++- .../remote/SessionCallbackWithoutResult.java | 5 +- .../AbstractRemoteFileOutboundGateway.java | 6 ++- .../FileTransferringMessageHandler.java | 6 ++- .../remote/session/CachingSessionFactory.java | 8 ++-- .../session/DefaultSessionFactoryLocator.java | 4 +- .../session/DelegatingSessionFactory.java | 6 ++- .../file/remote/session/Session.java | 8 +++- .../file/remote/session/SessionFactory.java | 5 +- .../remote/session/SessionFactoryLocator.java | 8 ++-- .../session/SessionFactoryMapBuilder.java | 5 +- ...InboundFileSynchronizingMessageSource.java | 6 ++- .../synchronizer/InboundFileSynchronizer.java | 7 +-- ...SDelegatingFileTailingMessageProducer.java | 2 +- .../AbstractFilePayloadTransformer.java | 6 ++- .../file/splitter/FileSplitterTests.java | 4 +- .../session/AbstractFtpSessionFactory.java | 10 ++-- .../gemfire/inbound/CqEventType.java | 6 ++- .../gemfire/store/GemfireMessageStore.java | 6 +-- ...GroovyScriptExecutingMessageProcessor.java | 8 ++-- .../dsl/HttpInboundEndpointSupportSpec.java | 9 ++-- .../http/multipart/MultipartFileReader.java | 7 +-- .../multipart/MultipartHttpInputMessage.java | 16 ++----- ...actHttpRequestExecutingMessageHandler.java | 5 +- .../HttpRequestExecutingMessageHandler.java | 8 ++-- ...ternetProtocolReceivingChannelAdapter.java | 5 +- ...InternetProtocolSendingMessageHandler.java | 8 ++-- .../integration/ip/CommonSocketOptions.java | 11 ++--- .../ip/tcp/TcpOutboundGateway.java | 2 +- .../connection/AbstractConnectionFactory.java | 2 +- .../CachingClientConnectionFactory.java | 10 ++-- .../FailoverClientConnectionFactory.java | 2 +- .../TcpConnectionInterceptorSupport.java | 6 +-- .../ip/tcp/connection/TcpListener.java | 9 ++-- .../connection/TcpNioConnectionSupport.java | 4 +- .../ByteArrayElasticRawDeserializer.java | 4 +- .../ByteArrayLengthHeaderSerializer.java | 4 +- .../jdbc/config/JdbcTypesEnum.java | 13 ++--- .../jdbc/store/JdbcMessageStore.java | 2 +- .../jms/config/JmsChannelFactoryBean.java | 2 +- .../jms/dsl/JmsInboundGatewaySpec.java | 10 ++-- .../jms/dsl/JmsMessageChannelSpec.java | 3 +- .../dsl/JmsOutboundChannelAdapterSpec.java | 4 +- .../dsl/JmsPollableMessageChannelSpec.java | 3 +- .../jmx/MBeanTreePollingMessageSource.java | 11 ++--- .../xml/JpaInboundChannelAdapterParser.java | 4 +- .../jpa/config/xml/JpaNamespaceHandler.java | 4 +- .../xml/JpaOutboundChannelAdapterParser.java | 4 +- .../integration/jpa/core/JpaExecutor.java | 4 +- .../jpa/core/JpaOperationFailedException.java | 5 +- .../integration/jpa/core/JpaOperations.java | 6 +-- .../dsl/JpaRetrievingOutboundGatewaySpec.java | 6 +-- .../jpa/inbound/JpaPollingChannelAdapter.java | 6 +-- .../integration/mail/ImapMailReceiver.java | 2 +- .../mail/MailSendingMessageHandler.java | 5 +- .../integration/mail/SearchTermStrategy.java | 11 ++--- .../mail/dsl/ImapIdleChannelAdapterSpec.java | 4 +- .../AbstractMailMessageTransformer.java | 6 ++- .../MongoDbInboundChannelAdapterParser.java | 2 +- .../MongoDbOutboundChannelAdapterParser.java | 5 +- .../config/MongoDbOutboundGatewayParser.java | 4 +- .../mongodb/config/MongoParserUtils.java | 6 +-- .../dsl/AbstractMongoDbMessageSourceSpec.java | 5 +- .../integration/mongodb/dsl/MongoDb.java | 2 +- .../dsl/MongoDbOutboundGatewaySpec.java | 4 +- .../metadata/MongoDbMetadataStore.java | 4 +- .../outbound/MessageCollectionCallback.java | 4 +- .../outbound/MongoDbOutboundGateway.java | 4 +- .../MongoDbStoringMessageHandler.java | 29 +++++------- .../ReactiveMongoDbStoringMessageHandler.java | 6 +-- .../mongodb/support/MongoHeaders.java | 6 +-- ...MqttMessageDrivenChannelAdapterParser.java | 5 +- .../mqtt/config/xml/MqttNamespaceHandler.java | 5 +- .../outbound/AbstractMqttMessageHandler.java | 10 ++-- .../integration/mqtt/support/MqttUtils.java | 5 +- .../r2dbc/outbound/R2dbcMessageHandler.java | 4 +- .../RedisStoreWritingMessageHandler.java | 2 +- .../dsl/RSocketOutboundGatewaySpec.java | 10 ++-- ...stractScriptExecutingMessageProcessor.java | 6 ++- .../session/DefaultSftpSessionFactory.java | 8 ++-- .../support/IntegrationStompHeaders.java | 6 ++- .../CharacterStreamReadingMessageSource.java | 14 +++--- .../test/support/RequestResponseScenario.java | 4 +- .../ws/AbstractWebServiceOutboundGateway.java | 6 +-- .../xml/splitter/XPathMessageSplitter.java | 4 +- src/checkstyle/checkstyle-suppressions.xml | 1 + src/checkstyle/checkstyle.xml | 47 +++++++++---------- 217 files changed, 742 insertions(+), 581 deletions(-) diff --git a/build.gradle b/build.gradle index 3da4683c69..79d69fb714 100644 --- a/build.gradle +++ b/build.gradle @@ -343,7 +343,7 @@ configure(javaProjects) { subproject -> checkstyle { configDirectory.set(rootProject.file('src/checkstyle')) - toolVersion = project.hasProperty('checkstyleVersion') ? project.checkstyleVersion : '8.45.1' + toolVersion = project.hasProperty('checkstyleVersion') ? project.checkstyleVersion : '9.0' } jar { diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractAmqpChannel.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractAmqpChannel.java index 22a6b4a5a9..21c9ffa311 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractAmqpChannel.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractAmqpChannel.java @@ -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. @@ -77,8 +77,8 @@ public abstract class AbstractAmqpChannel extends AbstractMessageChannel impleme * @param amqpTemplate the template. * @param outboundMapper the outbound mapper. * @param inboundMapper the inbound mapper. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ AbstractAmqpChannel(AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) { Assert.notNull(amqpTemplate, "amqpTemplate must not be null"); @@ -132,8 +132,8 @@ public abstract class AbstractAmqpChannel extends AbstractMessageChannel impleme /** * @return the extract payload. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ protected boolean isExtractPayload() { return this.extractPayload; diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractSubscribableAmqpChannel.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractSubscribableAmqpChannel.java index 802fb980d7..038d9914a3 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractSubscribableAmqpChannel.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractSubscribableAmqpChannel.java @@ -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. @@ -87,8 +87,8 @@ abstract class AbstractSubscribableAmqpChannel extends AbstractAmqpChannel * @param amqpTemplate the template. * @param outboundMapper the outbound mapper. * @param inboundMapper the inbound mapper. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ protected AbstractSubscribableAmqpChannel(String channelName, AbstractMessageListenerContainer container, AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) { @@ -120,8 +120,8 @@ abstract class AbstractSubscribableAmqpChannel extends AbstractAmqpChannel * @param isPubSub true for a pub/sub channel. * @param outboundMapper the outbound mapper. * @param inboundMapper the inbound mapper. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ protected AbstractSubscribableAmqpChannel(String channelName, AbstractMessageListenerContainer container, diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PointToPointSubscribableAmqpChannel.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PointToPointSubscribableAmqpChannel.java index d07a68f146..b41262efa1 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PointToPointSubscribableAmqpChannel.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PointToPointSubscribableAmqpChannel.java @@ -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. @@ -57,8 +57,8 @@ public class PointToPointSubscribableAmqpChannel extends AbstractSubscribableAmq * @param amqpTemplate the template. * @param outboundMapper the outbound mapper. * @param inboundMapper the inbound mapper. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ public PointToPointSubscribableAmqpChannel(String channelName, AbstractMessageListenerContainer container, AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) { diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PollableAmqpChannel.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PollableAmqpChannel.java index a5a9d68aac..2e8d6bda89 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PollableAmqpChannel.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PollableAmqpChannel.java @@ -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. @@ -82,8 +82,8 @@ public class PollableAmqpChannel extends AbstractAmqpChannel * @param amqpTemplate the template. * @param outboundMapper the outbound mapper. * @param inboundMapper the inbound mapper. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ public PollableAmqpChannel(String channelName, AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) { diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PublishSubscribeAmqpChannel.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PublishSubscribeAmqpChannel.java index e7b3d1d067..0fa40f4cc3 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PublishSubscribeAmqpChannel.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PublishSubscribeAmqpChannel.java @@ -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. @@ -68,8 +68,8 @@ public class PublishSubscribeAmqpChannel extends AbstractSubscribableAmqpChannel * @param amqpTemplate the template * @param outboundMapper the outbound mapper. * @param inboundMapper the inbound mapper. - * @see #setExtractPayload(boolean) * @since 4.3 + * @see #setExtractPayload(boolean) */ public PublishSubscribeAmqpChannel(String channelName, AbstractMessageListenerContainer container, AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) { diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AbstractMessageListenerContainerSpec.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AbstractMessageListenerContainerSpec.java index d41c4aa76f..ce5558c8ff 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AbstractMessageListenerContainerSpec.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AbstractMessageListenerContainerSpec.java @@ -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. @@ -37,6 +37,9 @@ import org.springframework.util.backoff.BackOff; /** * Base class for container specs. * + * @param the current spec extension type + * @param the listener container type + * * @author Gary Russell * @author Artem Bilan * diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/Amqp.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/Amqp.java index 81c7537fd7..2292ed8748 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/Amqp.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/Amqp.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2020 the original author or authors. + * Copyright 2014-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. @@ -155,7 +155,7 @@ public final class Amqp { } /** - * Create an initial AmqpInboundPolledChannelAdapterSpec + * Create an initial AmqpInboundPolledChannelAdapterSpec. * @param connectionFactory the connectionFactory. * @param queue the queue. * @return the AmqpInboundPolledChannelAdapterSpec. @@ -168,7 +168,7 @@ public final class Amqp { } /** - * Create an initial AmqpInboundPolledChannelAdapterSpec + * Create an initial AmqpInboundPolledChannelAdapterSpec. * @param connectionFactory the connectionFactory. * @param ackCallbackFactory the ackCallbackFactory * @param queue the queue. diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpMessageChannelSpec.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpMessageChannelSpec.java index a5d9dfe3a5..88e2b0e1d7 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpMessageChannelSpec.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpMessageChannelSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2020 the original author or authors. + * Copyright 2014-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. @@ -36,6 +36,7 @@ import org.springframework.util.ErrorHandler; * {@link org.springframework.integration.amqp.channel.PointToPointSubscribableAmqpChannel}. * * @param the target {@link AmqpMessageChannelSpec} implementation type. + * @param the target channel type. * * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpOutboundChannelAdapterSpec.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpOutboundChannelAdapterSpec.java index 061bdeafe4..b0c5e0d930 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpOutboundChannelAdapterSpec.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpOutboundChannelAdapterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-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. @@ -19,7 +19,7 @@ package org.springframework.integration.amqp.dsl; import org.springframework.amqp.core.AmqpTemplate; /** - * Spec for an outbound AMQP channel adapter + * Spec for an outbound AMQP channel adapter. * * @author Gary Russell * @author Artme Bilan diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpPollableMessageChannelSpec.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpPollableMessageChannelSpec.java index cc2aa945ba..7a128c8407 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpPollableMessageChannelSpec.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AmqpPollableMessageChannelSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2020 the original author or authors. + * Copyright 2014-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. @@ -33,6 +33,7 @@ import org.springframework.util.Assert; * A {@link MessageChannelSpec} for a {@link AbstractAmqpChannel}s. * * @param the target {@link AmqpPollableMessageChannelSpec} implementation type. + * @param the target channel type. * * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/SimpleMessageListenerContainerSpec.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/SimpleMessageListenerContainerSpec.java index 3714e3da4f..d45a31184e 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/SimpleMessageListenerContainerSpec.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/SimpleMessageListenerContainerSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2017-2020 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. @@ -111,8 +111,8 @@ public class SimpleMessageListenerContainerSpec extends * The batch size to use. * @param batchSize the batchSize. * @return the spec. - * @see SimpleMessageListenerContainer#setBatchSize(int) * @since 5.2 + * @see SimpleMessageListenerContainer#setBatchSize(int) */ public SimpleMessageListenerContainerSpec batchSize(int batchSize) { this.listenerContainer.setBatchSize(batchSize); diff --git a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/DefaultAmqpHeaderMapper.java b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/DefaultAmqpHeaderMapper.java index 66815c307b..f1909c5459 100644 --- a/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/DefaultAmqpHeaderMapper.java +++ b/spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/DefaultAmqpHeaderMapper.java @@ -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. @@ -340,9 +340,9 @@ public class DefaultAmqpHeaderMapper extends AbstractHeaderMapper the method evaluation expecetd result type. + * * @author Dave Syer * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/ResequencingMessageHandler.java b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/ResequencingMessageHandler.java index f32c3fee9f..7b132b1160 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/ResequencingMessageHandler.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/ResequencingMessageHandler.java @@ -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. @@ -57,7 +57,7 @@ public class ResequencingMessageHandler extends AbstractCorrelatingMessageHandle /** * Overridden to false for a resequencer so late messages are immediately discarded rather - * than waiting for the next timeout + * than waiting for the next timeout. */ @Override public final void setExpireGroupsUponTimeout(boolean expireGroupsUponTimeout) { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/annotation/Router.java b/spring-integration-core/src/main/java/org/springframework/integration/annotation/Router.java index 1baf402574..e77cbd85a6 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/annotation/Router.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/annotation/Router.java @@ -67,7 +67,7 @@ public @interface Router { String defaultOutputChannel() default ""; /** - * The 'key=value' pairs to represent channelMapping entries + * The 'key=value' pairs to represent channelMapping entries. * @return the channelMappings. * @see org.springframework.integration.router.AbstractMappingMessageRouter#setChannelMapping(String, String) */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/channel/DirectChannel.java b/spring-integration-core/src/main/java/org/springframework/integration/channel/DirectChannel.java index d70cdfe43a..524e7db0c7 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/channel/DirectChannel.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/channel/DirectChannel.java @@ -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. @@ -40,7 +40,7 @@ public class DirectChannel extends AbstractSubscribableChannel { private volatile Integer maxSubscribers; /** - * Create a channel with default {@link RoundRobinLoadBalancingStrategy} + * Create a channel with default {@link RoundRobinLoadBalancingStrategy}. */ public DirectChannel() { this(new RoundRobinLoadBalancingStrategy()); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/channel/PriorityChannel.java b/spring-integration-core/src/main/java/org/springframework/integration/channel/PriorityChannel.java index 044efa8af8..09d70b3291 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/channel/PriorityChannel.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/channel/PriorityChannel.java @@ -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. @@ -40,7 +40,7 @@ import org.springframework.messaging.MessageHeaders; public class PriorityChannel extends QueueChannel { /** - * PriorityBlockingQueue#DEFAULT_INITIAL_CAPACITY is private + * PriorityBlockingQueue#DEFAULT_INITIAL_CAPACITY is private. */ private static final int DEFAULT_INITIAL_CAPACITY = 11; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/codec/Codec.java b/spring-integration-core/src/main/java/org/springframework/integration/codec/Codec.java index 5e90c5e7ba..44a4a3bb36 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/codec/Codec.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/codec/Codec.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -28,7 +28,7 @@ import java.io.OutputStream; */ public interface Codec { /** - * Encode (encode) an object to an OutputStream + * Encode (encode) an object to an OutputStream. * @param object the object to encode * @param outputStream the OutputStream * @throws IOException if the operation fails @@ -36,7 +36,7 @@ public interface Codec { void encode(Object object, OutputStream outputStream) throws IOException; /** - * Encode an object to a byte array + * Encode an object to a byte array. * @param object the object to encode * @return the bytes * @throws IOException if the operation fails @@ -44,7 +44,7 @@ public interface Codec { byte[] encode(Object object) throws IOException; /** - * Decode an object of a given type + * Decode an object of a given type. * @param inputStream the input stream containing the encoded object * @param type the object's class * @param the object's type @@ -54,7 +54,7 @@ public interface Codec { T decode(InputStream inputStream, Class type) throws IOException; /** - * Decode an object of a given type + * Decode an object of a given type. * @param bytes the byte array containing the encoded object * @param type the object's class * @param the object's type diff --git a/spring-integration-core/src/main/java/org/springframework/integration/codec/CodecMessageConverter.java b/spring-integration-core/src/main/java/org/springframework/integration/codec/CodecMessageConverter.java index 8e04a2b93f..342ad9c28a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/codec/CodecMessageConverter.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/codec/CodecMessageConverter.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -28,9 +28,10 @@ import org.springframework.messaging.support.GenericMessage; import org.springframework.util.Assert; /** - * A {@link MessageConverter} that delegates to a {@link Codec} to convert + * A {@link MessageConverter} that delegates to a {@link Codec} to convert. * * @author Gary Russell + * * @since 4.2 * */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/AbstractSimpleMessageHandlerFactoryBean.java b/spring-integration-core/src/main/java/org/springframework/integration/config/AbstractSimpleMessageHandlerFactoryBean.java index 4b3f54199e..4fa5464621 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/AbstractSimpleMessageHandlerFactoryBean.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/AbstractSimpleMessageHandlerFactoryBean.java @@ -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. @@ -51,6 +51,8 @@ import org.springframework.util.CollectionUtils; /** * Factory bean to create and configure a {@link MessageHandler}. * + * @param the target message handler type. + * * @author Dave Syer * @author Oleg Zhurakousky * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationConfigUtils.java b/spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationConfigUtils.java index 57433aaf99..904fbeb326 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationConfigUtils.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/IntegrationConfigUtils.java @@ -49,7 +49,7 @@ public final class IntegrationConfigUtils { } /** - * Register a {@link SpelFunctionFactoryBean} for the provided method signature + * Register a {@link SpelFunctionFactoryBean} for the provided method signature. * @param registry the registry for bean to register * @param functionId the bean name * @param aClass the class for function diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/AbstractMethodAnnotationPostProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/AbstractMethodAnnotationPostProcessor.java index 5c0b97753b..fd75c28675 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/AbstractMethodAnnotationPostProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/AbstractMethodAnnotationPostProcessor.java @@ -97,6 +97,8 @@ import reactor.core.publisher.Flux; /** * Base class for Method-level annotation post-processors. * + * @param the target annotation type. + * * @author Mark Fisher * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/MethodAnnotationPostProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/MethodAnnotationPostProcessor.java index efda0fd7b3..d7ab9e7bba 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/MethodAnnotationPostProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/annotation/MethodAnnotationPostProcessor.java @@ -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. @@ -23,6 +23,8 @@ import java.util.List; /** * Strategy interface for post-processing annotated methods. * + * @param the target annotation type. + * * @author Mark Fisher * @author Gary Russell * @author Artem Bilan @@ -36,7 +38,7 @@ public interface MethodAnnotationPostProcessor { * to create an {@link org.springframework.integration.endpoint.AbstractEndpoint}. * @param method the method to check if it is eligible to create an Endpoint * @param annotations the List of annotations to process - * @return the {@code boolean} flag to determine whether or not to create an + * @return the {@code boolean} flag to determine whether to create an * {@link org.springframework.integration.endpoint.AbstractEndpoint} * @since 4.0 */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/GlobalWireTapParser.java b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/GlobalWireTapParser.java index edf0634a94..1fac91d56b 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/GlobalWireTapParser.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/GlobalWireTapParser.java @@ -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. @@ -24,7 +24,7 @@ import org.springframework.beans.factory.support.AbstractBeanDefinition; import org.springframework.beans.factory.xml.ParserContext; /** - * Parser for the top level 'wire-tap' element + * Parser for the top level 'wire-tap' element. * * @author David Turanski * @author Artem Bilan diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/ResourceInboundChannelAdapterParser.java b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/ResourceInboundChannelAdapterParser.java index c72e4771c2..3715357a8b 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/ResourceInboundChannelAdapterParser.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/ResourceInboundChannelAdapterParser.java @@ -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. @@ -26,7 +26,7 @@ import org.springframework.integration.util.AcceptOnceCollectionFilter; import org.springframework.util.StringUtils; /** - * Parser for 'resource-inbound-channel-adapter' + * Parser for 'resource-inbound-channel-adapter'. * * @author Oleg Zhurakousky * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/TransactionSynchronizationFactoryParser.java b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/TransactionSynchronizationFactoryParser.java index c74fd38582..dfa4638ba0 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/TransactionSynchronizationFactoryParser.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/TransactionSynchronizationFactoryParser.java @@ -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. @@ -29,9 +29,10 @@ import org.springframework.integration.transaction.ExpressionEvaluatingTransacti import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** - * Parser for transaction-synchronizatioin-factory element + * Parser for transaction-synchronization-factory element. * * @author Oleg Zhurakousky + * * @since 2.2 * */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/context/IntegrationObjectSupport.java b/spring-integration-core/src/main/java/org/springframework/integration/context/IntegrationObjectSupport.java index a34e0dcab6..1267dc4755 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/context/IntegrationObjectSupport.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/context/IntegrationObjectSupport.java @@ -72,9 +72,6 @@ public abstract class IntegrationObjectSupport implements BeanNameAware, NamedCo private static final IdGenerator ID_GENERATOR = new AlternativeJdkIdGenerator(); - /** - * Logger that is available to subclasses - */ protected final LogAccessor logger = new LogAccessor(getClass()); // NOSONAR protected private final ConversionService defaultConversionService = DefaultConversionService.getSharedInstance(); @@ -292,10 +289,10 @@ public abstract class IntegrationObjectSupport implements BeanNameAware, NamedCo } /** - * @see IntegrationContextUtils#getIntegrationProperties(BeanFactory) * @return The global integration properties. * @deprecated since version 5.5 in favor of {@link #getIntegrationProperty(String, Class)}; * will be replaced with {@link IntegrationProperties} variant in the next major version. + * @see IntegrationContextUtils#getIntegrationProperties(BeanFactory) */ @Deprecated protected Properties getIntegrationProperties() { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/core/MessageSource.java b/spring-integration-core/src/main/java/org/springframework/integration/core/MessageSource.java index 57d8a4b6de..3fa74f9e04 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/core/MessageSource.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/core/MessageSource.java @@ -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. @@ -24,6 +24,8 @@ import org.springframework.messaging.Message; /** * Base interface for any source of {@link Message Messages} that can be polled. * + * @param the expected payload type. + * * @author Mark Fisher * @author Artem Bilan */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dispatcher/OrderedAwareCopyOnWriteArraySet.java b/spring-integration-core/src/main/java/org/springframework/integration/dispatcher/OrderedAwareCopyOnWriteArraySet.java index 286305ea74..fbe3f5ac84 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dispatcher/OrderedAwareCopyOnWriteArraySet.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dispatcher/OrderedAwareCopyOnWriteArraySet.java @@ -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. @@ -47,6 +47,8 @@ import org.springframework.util.StringUtils; * The class is package-protected and only intended for use by the AbstractDispatcher. It * must enforce safe concurrent access for all usage by the dispatcher. * + * @param collection element type. + * * @author Oleg Zhurakousky * @author Mark Fisher * @author Diego Belfer diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java index 9ebdb15eb0..a633fccef6 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/BaseIntegrationFlowDefinition.java @@ -896,7 +896,7 @@ public abstract class BaseIntegrationFlowDefinition + * . * @param messageHandlerSpec the {@link MessageHandlerSpec} to configure protocol specific * {@link MessageHandler}. * @param the target {@link MessageHandler} type. @@ -1747,7 +1747,7 @@ public abstract class BaseIntegrationFlowDefinition aggregator.processor(aggregatorProcessor))} + * A short-cut for the {@code aggregate((aggregator) -> aggregator.processor(aggregatorProcessor))}. * @param aggregatorProcessor the POJO representing aggregation strategies. * @return the current {@link BaseIntegrationFlowDefinition}. * @since 5.5 diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/CorrelationHandlerSpec.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/CorrelationHandlerSpec.java index ab17df8ee1..7951ca7545 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/CorrelationHandlerSpec.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/CorrelationHandlerSpec.java @@ -340,8 +340,8 @@ public abstract class CorrelationHandlerSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec correlationIdFunction(Function, Object> correlationIdFunction) { return correlationIdFunction(correlationIdFunction, null); @@ -366,8 +366,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec correlationIdFunction(Function, ?> correlationIdFunction, Boolean overwrite) { @@ -430,8 +430,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec replyChannelFunction(Function, Object> replyChannelFunction) { return replyChannelFunction(replyChannelFunction, null); @@ -444,8 +444,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec replyChannelFunction(Function, ?> replyChannelFunction, Boolean overwrite) { @@ -508,8 +508,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec errorChannelFunction(Function, Object> errorChannelFunction) { return errorChannelFunction(errorChannelFunction, null); @@ -522,8 +522,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec errorChannelFunction(Function, ?> errorChannelFunction, Boolean overwrite) { @@ -586,8 +586,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec priorityFunction(Function, Object> priorityFunction) { return priorityFunction(priorityFunction, null); @@ -600,8 +600,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec priorityFunction(Function, ?> priorityFunction, Boolean overwrite) { return headerFunction(IntegrationMessageHeaderAccessor.PRIORITY, priorityFunction, overwrite); @@ -664,8 +664,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec expirationDateFunction(Function, Object> expirationDateFunction) { return expirationDateFunction(expirationDateFunction, null); @@ -678,8 +678,8 @@ public class HeaderEnricherSpec extends ConsumerEndpointSpec the payload type. * @return the header enricher spec. - * @see FunctionExpression * @since 5.2 + * @see FunctionExpression */ public

HeaderEnricherSpec expirationDateFunction(Function, ?> expirationDateFunction, Boolean overwrite) { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/MessageProducerSpec.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/MessageProducerSpec.java index b00daeefe7..37baf9fd3a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/MessageProducerSpec.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/MessageProducerSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2019 the original author or authors. + * Copyright 2016-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. @@ -70,7 +70,7 @@ public abstract class MessageProducerSpec, P /** * Specify the {@code outputChannel} for the - * {@link org.springframework.integration.core.MessageProducer} + * {@link org.springframework.integration.core.MessageProducer}. * @param outputChannel the outputChannel. * @return the spec. * @see MessageProducerSupport#setOutputChannel(MessageChannel) @@ -82,7 +82,7 @@ public abstract class MessageProducerSpec, P /** * Specify the bean name of the {@code outputChannel} for the - * {@link org.springframework.integration.core.MessageProducer} + * {@link org.springframework.integration.core.MessageProducer}. * @param outputChannel the outputChannel bean name. * @return the spec. * @see MessageProducerSupport#setOutputChannelName(String) diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/ReactiveMessageHandlerSpec.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/ReactiveMessageHandlerSpec.java index 6074e2f38d..e425f68595 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/ReactiveMessageHandlerSpec.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/ReactiveMessageHandlerSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-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. @@ -25,6 +25,9 @@ import org.springframework.messaging.ReactiveMessageHandler; /** * The {@link MessageHandlerSpec} extension for {@link ReactiveMessageHandler}. * + * @param the target spec type. + * @param the target message handler type. + * * @author Artem Bilan * * @since 5.4 diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/RouterSpec.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/RouterSpec.java index f512aa8ed2..d038f3ba5f 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/RouterSpec.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/RouterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -162,8 +162,8 @@ public final class RouterSpec * @param key the key. * @param channel the {@link MessageChannel} instance to use. * @return the router spec. - * @see AbstractMappingMessageRouter#setChannelMapping(String, String) * @since 5.2 + * @see AbstractMappingMessageRouter#setChannelMapping(String, String) */ public RouterSpec channelMapping(K key, final MessageChannel channel) { Assert.notNull(key, "'key' must not be null"); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/dsl/context/IntegrationFlowContext.java b/spring-integration-core/src/main/java/org/springframework/integration/dsl/context/IntegrationFlowContext.java index 8480219612..9224e53b4a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/dsl/context/IntegrationFlowContext.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/dsl/context/IntegrationFlowContext.java @@ -1,5 +1,5 @@ /* - * Copyright 2018-2020 the original author or authors. + * Copyright 2018-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. @@ -218,8 +218,8 @@ public interface IntegrationFlowContext { * while retaining the ability to reference beans within the flow; adding the unique * flow id to the bean name makes the name unique. * @return the current builder instance. - * @see #id(String) * @since 5.0.6 + * @see #id(String) */ default IntegrationFlowRegistrationBuilder useFlowIdAsPrefix() { return this; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/endpoint/AbstractFetchLimitingMessageSource.java b/spring-integration-core/src/main/java/org/springframework/integration/endpoint/AbstractFetchLimitingMessageSource.java index 0232cfa6e0..98c9e41f37 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/endpoint/AbstractFetchLimitingMessageSource.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/endpoint/AbstractFetchLimitingMessageSource.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2019 the original author or authors. + * Copyright 2016-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,9 +21,11 @@ import org.springframework.integration.support.management.MessageSourceManagemen /** * A message source that can limit the number of remote objects it fetches. * - * @author Gary Russell - * @since 5.0 + * @param the expected payload type. * + * @author Gary Russell + * + * @since 5.0 */ public abstract class AbstractFetchLimitingMessageSource extends AbstractMessageSource implements MessageSourceManagement { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ExpressionEvaluatingMessageSource.java b/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ExpressionEvaluatingMessageSource.java index def663c6ea..b58db128ad 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ExpressionEvaluatingMessageSource.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ExpressionEvaluatingMessageSource.java @@ -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. @@ -21,8 +21,11 @@ import org.springframework.integration.context.ExpressionCapable; import org.springframework.util.Assert; /** + * @param the expected payload type. + * * @author Mark Fisher * @author Gary Russell + * * @since 2.0 */ public class ExpressionEvaluatingMessageSource extends AbstractMessageSource implements ExpressionCapable { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ReactiveMessageSourceProducer.java b/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ReactiveMessageSourceProducer.java index a18aa17e64..35f1834b4b 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ReactiveMessageSourceProducer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/endpoint/ReactiveMessageSourceProducer.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-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. @@ -27,7 +27,7 @@ import reactor.core.publisher.Flux; /** * The {@link MessageProducerSupport} to adapt a provided {@link MessageSource} - * into a {@link Flux} and let it be subscribed in the {@link #subscribeToPublisher} + * into a {@link Flux} and let it be subscribed in the {@link #subscribeToPublisher}. * * @author Artem Bilan * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/expression/ReloadableResourceBundleExpressionSource.java b/spring-integration-core/src/main/java/org/springframework/integration/expression/ReloadableResourceBundleExpressionSource.java index e876b37702..57b930292c 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/expression/ReloadableResourceBundleExpressionSource.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/expression/ReloadableResourceBundleExpressionSource.java @@ -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. @@ -76,17 +76,17 @@ public class ReloadableResourceBundleExpressionSource implements ExpressionSourc /** - * Cache to hold filename lists per Locale + * Cache to hold filename lists per Locale. */ private final Map>> cachedFilenames = new HashMap<>(); /** - * Cache to hold already loaded properties per filename + * Cache to hold already loaded properties per filename. */ private final Map cachedProperties = new HashMap<>(); /** - * Cache to hold merged loaded properties per locale + * Cache to hold merged loaded properties per locale. */ private final Map cachedMergedProperties = new HashMap<>(); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/expression/ValueExpression.java b/spring-integration-core/src/main/java/org/springframework/integration/expression/ValueExpression.java index d529099514..9bb0081ca7 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/expression/ValueExpression.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/expression/ValueExpression.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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. @@ -31,11 +31,14 @@ import org.springframework.util.Assert; * * @author Artem Bilan * @author Gary Russell + * * @since 4.0 */ public class ValueExpression implements Expression { - /** Fixed value of this expression */ + /** + * Fixed value of this expression. + */ private final V value; private final Class aClass; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/gateway/RequestReplyMessageHandlerAdapter.java b/spring-integration-core/src/main/java/org/springframework/integration/gateway/RequestReplyMessageHandlerAdapter.java index a8ca6a5513..fa820c67ff 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/gateway/RequestReplyMessageHandlerAdapter.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/gateway/RequestReplyMessageHandlerAdapter.java @@ -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. @@ -27,15 +27,13 @@ import org.springframework.util.Assert; * @author Oleg Zhurakousky * @author Mark Fisher * @author Gary Russell + * * @since 2.0 */ class RequestReplyMessageHandlerAdapter extends AbstractReplyProducingMessageHandler { private final RequestReplyExchanger exchanger; - /** - * @param exchanger - */ RequestReplyMessageHandlerAdapter(RequestReplyExchanger exchanger) { Assert.notNull(exchanger, "exchanger must not be null"); this.exchanger = exchanger; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProcessor.java index e1f3058f9a..364f2541b5 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProcessor.java @@ -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. @@ -21,6 +21,8 @@ import org.springframework.lang.Nullable; import org.springframework.messaging.Message; /** + * @param the expected payload type. + * * @author Mark Fisher * @author Dave Syer * @author Artem Bilan diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProducingHandler.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProducingHandler.java index ebc1da0c6f..b6b8481696 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProducingHandler.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageProducingHandler.java @@ -117,9 +117,9 @@ public abstract class AbstractMessageProducingHandler extends AbstractMessageHan } /** - * @see #setAsync(boolean) * @return true if this handler supports async replies. * @since 4.3 + * @see #setAsync(boolean) */ protected boolean isAsync() { return this.async; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/DelayHandler.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/DelayHandler.java index babfe92d5a..1f0fd45f44 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/DelayHandler.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/DelayHandler.java @@ -227,9 +227,9 @@ public class DelayHandler extends AbstractReplyProducingMessageHandler implement * If there is a transaction advice on the release task, the error flow is called * within the transaction. * @param delayedMessageErrorChannel the channel. + * @since 5.0.8 * @see #setMaxAttempts(int) * @see #setRetryDelay(long) - * @since 5.0.8 */ public void setDelayedMessageErrorChannel(MessageChannel delayedMessageErrorChannel) { this.delayedMessageErrorChannel = delayedMessageErrorChannel; @@ -242,9 +242,9 @@ public class DelayHandler extends AbstractReplyProducingMessageHandler implement * If there is a transaction advice on the release task, the error flow is called * within the transaction. * @param delayedMessageErrorChannelName the channel name. + * @since 5.0.8 * @see #setMaxAttempts(int) * @see #setRetryDelay(long) - * @since 5.0.8 */ public void setDelayedMessageErrorChannelName(String delayedMessageErrorChannelName) { this.delayedMessageErrorChannelName = delayedMessageErrorChannelName; @@ -254,8 +254,8 @@ public class DelayHandler extends AbstractReplyProducingMessageHandler implement * Set the maximum number of release attempts for when message release fails. Default * {@value #DEFAULT_MAX_ATTEMPTS}. * @param maxAttempts the max attempts. - * @see #setRetryDelay(long) * @since 5.0.8 + * @see #setRetryDelay(long) */ public void setMaxAttempts(int maxAttempts) { this.maxAttempts = maxAttempts; @@ -265,8 +265,8 @@ public class DelayHandler extends AbstractReplyProducingMessageHandler implement * Set an additional delay to apply when retrying after a release failure. Default * {@value #DEFAULT_RETRY_DELAY}. * @param retryDelay the retry delay. - * @see #setMaxAttempts(int) * @since 5.0.8 + * @see #setMaxAttempts(int) */ public void setRetryDelay(long retryDelay) { this.retryDelay = retryDelay; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageHandler.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageHandler.java index 99f54971d5..365e79a9ca 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageHandler.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageHandler.java @@ -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. @@ -26,23 +26,24 @@ import org.springframework.util.Assert; * * @author Artem Bilan * @author Gary Russell - * @see MethodInvokingMessageHandler + * * @since 2.1 + * + * @see MethodInvokingMessageHandler */ public class ExpressionEvaluatingMessageHandler extends AbstractMessageHandler { - private volatile ExpressionEvaluatingMessageProcessor processor; + private final ExpressionEvaluatingMessageProcessor processor; - private volatile String componentType; + private String componentType; public ExpressionEvaluatingMessageHandler(Expression expression) { Assert.notNull(expression, "'expression' must not be null"); - this.processor = new ExpressionEvaluatingMessageProcessor(expression, Void.class); + this.processor = new ExpressionEvaluatingMessageProcessor<>(expression, Void.class); setPrimaryExpression(expression); } - public void setComponentType(String componentType) { this.componentType = componentType; } diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageProcessor.java index 5bdd3d865c..613eb761c5 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/ExpressionEvaluatingMessageProcessor.java @@ -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. @@ -26,6 +26,8 @@ import org.springframework.util.Assert; * A {@link MessageProcessor} implementation that evaluates a SpEL expression * with the Message itself as the root object within the evaluation context. * + * @param the expected payload type. + * * @author Mark Fisher * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageHandlerChain.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageHandlerChain.java index eeae70cffb..431a9f8f87 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageHandlerChain.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageHandlerChain.java @@ -161,10 +161,6 @@ public class MessageHandlerChain extends AbstractMessageProducingHandler return false; } - /** - * SmartLifecycle implementation (delegates to the {@link #handlers}) - */ - @Override public final boolean isRunning() { this.lifecycleLock.lock(); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageProcessor.java index e1eccb3520..a1b9215a9d 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/MessageProcessor.java @@ -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. @@ -37,6 +37,8 @@ import org.springframework.messaging.Message; * internal "support" API, intended for use by Spring Integration's various * message-handling components. As such, it is subject to change. * + * @param the expected payload type. + * * @author Mark Fisher * @author Artem Bilan * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/MethodInvokingMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/MethodInvokingMessageProcessor.java index aa5b5a2868..4440630492 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/MethodInvokingMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/MethodInvokingMessageProcessor.java @@ -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. @@ -36,6 +36,8 @@ import org.springframework.messaging.Message; * SpEL's method resolution are determined by the presence of that * annotation rather than the method name. * + * @param the expected payload type. + * * @author Dave Syer * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/handler/advice/IdempotentReceiverInterceptor.java b/spring-integration-core/src/main/java/org/springframework/integration/handler/advice/IdempotentReceiverInterceptor.java index 73e94b3fc7..28c1ffaa4c 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/handler/advice/IdempotentReceiverInterceptor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/handler/advice/IdempotentReceiverInterceptor.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2020 the original author or authors. + * Copyright 2014-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. @@ -128,8 +128,8 @@ public class IdempotentReceiverInterceptor extends AbstractHandleMessageAdvice { * Only applies if a {@link #setDiscardChannel(MessageChannel) discardChannel} * is not provided. * @param discardChannelName The discard channel name. - * @see #setThrowExceptionOnRejection(boolean) * @since 5.0.1 + * @see #setThrowExceptionOnRejection(boolean) */ public void setDiscardChannelName(String discardChannelName) { this.discardChannelName = discardChannelName; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/json/ObjectToJsonTransformer.java b/spring-integration-core/src/main/java/org/springframework/integration/json/ObjectToJsonTransformer.java index 0635dad47d..1f631a9098 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/json/ObjectToJsonTransformer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/json/ObjectToJsonTransformer.java @@ -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. @@ -96,8 +96,7 @@ public class ObjectToJsonTransformer extends AbstractTransformer { } /** - * Sets the content-type header value - * + * Set the content-type header value. * @param contentType The content type. */ public void setContentType(String contentType) { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/mapping/AbstractHeaderMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/mapping/AbstractHeaderMapper.java index 11e8511fae..a737518b36 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/mapping/AbstractHeaderMapper.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/mapping/AbstractHeaderMapper.java @@ -43,6 +43,8 @@ import org.springframework.util.StringUtils; /** * Abstract base class for {@link RequestReplyHeaderMapper} implementations. * + * @param the target headers container type. + * * @author Mark Fisher * @author Oleg Zhurakousky * @author Stephane Nicoll diff --git a/spring-integration-core/src/main/java/org/springframework/integration/mapping/ConvertingBytesMessageMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/mapping/ConvertingBytesMessageMapper.java index 099f023402..7c57666f5f 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/mapping/ConvertingBytesMessageMapper.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/mapping/ConvertingBytesMessageMapper.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-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.util.Assert; * {@link MessageConverter#fromMessage(Message, Class)} and {@link MessageConverter#toMessage(Object, MessageHeaders)} * methods. *

- * If {@link MessageConverter#fromMessage(Message, Class)} returns {@link String}, it is converted to {@link byte[]} + * If {@link MessageConverter#fromMessage(Message, Class)} returns {@link String}, it is converted to {@code byte[]} * using a {@link StandardCharsets#UTF_8} encoding. * * @author Artem Bilan diff --git a/spring-integration-core/src/main/java/org/springframework/integration/mapping/HeaderMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/mapping/HeaderMapper.java index 5c59b9c495..9ea7b4e437 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/mapping/HeaderMapper.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/mapping/HeaderMapper.java @@ -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. @@ -25,9 +25,9 @@ import org.springframework.messaging.MessageHeaders; * types of objects. This would typically be used by adapters where the "other type" * has a concept of headers or properties (HTTP, JMS, AMQP, etc). * - * @author Mark Fisher - * * @param type of the instance to and from which headers will be mapped. + * + * @author Mark Fisher */ public interface HeaderMapper { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/mapping/InboundMessageMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/mapping/InboundMessageMapper.java index faf9253c0a..fe126b18ba 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/mapping/InboundMessageMapper.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/mapping/InboundMessageMapper.java @@ -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. @@ -24,6 +24,8 @@ import org.springframework.messaging.Message; /** * Strategy interface for mapping from an Object to a{@link Message}. * + * @param the type of object to create message from. + * * @author Mark Fisher * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/mapping/OutboundMessageMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/mapping/OutboundMessageMapper.java index f2d3ba6c50..498b478127 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/mapping/OutboundMessageMapper.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/mapping/OutboundMessageMapper.java @@ -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. @@ -22,6 +22,8 @@ import org.springframework.messaging.Message; /** * Strategy interface for mapping from a {@link Message} to an Object. * + * @param the target result type. + * * @author Mark Fisher * @author Gary Russell */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/message/AdviceMessage.java b/spring-integration-core/src/main/java/org/springframework/integration/message/AdviceMessage.java index bd3df7a63f..a6a742cb15 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/message/AdviceMessage.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/message/AdviceMessage.java @@ -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. @@ -29,7 +29,9 @@ import org.springframework.messaging.support.GenericMessage; * Contains the result of the expression evaluation in the payload * and the original message that the advice passed to the * handler. - * . + * + * @param the payload type. + * * @author Gary Russell * @author Artem Bilan * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/metadata/ListenableMetadataStore.java b/spring-integration-core/src/main/java/org/springframework/integration/metadata/ListenableMetadataStore.java index 9fedb8943e..a3a9d8eea1 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/metadata/ListenableMetadataStore.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/metadata/ListenableMetadataStore.java @@ -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. @@ -22,20 +22,19 @@ package org.springframework.integration.metadata; * invoked when changes occur in the metadata store. * * @author Marius Bogoevici + * * @since 4.2 */ public interface ListenableMetadataStore extends ConcurrentMetadataStore { /** - * Registers a listener with the metadata store - * + * Register a listener with the metadata store. * @param callback the callback to be registered */ void addListener(MetadataStoreListener callback); /** - * Unregisters a listener - * + * Unregister a listener. * @param callback the callback to be unregistered */ void removeListener(MetadataStoreListener callback); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/metadata/MetadataStoreListener.java b/spring-integration-core/src/main/java/org/springframework/integration/metadata/MetadataStoreListener.java index 6b88b1dc5d..22af1859f9 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/metadata/MetadataStoreListener.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/metadata/MetadataStoreListener.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -20,30 +20,30 @@ package org.springframework.integration.metadata; * A callback to be invoked whenever a value changes in the data store. * * @author Marius Bogoevici + * * @since 4.2 */ public interface MetadataStoreListener { /** - * Invoked when a key is added to the store - * + * Invoked when a key is added to the store. * @param key the key being added * @param value the value being added */ void onAdd(String key, String value); /** - * Invoked when a key is removed from the store - * + * Invoked when a key is removed from the store. * @param key the key being removed * @param oldValue the value being removed */ void onRemove(String key, String oldValue); /** - * Invoked when a key is updated into the store + * Invoked when a key is updated into the store. * @param key the key being updated * @param newValue the new value */ void onUpdate(String key, String newValue); + } diff --git a/spring-integration-core/src/main/java/org/springframework/integration/router/AbstractMessageRouter.java b/spring-integration-core/src/main/java/org/springframework/integration/router/AbstractMessageRouter.java index 175a6d1edb..5528cdbcf3 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/router/AbstractMessageRouter.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/router/AbstractMessageRouter.java @@ -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. @@ -136,7 +136,7 @@ public abstract class AbstractMessageRouter extends AbstractMessageHandler imple } /** - * Provides {@link MessagingTemplate} access for subclasses + * Provide {@link MessagingTemplate} access for subclasses. * @return The messaging template. */ protected MessagingTemplate getMessagingTemplate() { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/store/AbstractKeyValueMessageStore.java b/spring-integration-core/src/main/java/org/springframework/integration/store/AbstractKeyValueMessageStore.java index a61f5a9adf..351f052852 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/store/AbstractKeyValueMessageStore.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/store/AbstractKeyValueMessageStore.java @@ -31,7 +31,7 @@ import org.springframework.messaging.Message; import org.springframework.util.Assert; /** - * Base class for implementations of Key/Value style {@link MessageGroupStore} and {@link MessageStore} + * Base class for implementations of Key/Value style {@link MessageGroupStore} and {@link MessageStore}. * * @author Oleg Zhurakousky * @author Gary Russell diff --git a/spring-integration-core/src/main/java/org/springframework/integration/store/BasicMessageGroupStore.java b/spring-integration-core/src/main/java/org/springframework/integration/store/BasicMessageGroupStore.java index c61e926f83..35b87b4e83 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/store/BasicMessageGroupStore.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/store/BasicMessageGroupStore.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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,14 +23,14 @@ import org.springframework.messaging.Message; * Defines a minimal message group store with basic capabilities. * * @author Gary Russell + * * @since 4.0 * */ public interface BasicMessageGroupStore { /** - * Returns the size of this MessageGroup. - * + * Return the size of this MessageGroup. * @param groupId The group identifier. * @return The size. */ @@ -40,7 +40,6 @@ public interface BasicMessageGroupStore { /** * Return all Messages currently in the MessageStore that were stored using * {@link #addMessageToGroup(Object, Message)} with this group id. - * * @param groupId The group identifier. * @return A group of messages, empty if none exists for this key. */ @@ -48,7 +47,6 @@ public interface BasicMessageGroupStore { /** * Store a message with an association to a group id. This can be used to group messages together. - * * @param groupId The group id to store the message under. * @param message A message. * @return The message group. @@ -56,9 +54,8 @@ public interface BasicMessageGroupStore { MessageGroup addMessageToGroup(Object groupId, Message message); /** - * Polls Message from this {@link MessageGroup} (in FIFO style if supported by the implementation) - * while also removing the polled {@link Message} - * + * Poll Message from this {@link MessageGroup} (in FIFO style if supported by the implementation) + * while also removing the polled {@link Message}. * @param groupId The group identifier. * @return The message. */ @@ -66,7 +63,6 @@ public interface BasicMessageGroupStore { /** * Remove the message group with this id. - * * @param groupId The id of the group to remove. */ void removeMessageGroup(Object groupId); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroup.java b/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroup.java index d4f1aea565..4ba7560b34 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroup.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroup.java @@ -58,7 +58,7 @@ public interface MessageGroup { boolean remove(Message messageToRemove); /** - * Return all available Messages from the group at the time of invocation + * Return all available Messages from the group at the time of invocation. * @return The messages. */ Collection> getMessages(); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroupQueue.java b/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroupQueue.java index 4205b42700..3bfbf031c3 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroupQueue.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/store/MessageGroupQueue.java @@ -350,7 +350,7 @@ public class MessageGroupQueue extends AbstractQueue> implements Bloc /** * It is assumed that the 'storeLock' is being held by the caller, otherwise - * IllegalMonitorStateException may be thrown + * IllegalMonitorStateException may be thrown. * @return a message // TODO @Nullable */ protected Message doPoll() { @@ -361,7 +361,7 @@ public class MessageGroupQueue extends AbstractQueue> implements Bloc /** * It is assumed that the 'storeLock' is being held by the caller, otherwise - * IllegalMonitorStateException may be thrown + * IllegalMonitorStateException may be thrown. * @param message the message to offer. * @return true if offered. */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/store/SimpleMessageStore.java b/spring-integration-core/src/main/java/org/springframework/integration/store/SimpleMessageStore.java index 9126b5a22f..f901f1062f 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/store/SimpleMessageStore.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/store/SimpleMessageStore.java @@ -90,13 +90,13 @@ public class SimpleMessageStore extends AbstractMessageGroupStore } /** - * Creates a SimpleMessageStore with a maximum size limited by the given capacity and the timeout in millisecond + * Create a SimpleMessageStore with a maximum size limited by the given capacity and the timeout in millisecond * to wait for the empty slot in the store. * @param individualCapacity The message capacity. * @param groupCapacity The capacity of each group. * @param upperBoundTimeout The time to wait if the store is at max capacity. - * @see #SimpleMessageStore(int, int) * @since 4.3 + * @see #SimpleMessageStore(int, int) */ public SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout) { this(individualCapacity, groupCapacity, upperBoundTimeout, new DefaultLockRegistry()); @@ -145,14 +145,14 @@ public class SimpleMessageStore extends AbstractMessageGroupStore } /** - * Creates a SimpleMessageStore with unlimited capacity + * Create a SimpleMessageStore with unlimited capacity. */ public SimpleMessageStore() { this(0); } /** - * Set to false to disable copying the group in {@link #getMessageGroup(Object)}. + * Set as false to disable copying the group in {@link #getMessageGroup(Object)}. * Starting with 4.1, this is false by default. * @param copyOnGet True to copy, false to not. * @since 4.0.1 diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/AbstractIntegrationMessageBuilder.java b/spring-integration-core/src/main/java/org/springframework/integration/support/AbstractIntegrationMessageBuilder.java index 557508e90a..c07159c643 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/AbstractIntegrationMessageBuilder.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/AbstractIntegrationMessageBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2020 the original author or authors. + * Copyright 2014-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. @@ -34,6 +34,8 @@ import org.springframework.util.ObjectUtils; import org.springframework.util.PatternMatchUtils; /** + * @param the payload type. + * * @author Gary Russell * @author Artem Bilan * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/IdGenerators.java b/spring-integration-core/src/main/java/org/springframework/integration/support/IdGenerators.java index c7d34ef49e..db33e9ad49 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/IdGenerators.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/IdGenerators.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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. @@ -27,13 +27,14 @@ import org.springframework.util.IdGenerator; * * @author Andy Wilkinson * @author Gary Russell + * * @since 4.0 * */ public class IdGenerators { /** - * UUID.randomUUID() + * UUID.randomUUID(). * */ public static class JdkIdGenerator implements IdGenerator { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/MessageBuilder.java b/spring-integration-core/src/main/java/org/springframework/integration/support/MessageBuilder.java index 6c6fde2e31..afa32a8279 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/MessageBuilder.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/MessageBuilder.java @@ -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. @@ -39,6 +39,8 @@ import org.springframework.util.ObjectUtils; * Named MessageBuilder instead of DefaultMessageBuilder for backwards * compatibility. * + * @param the payload type. + * * @author Arjen Poutsma * @author Mark Fisher * @author Oleg Zhurakousky diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessage.java b/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessage.java index 3c2ba78eb6..1695096ae9 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessage.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessage.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2020 the original author or authors. + * Copyright 2014-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. @@ -42,6 +42,8 @@ import org.springframework.util.ObjectUtils; * It is generally recommended that messages transferred between components should * always be immutable unless great care is taken with their use. * + * @param the payload type. + * * @author Gary Russell * @author Artem Bilan * @author Stuart Williams diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessageBuilder.java b/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessageBuilder.java index 731aee7c3b..33313f9ba9 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessageBuilder.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/MutableMessageBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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. @@ -41,6 +41,8 @@ import org.springframework.util.StringUtils; * It is generally recommended that messages transferred between components should * always be immutable unless great care is taken with their use. * + * @param the payload type. + * * @author Gary Russell * @author Artem Bilan * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/PartialSuccessException.java b/spring-integration-core/src/main/java/org/springframework/integration/support/PartialSuccessException.java index 845e3cec71..a7649420ea 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/PartialSuccessException.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/PartialSuccessException.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -72,7 +72,7 @@ public class PartialSuccessException extends MessagingException { } /** - * Convenience version of {@link #getPartialResults()} to avoid casting + * Convenience version of {@link #getPartialResults()} to avoid casting. * @param clazz the type. * @param the result type. * @return the partial results. @@ -83,7 +83,7 @@ public class PartialSuccessException extends MessagingException { } /** - * Convenience version of {@link #getDerivedInput()} to avoid casting + * Convenience version of {@link #getDerivedInput()} to avoid casting. * @param clazz the type. * @param the type of input. * @return the partial results. diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJacksonJsonMessageParser.java b/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJacksonJsonMessageParser.java index 9c038d0756..47341ed612 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJacksonJsonMessageParser.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJacksonJsonMessageParser.java @@ -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. @@ -31,6 +31,8 @@ import org.springframework.messaging.Message; /** * Base {@link JsonInboundMessageMapper.JsonMessageParser} implementation for Jackson processors. * + * @param

the payload type. + * * @author Artem Bilan * * @since 3.0 diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJsonInboundMessageMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJsonInboundMessageMapper.java index 1aaa1c484b..aeb3371409 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJsonInboundMessageMapper.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/json/AbstractJsonInboundMessageMapper.java @@ -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. @@ -28,16 +28,20 @@ import org.springframework.util.Assert; * Abstract {@link InboundMessageMapper} implementation that maps incoming JSON messages * to a {@link org.springframework.messaging.Message} with the specified payload type. * + * @param

the payload type. + * * @author Artem Bilan * @author Gary Russell + * * @since 3.0 * * @see JsonInboundMessageMapper */ public abstract class AbstractJsonInboundMessageMapper

implements InboundMessageMapper { - protected static final String MESSAGE_FORMAT_ERROR = "JSON message is invalid. Expected a message in the format of either " + - "{\"headers\":{...},\"payload\":{...}} or {\"payload\":{...}.\"headers\":{...}} but was "; + protected static final String MESSAGE_FORMAT_ERROR = + "JSON message is invalid. Expected a message in the format of either " + + "{\"headers\":{...},\"payload\":{...}} or {\"payload\":{...}.\"headers\":{...}} but was "; protected static final Map> DEFAULT_HEADER_TYPES = new HashMap>(); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/json/MessageJacksonDeserializer.java b/spring-integration-core/src/main/java/org/springframework/integration/support/json/MessageJacksonDeserializer.java index ca2af66bf3..fcccc08616 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/json/MessageJacksonDeserializer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/json/MessageJacksonDeserializer.java @@ -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. @@ -34,6 +34,8 @@ import com.fasterxml.jackson.databind.type.TypeFactory; /** * A Jackson {@link StdNodeBasedDeserializer} extension for {@link Message} implementations. * + * @param the message type. + * * @author Artem Bilan * * @since 4.3.10 diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiator.java b/spring-integration-core/src/main/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiator.java index d268ce1774..a646dfeeab 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiator.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/leader/LockRegistryLeaderInitiator.java @@ -108,7 +108,7 @@ public class LockRegistryLeaderInitiator implements SmartLifecycle, DisposableBe /** * Flag to denote whether the {@link ExecutorService} was provided via the setter and - * thus should not be shutdown when {@link #destroy()} is called + * thus should not be shutdown when {@link #destroy()} is called. */ private boolean executorServiceExplicitlySet; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/LockRegistry.java b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/LockRegistry.java index 0d901519ff..7fa229fb99 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/locks/LockRegistry.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/locks/LockRegistry.java @@ -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. @@ -19,10 +19,11 @@ package org.springframework.integration.support.locks; import java.util.concurrent.locks.Lock; /** - * Strategy for maintaining a registry of shared locks + * Strategy for maintaining a registry of shared locks. * * @author Oleg Zhurakousky * @author Gary Russell + * * @since 2.1.1 */ @FunctionalInterface diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/management/IntegrationManagement.java b/spring-integration-core/src/main/java/org/springframework/integration/support/management/IntegrationManagement.java index 7ddbc34694..0bb5de4685 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/management/IntegrationManagement.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/management/IntegrationManagement.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2020 the original author or authors. + * Copyright 2015-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. @@ -79,7 +79,7 @@ public interface IntegrationManagement extends NamedComponent, DisposableBean { } /** - * Inject a {@link MetricsCaptor} + * Inject a {@link MetricsCaptor}. * @param captor the captor. * @since 5.0.4 */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/utils/IntegrationUtils.java b/spring-integration-core/src/main/java/org/springframework/integration/support/utils/IntegrationUtils.java index 8fe4fc9bf5..02e104f8ec 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/utils/IntegrationUtils.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/utils/IntegrationUtils.java @@ -115,7 +115,7 @@ public final class IntegrationUtils { } /** - * Utility method for null-safe conversion from String to byte[] + * Utility method for null-safe conversion from String to byte[]. * @param value the String to be converted * @param encoding the encoding * @return the byte[] corresponding to the given String and encoding, null if provided String argument was null @@ -131,7 +131,7 @@ public final class IntegrationUtils { } /** - * Utility method for null-safe conversion from byte[] to String + * Utility method for null-safe conversion from byte[] to String. * @param bytes the byte[] to be converted * @param encoding the encoding * @return the String corresponding to the given byte[] and encoding, null if provided byte[] argument was null diff --git a/spring-integration-core/src/main/java/org/springframework/integration/support/utils/PatternMatchUtils.java b/spring-integration-core/src/main/java/org/springframework/integration/support/utils/PatternMatchUtils.java index f60295fba6..c6c70bb4af 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/support/utils/PatternMatchUtils.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/support/utils/PatternMatchUtils.java @@ -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. @@ -42,8 +42,8 @@ public final class PatternMatchUtils { * @param str the string to match. * @param patterns the patterns. * @return true for positive match; false for negative; null if no pattern matches. - * @see org.springframework.util.PatternMatchUtils#simpleMatch(String[], String) * @since 5.0.5 + * @see org.springframework.util.PatternMatchUtils#simpleMatch(String[], String) */ public static Boolean smartMatchIgnoreCase(String str, String... patterns) { if (patterns != null) { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transaction/IntegrationResourceHolder.java b/spring-integration-core/src/main/java/org/springframework/integration/transaction/IntegrationResourceHolder.java index adfd1e2583..6119241bb6 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transaction/IntegrationResourceHolder.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transaction/IntegrationResourceHolder.java @@ -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. @@ -25,10 +25,11 @@ import org.springframework.transaction.support.ResourceHolder; /** * An implementation of the {@link ResourceHolder} which holds an instance of the current Message - * and the synchronization resource + * and the synchronization resource. * * @author Gary Russell * @author Oleg Zhurakousky + * * @since 2.2 * */ @@ -40,7 +41,7 @@ public class IntegrationResourceHolder implements ResourceHolder { private volatile Message message; - private final Map attributes = new HashMap(); + private final Map attributes = new HashMap<>(); public void setMessage(Message message) { this.message = message; @@ -51,8 +52,7 @@ public class IntegrationResourceHolder implements ResourceHolder { } /** - * Adds attribute to this {@link ResourceHolder} instance - * + * Add attribute to this {@link ResourceHolder} instance. * @param key The key. * @param value The value. */ @@ -63,7 +63,6 @@ public class IntegrationResourceHolder implements ResourceHolder { /** * Will return an immutable Map of current attributes. * If you need to add an attribute, use the {@link #addAttribute(String, Object)} method. - * * @return the immutable map. */ public Map getAttributes() { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationFactory.java b/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationFactory.java index bac6b73cc4..bc4e85904a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationFactory.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationFactory.java @@ -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. @@ -17,14 +17,17 @@ package org.springframework.integration.transaction; import org.springframework.transaction.support.TransactionSynchronization; + /** - * Strategy for implementing factories that create {@link TransactionSynchronization} + * Strategy for implementing factories that create {@link TransactionSynchronization}. * * @author Oleg Zhurakousky + * * @since 2.2 * */ public interface TransactionSynchronizationFactory { TransactionSynchronization create(Object key); + } diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationProcessor.java index ea3932a6e3..e174c4d0e4 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transaction/TransactionSynchronizationProcessor.java @@ -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. @@ -17,10 +17,11 @@ package org.springframework.integration.transaction; /** - * Strategy for implementing transaction synchronization processors + * Strategy for implementing transaction synchronization processors. * * @author Oleg Zhurakousky * @author Gary Russell + * * @since 2.2 * */ diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/AbstractPayloadTransformer.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/AbstractPayloadTransformer.java index f8285bf252..a6d969f65b 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/AbstractPayloadTransformer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/AbstractPayloadTransformer.java @@ -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. @@ -24,6 +24,9 @@ import org.springframework.messaging.Message; * used as the result. Otherwise, the return value will be used as the payload * of the result Message. * + * @param inbound payload type. + * @param outbound payload type. + * * @author Mark Fisher */ public abstract class AbstractPayloadTransformer extends AbstractTransformer { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/ContentEnricher.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/ContentEnricher.java index e2ae27b564..7f0dbd6cac 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/ContentEnricher.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/ContentEnricher.java @@ -64,7 +64,7 @@ import org.springframework.util.ReflectionUtils; public class ContentEnricher extends AbstractReplyProducingMessageHandler implements ManageableLifecycle { /** - * Customized SpelExpressionParser to allow to specify nested properties when parent is null + * Customized SpelExpressionParser to allow to specify nested properties when parent is null. */ private static final SpelExpressionParser SPEL_PARSER = new SpelExpressionParser(new SpelParserConfiguration(true, true)); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/DecodingTransformer.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/DecodingTransformer.java index 664a31b108..e7419a04fc 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/DecodingTransformer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/DecodingTransformer.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -30,9 +30,11 @@ import org.springframework.util.Assert; * {@link AbstractPayloadTransformer} that delegates to a codec to decode the * payload from a byte[]. * - * @author Gary Russell - * @since 4.2 + * @param the payload type. * + * @author Gary Russell + * + * @since 4.2 */ public class DecodingTransformer extends AbstractTransformer { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/EncodingPayloadTransformer.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/EncodingPayloadTransformer.java index db2a4d4000..66faae7fb0 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/EncodingPayloadTransformer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/EncodingPayloadTransformer.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -26,9 +26,11 @@ import org.springframework.util.Assert; * {@link AbstractPayloadTransformer} that delegates to a codec to encode the * payload into a byte[]. * - * @author Gary Russell - * @since 4.2 + * @param inbound payload type. * + * @author Gary Russell + * + * @since 4.2 */ public class EncodingPayloadTransformer extends AbstractPayloadTransformer { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/PayloadTypeConvertingTransformer.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/PayloadTypeConvertingTransformer.java index 235e082371..a55f6d144a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/PayloadTypeConvertingTransformer.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/PayloadTypeConvertingTransformer.java @@ -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. @@ -23,6 +23,9 @@ import org.springframework.util.Assert; * Transformer that converts the inbound payload to an object by delegating to a * Converter<Object, Object>. A reference to the delegate must be provided. * + * @param inbound payload type. + * @param outbound payload type. + * * @author Gary Russell * @author Artem Bilan * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/AbstractHeaderValueMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/AbstractHeaderValueMessageProcessor.java index fb53d5c4ca..d07536f394 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/AbstractHeaderValueMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/AbstractHeaderValueMessageProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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. @@ -17,19 +17,23 @@ package org.springframework.integration.transformer.support; /** + * @param inbound payload type. + * * @author Mark Fisher * @author Artem Bilan + * * @since 3.0 */ public abstract class AbstractHeaderValueMessageProcessor implements HeaderValueMessageProcessor { // null indicates no explicit setting - private volatile Boolean overwrite = null; + private Boolean overwrite = null; public void setOverwrite(Boolean overwrite) { this.overwrite = overwrite; } + @Override public Boolean isOverwrite() { return this.overwrite; } diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/ExpressionEvaluatingHeaderValueMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/ExpressionEvaluatingHeaderValueMessageProcessor.java index cd4bf2b364..af13c2fb81 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/ExpressionEvaluatingHeaderValueMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/ExpressionEvaluatingHeaderValueMessageProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2020 the original author or authors. + * Copyright 2013-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. @@ -26,6 +26,8 @@ import org.springframework.integration.handler.ExpressionEvaluatingMessageProces import org.springframework.messaging.Message; /** + * @param ther paylaod type. + * * @author Mark Fisher * @author Artem Bilan * @@ -34,8 +36,8 @@ import org.springframework.messaging.Message; public class ExpressionEvaluatingHeaderValueMessageProcessor extends AbstractHeaderValueMessageProcessor implements BeanFactoryAware { - private static final ExpressionParser EXPRESSION_PARSER = new SpelExpressionParser(new SpelParserConfiguration( - true, true)); + private static final ExpressionParser EXPRESSION_PARSER = + new SpelExpressionParser(new SpelParserConfiguration(true, true)); private final ExpressionEvaluatingMessageProcessor targetProcessor; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/HeaderValueMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/HeaderValueMessageProcessor.java index 12d8f0b201..c7de50d54a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/HeaderValueMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/HeaderValueMessageProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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. @@ -19,8 +19,11 @@ package org.springframework.integration.transformer.support; import org.springframework.integration.handler.MessageProcessor; /** + * @param the payload type. + * * @author Mark Fisher * @author Artem Bilan + * * @since 3.0 */ public interface HeaderValueMessageProcessor extends MessageProcessor { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/StaticHeaderValueMessageProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/StaticHeaderValueMessageProcessor.java index 0afd78a05b..6fff10dfd1 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/StaticHeaderValueMessageProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/transformer/support/StaticHeaderValueMessageProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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. @@ -19,8 +19,11 @@ package org.springframework.integration.transformer.support; import org.springframework.messaging.Message; /** + * @param the value type. + * * @author Mark Fisher * @author Artem Bilan + * * @since 3.0 */ public class StaticHeaderValueMessageProcessor extends AbstractHeaderValueMessageProcessor { @@ -31,7 +34,9 @@ public class StaticHeaderValueMessageProcessor extends AbstractHeaderValueMes this.value = value; } + @Override public T processMessage(Message message) { return this.value; } + } diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/AcceptOnceCollectionFilter.java b/spring-integration-core/src/main/java/org/springframework/integration/util/AcceptOnceCollectionFilter.java index f70ceb6a08..3506ddf74a 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/AcceptOnceCollectionFilter.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/AcceptOnceCollectionFilter.java @@ -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. @@ -25,7 +25,10 @@ import java.util.List; * An implementation of {@link CollectionFilter} that remembers the elements passed in * the previous invocation in order to avoid returning those elements more than once. * + * @param the collection element type. + * * @author Mark Fisher + * * @since 2.1 */ public class AcceptOnceCollectionFilter implements CollectionFilter { @@ -33,7 +36,7 @@ public class AcceptOnceCollectionFilter implements CollectionFilter { private volatile Collection lastSeenElements = Collections.emptyList(); public synchronized Collection filter(Collection unfilteredElements) { - List filteredElements = new ArrayList(); + List filteredElements = new ArrayList<>(); for (T element : unfilteredElements) { if (!this.lastSeenElements.contains(element)) { filteredElements.add(element); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/AnnotatedMethodFilter.java b/spring-integration-core/src/main/java/org/springframework/integration/util/AnnotatedMethodFilter.java index 287be62d9c..726764c750 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/AnnotatedMethodFilter.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/AnnotatedMethodFilter.java @@ -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. @@ -31,10 +31,10 @@ import org.springframework.util.StringUtils; *

  • matching on method name, if available
    • *
  • exclusion of void-returning methods if 'requiresReply' is true
    • *
  • limiting to annotated methods if at least one is present
    • - * - *

    + * . * * @author Mark Fisher + * * @since 2.0 */ public class AnnotatedMethodFilter implements MethodFilter { @@ -54,8 +54,8 @@ public class AnnotatedMethodFilter implements MethodFilter { public List filter(List methods) { - List annotatedCandidates = new ArrayList(); - List fallbackCandidates = new ArrayList(); + List annotatedCandidates = new ArrayList<>(); + List fallbackCandidates = new ArrayList<>(); for (Method method : methods) { if (method.isBridge()) { continue; diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/CloseableIterator.java b/spring-integration-core/src/main/java/org/springframework/integration/util/CloseableIterator.java index fc83252a64..e3b068dd93 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/CloseableIterator.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/CloseableIterator.java @@ -1,5 +1,5 @@ /* - * Copyright 2018-2019 the original author or authors. + * Copyright 2018-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. @@ -22,6 +22,8 @@ import java.util.Iterator; * A {@link CloseableIterator} is intended to be used when it may hold resources (such as file or socket handles). * This allows implementations to clean up any resources they need to keep open to iterate over elements. * + * @param the iterator element type. + * * @author Ruslan Stelmachenko * @author Gary Russell * diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/CollectionFilter.java b/spring-integration-core/src/main/java/org/springframework/integration/util/CollectionFilter.java index d1a4c99428..33797b354b 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/CollectionFilter.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/CollectionFilter.java @@ -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. @@ -21,8 +21,11 @@ import java.util.Collection; /** * Base strategy for filtering out a subset of a Collection of elements. * + * @param the collection element type. + * * @author Oleg Zhurakousky * @author Mark Fisher + * * @since 2.1 */ @FunctionalInterface diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/FunctionIterator.java b/spring-integration-core/src/main/java/org/springframework/integration/util/FunctionIterator.java index d9817449ea..5ca59f063f 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/FunctionIterator.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/FunctionIterator.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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. @@ -25,9 +25,13 @@ import org.springframework.lang.Nullable; * An {@link Iterator} implementation to convert each item from the target * {@link #iterator} to a new object applying the {@link #function} on {@link #next()}. * + * @param inbound iterator element type. + * @param outbound element type. + * * @author Artem Bilan * @author Ruslan Stelmachenko * @author Gary Russell + * * @since 4.1 */ public class FunctionIterator implements CloseableIterator { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/Pool.java b/spring-integration-core/src/main/java/org/springframework/integration/util/Pool.java index 351ae22f67..2c625375a1 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/Pool.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/Pool.java @@ -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. @@ -18,20 +18,24 @@ package org.springframework.integration.util; /** * Represents a pool of items. + * + * @param pool element type. + * * @author Gary Russell + * * @since 2.2 * */ public interface Pool { /** - * Obtains an item from the pool. + * Obtain an item from the pool. * @return the item. */ T getItem(); /** - * Releases an item back into the pool. This must be an item that + * Release an item back into the pool. This must be an item that * was previously retrieved using {@link #getItem()}. * @param t the item. * @throws IllegalArgumentException when a "foreign" object @@ -40,34 +44,34 @@ public interface Pool { void releaseItem(T t); /** - * Removes all idle items from the pool. + * Remove all idle items from the pool. */ void removeAllIdleItems(); /** - * Returns the current size (limit) of the pool. + * Return the current size (limit) of the pool. * @return the size. */ int getPoolSize(); /** - * Returns the number of items that have been allocated + * Return the number of items that have been allocated * but are not currently in use. * @return The number of items. */ int getIdleCount(); /** - * Returns the number of allocated items that are currently + * Return the number of allocated items that are currently * checked out of the pool. * @return The number of items. */ int getActiveCount(); /** - * Returns the current count of allocated items (in use and + * Return the current count of allocated items (in use and * idle). May be less than the pool size, and reflects the - * high water mark of pool usage. + * high watermark of pool usage. * @return the number of items. */ int getAllocatedCount(); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/SimplePool.java b/spring-integration-core/src/main/java/org/springframework/integration/util/SimplePool.java index 8cb5d46b32..649b3bd3df 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/SimplePool.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/SimplePool.java @@ -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,6 +35,8 @@ import org.springframework.util.Assert; * timeout when attempting to obtain an item from the pool. Pool grows on * demand up to the limit. * + * @param pool element type. + * * @author Gary Russell * @author Sergey Bogatyrev * @author Artem Bilan @@ -65,7 +67,7 @@ public class SimplePool implements Pool { private volatile boolean closed; /** - * Creates a SimplePool with a specific limit. + * Create a SimplePool with a specific limit. * @param poolSize The maximum number of items the pool supports. * @param callback A {@link PoolItemCallback} implementation called during various * pool operations. @@ -85,7 +87,7 @@ public class SimplePool implements Pool { } /** - * Adjusts the current pool size. When reducing the pool size, attempts to + * Adjust the current pool size. When reducing the pool size, attempts to * remove the delta from the pool. If there are not enough unused items in * the pool, the actual pool size will decrease to the specified size as in-use * items are returned. @@ -122,7 +124,7 @@ public class SimplePool implements Pool { } /** - * Returns the current size of the pool; may be greater than the target pool size + * Return the current size of the pool; may be greater than the target pool size * if it was recently reduced and too many items were in use to allow the new size * to be set. */ @@ -147,7 +149,7 @@ public class SimplePool implements Pool { } /** - * Adjusts the wait timeout - the time for which getItem() will wait if no idle + * Adjust the wait timeout - the time for which getItem() will wait if no idle * entries are available. *
    * Default: infinity. @@ -158,7 +160,7 @@ public class SimplePool implements Pool { } /** - * Obtains an item from the pool; waits up to waitTime milliseconds (default infinity). + * Obtain an item from the pool; waits up to waitTime milliseconds (default infinity). * @throws PoolItemNotAvailableException if no items become available in time. */ @Override @@ -213,7 +215,7 @@ public class SimplePool implements Pool { } /** - * Returns an item to the pool. + * Return an item to the pool. */ @Override public synchronized void releaseItem(T item) { @@ -268,6 +270,7 @@ public class SimplePool implements Pool { * User of the pool provide an implementation of this interface; called during * various pool operations. * + * @param pool item type. */ public interface PoolItemCallback { diff --git a/spring-integration-core/src/main/java/org/springframework/integration/util/WhileLockedProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/util/WhileLockedProcessor.java index f031ebf349..7586aa5119 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/util/WhileLockedProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/util/WhileLockedProcessor.java @@ -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. @@ -25,11 +25,12 @@ import org.springframework.messaging.MessagingException; /** * A simple strategy callback class that allows you to provide * a code that needs to be executed under {@link Lock} provided by - * {@link LockRegistry} + * {@link LockRegistry}. * A typical usage would be to provide implementation of {@link #whileLocked()} method and - * then call {@link #doWhileLocked()} + * then call {@link #doWhileLocked()}. * * @author Oleg Zhurakousky + * * @since 2.2 * */ @@ -64,7 +65,6 @@ public abstract class WhileLockedProcessor { /** * Override this method to provide the behavior that needs to be executed * while under the lock. - * * @throws IOException Any IOException. */ protected abstract void whileLocked() throws IOException; diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/DefaultDirectoryScanner.java b/spring-integration-file/src/main/java/org/springframework/integration/file/DefaultDirectoryScanner.java index 61a1712ec7..5c784ef289 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/DefaultDirectoryScanner.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/DefaultDirectoryScanner.java @@ -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. @@ -44,12 +44,12 @@ public class DefaultDirectoryScanner implements DirectoryScanner { private volatile FileLocker locker; /** - * Initializes {@link DefaultDirectoryScanner#filter} with a default list of + * Initialize {@link DefaultDirectoryScanner#filter} with a default list of * {@link FileListFilter}s using a {@link CompositeFileListFilter}: *

      *
    • {@link IgnoreHiddenFileListFilter}
      • *
    • {@link AcceptOnceFileListFilter}
      • - *
    + * . */ public DefaultDirectoryScanner() { final List> defaultFilters = new ArrayList<>(2); diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/FileHeaders.java b/spring-integration-file/src/main/java/org/springframework/integration/file/FileHeaders.java index afcdbd1842..bb1efcdab7 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/FileHeaders.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/FileHeaders.java @@ -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. @@ -43,22 +43,22 @@ public abstract class FileHeaders { public static final String SET_MODIFIED = PREFIX + "setModified"; /** - * Record is a file marker (START/END) + * Record is a file marker (START/END). */ public static final String MARKER = PREFIX + "marker"; /** - * The line count for END marker message after splitting + * The line count for END marker message after splitting. */ public static final String LINE_COUNT = PREFIX + "lineCount"; /** - * A remote file information representation + * A remote file information representation. */ public static final String REMOTE_FILE_INFO = PREFIX + "remoteFileInfo"; /** - * A remote host/port the file has been polled from + * A remote host/port the file has been polled from. */ public static final String REMOTE_HOST_PORT = PREFIX + "remoteHostPort"; diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/FileReadingMessageSource.java b/spring-integration-file/src/main/java/org/springframework/integration/file/FileReadingMessageSource.java index 1000d22e46..0764782e9d 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/FileReadingMessageSource.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/FileReadingMessageSource.java @@ -173,7 +173,7 @@ public class FileReadingMessageSource extends AbstractMessageSource implem /** * Optionally specify a custom scanner, for example the - * {@link WatchServiceDirectoryScanner} + * {@link WatchServiceDirectoryScanner}. * @param scanner scanner implementation */ public void setScanner(DirectoryScanner scanner) { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java b/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java index aedae518ef..3c56630c00 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java @@ -323,8 +323,8 @@ public class FileWritingMessageHandler extends AbstractReplyProducingMessageHand * {@code flushInterval} and {@code flushInterval * 1.33} with an average of * {@code flushInterval * 1.167}. * @param flushInterval the interval. - * @see #setFlushWhenIdle(boolean) * @since 4.3 + * @see #setFlushWhenIdle(boolean) */ public void setFlushInterval(long flushInterval) { this.flushInterval = flushInterval; @@ -336,9 +336,9 @@ public class FileWritingMessageHandler extends AbstractReplyProducingMessageHand * write to a previously flushed or new file. * @param flushWhenIdle false to flush on the interval after the first write * to a closed file. + * @since 4.3.7 * @see #setFlushInterval(long) * @see #setBufferSize(int) - * @since 4.3.7 */ public void setFlushWhenIdle(boolean flushWhenIdle) { this.flushWhenIdle = flushWhenIdle; @@ -372,8 +372,8 @@ public class FileWritingMessageHandler extends AbstractReplyProducingMessageHand /** * String setter for Spring XML convenience. * @param chmod permissions as an octal string e.g "600"; - * @see #setChmod(int) * @since 5.0 + * @see #setChmod(int) */ public void setChmodOctal(String chmod) { Assert.notNull(chmod, "'chmod' cannot be null"); @@ -1144,8 +1144,8 @@ public class FileWritingMessageHandler extends AbstractReplyProducingMessageHand * When using {@link FileExistsMode#APPEND_NO_FLUSH} * an implementation of this interface is called for each file that has pending data * to flush when a trigger message is received. - * @see FileWritingMessageHandler#trigger(Message) * @since 4.3 + * @see FileWritingMessageHandler#trigger(Message) * */ @FunctionalInterface diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/config/FileTailInboundChannelAdapterFactoryBean.java b/spring-integration-file/src/main/java/org/springframework/integration/file/config/FileTailInboundChannelAdapterFactoryBean.java index 8aa24fef24..32bfd4027e 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/config/FileTailInboundChannelAdapterFactoryBean.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/config/FileTailInboundChannelAdapterFactoryBean.java @@ -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. @@ -91,7 +91,7 @@ public class FileTailInboundChannelAdapterFactoryBean extends AbstractFactoryBea /** * If false, thread for capturing stderr will not be started - * and stderr output will be ignored + * and stderr output will be ignored. * @param enableStatusReader true or false * @since 4.3.6 */ diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileInboundChannelAdapterSpec.java b/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileInboundChannelAdapterSpec.java index b9eec5d73b..f026a97451 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileInboundChannelAdapterSpec.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileInboundChannelAdapterSpec.java @@ -81,8 +81,8 @@ public class FileInboundChannelAdapterSpec * {@link RecursiveDirectoryScanner} or stay with a default one. * @param recursive to set or not a {@link RecursiveDirectoryScanner}. * @return the spec. - * @see org.springframework.integration.file.RecursiveDirectoryScanner * @since 5.5 + * @see org.springframework.integration.file.RecursiveDirectoryScanner */ public FileInboundChannelAdapterSpec recursive(boolean recursive) { if (recursive) { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileWritingMessageHandlerSpec.java b/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileWritingMessageHandlerSpec.java index fced6476b6..a7fba0dca3 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileWritingMessageHandlerSpec.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileWritingMessageHandlerSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -250,8 +250,8 @@ public class FileWritingMessageHandlerSpec * owner read/write. Only applies to file systems that support posix * file permissions. * @param chmod the permissions. - * @throws IllegalArgumentException if the value is higher than 0777. * @return the spec. + * @throws IllegalArgumentException if the value is higher than 0777. * @see FileWritingMessageHandler#setChmod(int) */ public FileWritingMessageHandlerSpec chmod(int chmod) { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractFileListFilter.java index 43d82da3c9..36e53c80ac 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractFileListFilter.java @@ -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. @@ -24,6 +24,8 @@ import java.util.List; * evaluated against each File in isolation. If the entire List of files is * required for evaluation, implement the FileListFilter interface directly. * + * @param the target protocol file type. + * * @author Mark Fisher * @author Iwein Fuld * @author Gary Russell diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractMarkerFilePresentFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractMarkerFilePresentFileListFilter.java index d0006ffe5b..69da365eab 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractMarkerFilePresentFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractMarkerFilePresentFileListFilter.java @@ -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. @@ -34,7 +34,10 @@ import java.util.stream.Collectors; * Since they look at multiple files, they cannot be used for late filtering in the * streaming message source. * + * @param the target protocol file type. + * * @author Gary Russell + * * @since 5.0 * */ @@ -87,7 +90,7 @@ public abstract class AbstractMarkerFilePresentFileListFilter implements File * function returns "foo.txt.complete", this filter will only pass "foo.txt" if * "foo.txt.complete" is present. The function returns the name of the marker file to * match, or {@code null} for never match. Due to type erasure, we cannot provide a - * constructor taking {@code Map}. For convenience, you can use * {@link #defaultFileNameFunction(String)} to use the default function used by the * {@link #AbstractMarkerFilePresentFileListFilter(FileListFilter, String)} * constructor. diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractRegexPatternFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractRegexPatternFileListFilter.java index 19a99ae4ed..d763ef369a 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractRegexPatternFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractRegexPatternFileListFilter.java @@ -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. @@ -22,7 +22,7 @@ import org.springframework.util.Assert; /** * Filters a listing of files by qualifying their 'name' - * against a regular expression (an instance of {@link java.util.regex.Pattern}) + * against a regular expression (an instance of {@link Pattern}). * * @param the type of file entry * diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractSimplePatternFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractSimplePatternFileListFilter.java index fd970fb689..39cd80ba7e 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractSimplePatternFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AbstractSimplePatternFileListFilter.java @@ -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. @@ -23,11 +23,15 @@ import org.springframework.util.AntPathMatcher; * but more readable than regular expressions. This filter only filters on the name of the * file, the rest of the path is ignored. * + * @param the file type. + * * @author Iwein Fuld * @author Mark Fisher + * + * @since 2.0 + * * @see org.springframework.util.AntPathMatcher * @see org.springframework.integration.file.filters.AbstractRegexPatternFileListFilter - * @since 2.0 */ public abstract class AbstractSimplePatternFileListFilter extends AbstractDirectoryAwareFileListFilter { @@ -42,7 +46,7 @@ public abstract class AbstractSimplePatternFileListFilter extends AbstractDir /** - * Accepts the given file if its name matches the pattern. + * Accept the given file if its name matches the pattern. */ @Override public final boolean accept(F file) { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptAllFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptAllFileListFilter.java index da12e1181a..f4ab04684c 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptAllFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptAllFileListFilter.java @@ -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. @@ -21,10 +21,10 @@ package org.springframework.integration.file.filters; * Simple implementation of {@link FileListFilter} that always returns true. * Suitable as a default. * + * @param The type that will be filtered. + * * @author Iwein Fuld * @author Josh Long - * - * @param The type that will be filtered. */ public class AcceptAllFileListFilter extends AbstractFileListFilter { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptOnceFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptOnceFileListFilter.java index cd7a7f2802..f1c4d56516 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptOnceFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/AcceptOnceFileListFilter.java @@ -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. @@ -31,6 +31,8 @@ import org.springframework.lang.Nullable; *

    * This implementation is thread safe. * + * @param the file type. + * * @author Iwein Fuld * @author Josh Long * @author Gary Russell diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/DiscardAwareFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/DiscardAwareFileListFilter.java index 9b612ebafd..0773308321 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/DiscardAwareFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/DiscardAwareFileListFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2018-2019 the original author or authors. + * Copyright 2018-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. @@ -24,6 +24,8 @@ import org.springframework.lang.Nullable; * The {@link FileListFilter} modification which can accept a {@link Consumer} * which can be called when the filter discards the file. * + * @param The type that will be filtered. + * * @author Artem Bilan * @author Gary Russell * diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ExpressionFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ExpressionFileListFilter.java index 0aba46dcb8..6e89920876 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ExpressionFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ExpressionFileListFilter.java @@ -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. @@ -29,6 +29,8 @@ import org.springframework.util.Assert; /** * A SpEL expression based {@link AbstractFileListFilter} implementation. * + * @param The type that will be filtered. + * * @author Artem Bilan * @author Gary Russell * diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/FileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/FileListFilter.java index 16da0ba6a5..96ea799885 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/FileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/FileListFilter.java @@ -22,6 +22,8 @@ import java.util.List; * Strategy interface for filtering a group of files. This is a generic filter intended * to work with either local files or references to remote files. * + * @param The type that will be filtered. + * * @author Iwein Fuld * @author Josh Long * @author Gary Russell diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ResettableFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ResettableFileListFilter.java index 51e148b20e..420cf61db9 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ResettableFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ResettableFileListFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -19,14 +19,16 @@ package org.springframework.integration.file.filters; /** * A {@link FileListFilter} that can be reset by removing a specific file from its * state. - * @author Gary Russell - * @since 4.1.7 + * @param The type that will be filtered. * + * @author Gary Russell + * + * @since 4.1.7 */ public interface ResettableFileListFilter extends FileListFilter { /** - * Remove the specified file from the filter so it will pass on the next attempt. + * Remove the specified file from the filter, so it will pass on the next attempt. * @param f the element to remove. * @return true if the file was removed as a result of this call. */ diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ReversibleFileListFilter.java b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ReversibleFileListFilter.java index 3a8c558fcb..0855a18992 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ReversibleFileListFilter.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/filters/ReversibleFileListFilter.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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,9 +23,11 @@ import java.util.List; * A {@link FileListFilter} that allows the caller to reverse (roll back) state * changes. * - * @author Gary Russell - * @since 4.0.4 + * @param The type that will be filtered. * + * @author Gary Russell + * + * @since 4.0.4 */ public interface ReversibleFileListFilter extends FileListFilter { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/AbstractFileInfo.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/AbstractFileInfo.java index 3a9df8c63f..fa3f11c4bb 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/AbstractFileInfo.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/AbstractFileInfo.java @@ -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. @@ -24,7 +24,10 @@ import org.springframework.integration.json.SimpleJsonSerializer; * Abstract implementation of {@link FileInfo}; provides a setter * for the remote directory and a generic toString implementation. * + * @param The target protocol file type. + * * @author Gary Russell + * * @since 2.1 */ public abstract class AbstractFileInfo implements FileInfo, Comparable> { @@ -43,14 +46,6 @@ public abstract class AbstractFileInfo implements FileInfo, Comparable o) { return this.getFilename().compareTo(o.getFilename()); @@ -60,4 +55,12 @@ public abstract class AbstractFileInfo implements FileInfo, Comparable The target protocol file type. + * * @author Gary Russell * @author Artem Bilan * @author Lukas Gemela @@ -110,7 +112,7 @@ public abstract class AbstractRemoteFileStreamingMessageSource } /** - * Set the remote file separator; default '/' + * Set the remote file separator; default '/'. * @param remoteFileSeparator the remote file separator. */ public void setRemoteFileSeparator(String remoteFileSeparator) { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallback.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallback.java index e48f9993a1..1a2822ff0b 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallback.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallback.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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. @@ -20,12 +20,12 @@ package org.springframework.integration.file.remote; * {@code RemoteFileTemplate} callback with the underlying client instance providing * access to lower level methods. * - * @author Gary Russell - * * @param The type of the underlying client object. * @param The return type of the callback method. - * @since 4.1 * + * @author Gary Russell + * + * @since 4.1 */ @FunctionalInterface public interface ClientCallback { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallbackWithoutResult.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallbackWithoutResult.java index 2235af9a35..e3ab4d1431 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallbackWithoutResult.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/ClientCallbackWithoutResult.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2019 the original author or authors. + * Copyright 2014-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,12 +21,12 @@ package org.springframework.integration.file.remote; * {@code RemoteFileTemplate} callback with the underlying client instance providing * access to lower level methods where no result is returned. * + * @param The type of the underlying client object. + * * @author Gary Russell * @author Artem Bilan * - * @param The type of the underlying client object. * @since 4.1 - * */ @FunctionalInterface public interface ClientCallbackWithoutResult extends ClientCallback { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/FileInfo.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/FileInfo.java index 6e9e6ec104..7959a6d3b5 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/FileInfo.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/FileInfo.java @@ -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. @@ -19,7 +19,10 @@ package org.springframework.integration.file.remote; /** * Represents a remote file info - an abstraction over the underlying implementation. * + * @param The target protocol file type. + * * @author Gary Russell + * * @since 2.1 */ public interface FileInfo { @@ -62,7 +65,8 @@ public interface FileInfo { /** * @return the actual implementation from the underlying - * library, more sophisticated access is needed. + * library, more sophisticated access is needed. */ F getFileInfo(); + } diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/MessageSessionCallback.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/MessageSessionCallback.java index b1a43944f7..c2eb54d602 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/MessageSessionCallback.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/MessageSessionCallback.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -25,7 +25,11 @@ import org.springframework.messaging.Message; * Callback invoked by {@code RemoteFileOperations.executeForMessage()} * - allows multiple operations on a session. * + * @param the target protocol file type. + * @param the expected execution result. + * * @author Artem Bilan + * * @since 4.2 */ @FunctionalInterface diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileOperations.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileOperations.java index ebf63da129..f6cd237a5c 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileOperations.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileOperations.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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,9 +23,11 @@ import org.springframework.messaging.Message; /** * Strategy for performing operations on remote files. * - * @author Gary Russell - * @since 3.0 + * @param the file type. * + * @author Gary Russell + * + * @since 3.0 */ public interface RemoteFileOperations { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileTemplate.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileTemplate.java index a26d23b3dc..aeffff37f9 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileTemplate.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/RemoteFileTemplate.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2020 the original author or authors. + * Copyright 2013-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. @@ -51,6 +51,8 @@ import org.springframework.util.StringUtils; /** * A general abstraction for dealing with remote files. * + * @param the file type. + * * @author Iwein Fuld * @author Mark Fisher * @author Josh Long @@ -65,7 +67,7 @@ import org.springframework.util.StringUtils; */ public class RemoteFileTemplate implements RemoteFileOperations, InitializingBean, BeanFactoryAware { - private final Log logger = LogFactory.getLog(this.getClass()); + protected final Log logger = LogFactory.getLog(getClass()); // NOSONAR - final /** * The {@link SessionFactory} for acquiring remote file Sessions. diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/SessionCallbackWithoutResult.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/SessionCallbackWithoutResult.java index 2c1762a832..c23996c889 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/SessionCallbackWithoutResult.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/SessionCallbackWithoutResult.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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. @@ -24,8 +24,11 @@ import org.springframework.integration.file.remote.session.Session; * Simple convenience implementation of {@link SessionCallback} for cases where * no result is returned. * + * @param the target system file type. + * * @author Gary Russell * @author Artem Bilan + * * @since 3.0 * */ diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java index fa8c1fc96f..9d69b7071c 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java @@ -67,6 +67,8 @@ import org.springframework.util.StringUtils; /** * Base class for Outbound Gateways that perform remote file operations. * + * @param the file type. + * * @author Gary Russell * @author Artem Bilan * @@ -481,8 +483,8 @@ public abstract class AbstractRemoteFileOutboundGateway extends AbstractReply /** * String setter for Spring XML convenience. * @param chmod permissions as an octal string e.g "600"; - * @see #setChmod(int) * @since 4.3 + * @see #setChmod(int) */ public void setChmodOctal(String chmod) { Assert.notNull(chmod, "'chmod' cannot be null"); @@ -1429,7 +1431,7 @@ public abstract class AbstractRemoteFileOutboundGateway extends AbstractReply EXCEPTION_WHEN_EMPTY("-x"), /** - * (-R) Recursive (ls, mget) + * (-R) Recursive (ls, mget). */ RECURSIVE("-R"), diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/handler/FileTransferringMessageHandler.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/handler/FileTransferringMessageHandler.java index 986b27ab45..7c75dc791e 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/handler/FileTransferringMessageHandler.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/handler/FileTransferringMessageHandler.java @@ -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. @@ -28,6 +28,8 @@ import org.springframework.util.Assert; /** * A {@link org.springframework.messaging.MessageHandler} implementation that transfers files to a remote server. * + * @param the file type. + * * @author Iwein Fuld * @author Mark Fisher * @author Josh Long @@ -171,8 +173,8 @@ public class FileTransferringMessageHandler extends AbstractMessageHandler { /** * String setter for Spring XML convenience. * @param chmod permissions as an octal string e.g "600"; - * @see #setChmod(int) * @since 4.3 + * @see #setChmod(int) */ public void setChmodOctal(String chmod) { Assert.notNull(chmod, "'chmod' cannot be null"); diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/CachingSessionFactory.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/CachingSessionFactory.java index 5a16632a04..2ab2f38416 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/CachingSessionFactory.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/CachingSessionFactory.java @@ -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. @@ -32,6 +32,8 @@ import org.springframework.util.Assert; * requiring reconnection each time the Session is retrieved from the factory. * This implementation wraps and delegates to a target SessionFactory instance. * + * @param the target system file type. + * * @author Josh Long * @author Oleg Zhurakousky * @author Mark Fisher @@ -68,10 +70,10 @@ public class CachingSessionFactory implements SessionFactory, DisposableBe * no sessions are available in the cache, and the size limit has been reached, * calling threads will block until a session is available. *

    Do not cache a {@link DelegatingSessionFactory}, cache each delegate therein instead. - * @see #setSessionWaitTimeout(long) - * @see #setPoolSize(int) * @param sessionFactory The underlying session factory. * @param sessionCacheSize The maximum cache size. + * @see #setSessionWaitTimeout(long) + * @see #setPoolSize(int) */ public CachingSessionFactory(SessionFactory sessionFactory, int sessionCacheSize) { Assert.isTrue(!(sessionFactory instanceof DelegatingSessionFactory), diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DefaultSessionFactoryLocator.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DefaultSessionFactoryLocator.java index f425456278..f7c5cba41c 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DefaultSessionFactoryLocator.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DefaultSessionFactoryLocator.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2020 the original author or authors. + * Copyright 2015-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. @@ -25,6 +25,8 @@ import org.springframework.lang.Nullable; * The default implementation of {@link SessionFactoryLocator} using a simple map lookup * and an optional default to fall back on. * + * @param the target system file type. + * * @author Gary Russell * @author Andrey Kezhevatov * @author Artem Bilan diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DelegatingSessionFactory.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DelegatingSessionFactory.java index faf8c73f84..aa9d58166c 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DelegatingSessionFactory.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/DelegatingSessionFactory.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -25,6 +25,8 @@ import org.springframework.util.Assert; * {@link SessionFactory} that delegates to a {@link SessionFactory} retrieved from a * {@link SessionFactoryLocator}. * + * @param the target system file type. + * * @author Gary Russell * @since 4.2 * @@ -33,7 +35,7 @@ public class DelegatingSessionFactory implements SessionFactory { private final SessionFactoryLocator factoryLocator; - private final ThreadLocal threadKey = new ThreadLocal(); + private final ThreadLocal threadKey = new ThreadLocal<>(); /** * Construct an instance with a {@link DefaultSessionFactoryLocator} using the diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/Session.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/Session.java index 2bc1d5fce5..98ff7d4a5a 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/Session.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/Session.java @@ -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. @@ -24,12 +24,16 @@ import java.io.OutputStream; /** * Common abstraction for a Session with a remote File system. * + * @param the target system file type. + * * @author Josh Long * @author Mario Gray * @author Mark Fisher * @author Oleg Zhurakousky * @author Gary Russell * @author Alen Turkovic + * @author Artem Bilan + * * @since 2.0 */ public interface Session extends Closeable { @@ -128,8 +132,8 @@ public interface Session extends Closeable { /** * Mark this session as dirty, indicating that it should not be reused and any * delegated sessions should be taken care of before closing. - * @see CachingSessionFactory.CachedSession#close() * @since 5.1.2 + * @see CachingSessionFactory.CachedSession#close() */ default void dirty() { // NOOP diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactory.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactory.java index 412c48d170..516e370ce4 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactory.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactory.java @@ -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. @@ -19,7 +19,10 @@ package org.springframework.integration.file.remote.session; /** * Factory for acquiring {@link Session} instances. * + * @param the target system file type. + * * @author Mark Fisher + * * @since 2.0 */ @FunctionalInterface diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryLocator.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryLocator.java index 1ea2d2f78c..4f4e94768e 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryLocator.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryLocator.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -20,9 +20,11 @@ package org.springframework.integration.file.remote.session; * * A factory returning a {@link SessionFactory} based on some key. * - * @author Gary Russell - * @since 4.2 + * @param the target system file type. * + * @author Gary Russell + * + * @since 4.2 */ @FunctionalInterface public interface SessionFactoryLocator { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryMapBuilder.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryMapBuilder.java index ef9ca0341b..630f4a826a 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryMapBuilder.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/session/SessionFactoryMapBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2018-2019 the original author or authors. + * Copyright 2018-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,7 +21,10 @@ import org.springframework.integration.support.MapBuilder; /** * A {@link MapBuilder} to producer a map that maps objects to {@link SessionFactory}s. * + * @param the target system file type. + * * @author Gary Russell + * * @since 5.0.7 * */ diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/AbstractInboundFileSynchronizingMessageSource.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/AbstractInboundFileSynchronizingMessageSource.java index cfad6ddef9..9f83419d0f 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/AbstractInboundFileSynchronizingMessageSource.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/AbstractInboundFileSynchronizingMessageSource.java @@ -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. @@ -58,6 +58,8 @@ import org.springframework.util.Assert; * handle the work of actually connecting to the remote file system and * delivering new {@link File}s. * + * @param the target system file type. + * * @author Josh Long * @author Oleg Zhurakousky * @author Gary Russell @@ -287,7 +289,7 @@ public abstract class AbstractInboundFileSynchronizingMessageSource /** * The {@link FileReadingMessageSource} extension to increase visibility - * for the {@link FileReadingMessageSource#doReceive()} + * for the {@link FileReadingMessageSource#doReceive()}. */ private static final class LocalFileReadingMessageSource extends FileReadingMessageSource { diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/InboundFileSynchronizer.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/InboundFileSynchronizer.java index f6d1d9f477..374b2b217d 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/InboundFileSynchronizer.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/synchronizer/InboundFileSynchronizer.java @@ -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. @@ -23,19 +23,20 @@ import java.io.File; * * @author Mark Fisher * @author Gary Russell + * * @since 2.0 */ @FunctionalInterface public interface InboundFileSynchronizer { /** - * Synchronize all available files to the local directory; + * Synchronize all available files to the local directory. * @param localDirectory the directory. */ void synchronizeToLocalDirectory(File localDirectory); /** - * Synchronize up to maxFetchSize files to the local directory; + * Synchronize up to maxFetchSize files to the local directory. * @param localDirectory the directory. * @param maxFetchSize the maximum files to fetch. */ diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/tail/OSDelegatingFileTailingMessageProducer.java b/spring-integration-file/src/main/java/org/springframework/integration/file/tail/OSDelegatingFileTailingMessageProducer.java index 290bad442f..4238fd295b 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/tail/OSDelegatingFileTailingMessageProducer.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/tail/OSDelegatingFileTailingMessageProducer.java @@ -60,7 +60,7 @@ public class OSDelegatingFileTailingMessageProducer extends FileTailingMessagePr /** * If false, thread for capturing stderr will not be started - * and stderr output will be ignored + * and stderr output will be ignored. * @param enableStatusReader true or false * @since 4.3.6 */ diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/transformer/AbstractFilePayloadTransformer.java b/spring-integration-file/src/main/java/org/springframework/integration/file/transformer/AbstractFilePayloadTransformer.java index bd27cda6b7..fa0335697a 100644 --- a/spring-integration-file/src/main/java/org/springframework/integration/file/transformer/AbstractFilePayloadTransformer.java +++ b/spring-integration-file/src/main/java/org/springframework/integration/file/transformer/AbstractFilePayloadTransformer.java @@ -37,14 +37,16 @@ import org.springframework.util.Assert; /** * Base class for transformers that convert a File payload. * + * @param the expected payload type. + * * @author Mark Fisher * @author Artem Bilan */ public abstract class AbstractFilePayloadTransformer implements Transformer, BeanFactoryAware { - private final Log logger = LogFactory.getLog(this.getClass()); + protected final Log logger = LogFactory.getLog(getClass()); // NOSONAR - final - private volatile boolean deleteFiles; + private boolean deleteFiles; private volatile MessageBuilderFactory messageBuilderFactory = new DefaultMessageBuilderFactory(); diff --git a/spring-integration-file/src/test/java/org/springframework/integration/file/splitter/FileSplitterTests.java b/spring-integration-file/src/test/java/org/springframework/integration/file/splitter/FileSplitterTests.java index bc3d29f869..e0a629d4fb 100644 --- a/spring-integration-file/src/test/java/org/springframework/integration/file/splitter/FileSplitterTests.java +++ b/spring-integration-file/src/test/java/org/springframework/integration/file/splitter/FileSplitterTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2020 the original author or authors. + * Copyright 2015-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. @@ -311,7 +311,7 @@ public class FileSplitterTests { splitter.setOutputChannel(outputChannel); splitter.handleMessage(new GenericMessage<>(file)); - verifier.verify(Duration.ofSeconds(1)); + verifier.verify(Duration.ofSeconds(10)); } @Test diff --git a/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/session/AbstractFtpSessionFactory.java b/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/session/AbstractFtpSessionFactory.java index b11e0f907c..cd355d9c15 100644 --- a/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/session/AbstractFtpSessionFactory.java +++ b/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/session/AbstractFtpSessionFactory.java @@ -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. @@ -33,9 +33,12 @@ import org.springframework.util.Assert; /** * Base class for FTP SessionFactory implementations. * + * @param The {@link FTPClient} type + * * @author Iwein Fuld * @author Mark Fisher * @author Oleg Zhurakousky + * * @since 2.0 */ public abstract class AbstractFtpSessionFactory implements SessionFactory { @@ -74,7 +77,7 @@ public abstract class AbstractFtpSessionFactory implements *
  • {@link org.apache.commons.net.ftp.FTP#EBCDIC_FILE_TYPE}
    • *
  • {@link org.apache.commons.net.ftp.FTP#BINARY_FILE_TYPE} (DEFAULT)
    • *
  • {@link org.apache.commons.net.ftp.FTP#LOCAL_FILE_TYPE}
    • - * + * . * @param fileType The file type. */ public void setFileType(int fileType) { @@ -232,8 +235,7 @@ public abstract class AbstractFtpSessionFactory implements /** * Will handle additional initialization after client.connect() method was invoked, - * but before any action on the client has been taken - * + * but before any action on the client has been taken. * @param t The client. * @throws IOException Any IOException */ diff --git a/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/CqEventType.java b/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/CqEventType.java index 0c5194347f..7964a5309a 100644 --- a/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/CqEventType.java +++ b/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/CqEventType.java @@ -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. @@ -17,8 +17,10 @@ package org.springframework.integration.gemfire.inbound; /** - * Enumeration of GemFire Continuous Query Event Types + * Enumeration of GemFire Continuous Query Event Types. + * * @author David Turanski + * * @since 2.1 */ public enum CqEventType { diff --git a/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/store/GemfireMessageStore.java b/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/store/GemfireMessageStore.java index 966a3bcaa2..93f73bf4a6 100644 --- a/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/store/GemfireMessageStore.java +++ b/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/store/GemfireMessageStore.java @@ -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. @@ -29,7 +29,7 @@ import org.springframework.util.PatternMatchUtils; /** * Gemfire implementation of the key/value style * {@link org.springframework.integration.store.MessageStore} and - * {@link org.springframework.integration.store.MessageGroupStore} + * {@link org.springframework.integration.store.MessageGroupStore}. * * @author Mark Fisher * @author Oleg Zhurakousky @@ -56,7 +56,7 @@ public class GemfireMessageStore extends AbstractKeyValueMessageStore { } /** - * Construct a {@link GemfireMessageStore} instance based on the provided + * Construct a {@link GemfireMessageStore} instance based on the provided. * @param messageStoreRegion the region to use. * @param prefix the key prefix to use, allowing the same region to be used for * multiple stores. diff --git a/spring-integration-groovy/src/main/java/org/springframework/integration/groovy/GroovyScriptExecutingMessageProcessor.java b/spring-integration-groovy/src/main/java/org/springframework/integration/groovy/GroovyScriptExecutingMessageProcessor.java index 2d6b2850a4..cc176efa01 100644 --- a/spring-integration-groovy/src/main/java/org/springframework/integration/groovy/GroovyScriptExecutingMessageProcessor.java +++ b/spring-integration-groovy/src/main/java/org/springframework/integration/groovy/GroovyScriptExecutingMessageProcessor.java @@ -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. @@ -118,9 +118,9 @@ public class GroovyScriptExecutingMessageProcessor extends AbstractScriptExecuti * should be customised for the {@link CompileStatic} hint for the provided script. *

    More compiler options can be provided via {@link #setCompilerConfiguration(CompilerConfiguration)} * overriding this flag. - * @param compileStatic the compile static {@code boolean} flag. - * @see CompileStatic + * @param compileStatic the compile-static {@code boolean} flag. * @since 4.3 + * @see CompileStatic */ public void setCompileStatic(boolean compileStatic) { this.compileStatic = compileStatic; @@ -131,9 +131,9 @@ public class GroovyScriptExecutingMessageProcessor extends AbstractScriptExecuti * For example the {@link CompileStatic} and {@link org.codehaus.groovy.control.customizers.ImportCustomizer} * are the most popular options. * @param compilerConfiguration the Groovy script compiler options to use. + * @since 4.3 * @see CompileStatic * @see GroovyClassLoader - * @since 4.3 */ public void setCompilerConfiguration(CompilerConfiguration compilerConfiguration) { this.compilerConfiguration = compilerConfiguration; diff --git a/spring-integration-http/src/main/java/org/springframework/integration/http/dsl/HttpInboundEndpointSupportSpec.java b/spring-integration-http/src/main/java/org/springframework/integration/http/dsl/HttpInboundEndpointSupportSpec.java index b18179c502..384d9df525 100644 --- a/spring-integration-http/src/main/java/org/springframework/integration/http/dsl/HttpInboundEndpointSupportSpec.java +++ b/spring-integration-http/src/main/java/org/springframework/integration/http/dsl/HttpInboundEndpointSupportSpec.java @@ -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. @@ -41,6 +41,9 @@ import org.springframework.validation.Validator; import org.springframework.web.bind.annotation.RequestMethod; /** + * @param the target spec extension type. + * @param the target endpoint type. + * * @author Artem Bilan * @author Gary Russell * @@ -68,7 +71,7 @@ public abstract class HttpInboundEndpointSupportSpec the expected file content type. + * * @author Mark Fisher * * @since 2.0 @@ -30,8 +32,7 @@ import org.springframework.web.multipart.MultipartFile; public interface MultipartFileReader { /** - * Reads {@link MultipartFile} content. - * + * Read {@link MultipartFile} content. * @param multipartFile The multipart file. * @return The result of reading the file. * @throws IOException Any IOException. diff --git a/spring-integration-http/src/main/java/org/springframework/integration/http/multipart/MultipartHttpInputMessage.java b/spring-integration-http/src/main/java/org/springframework/integration/http/multipart/MultipartHttpInputMessage.java index b6e2b23caa..8f68b5c504 100644 --- a/spring-integration-http/src/main/java/org/springframework/integration/http/multipart/MultipartHttpInputMessage.java +++ b/spring-integration-http/src/main/java/org/springframework/integration/http/multipart/MultipartHttpInputMessage.java @@ -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. @@ -28,6 +28,8 @@ import org.springframework.web.multipart.MultipartRequest; /** * @author Mark Fisher + * @author Artem Bilan + * * @since 2.0 */ public class MultipartHttpInputMessage extends ServletServerHttpRequest implements MultipartRequest { @@ -67,18 +69,8 @@ public class MultipartHttpInputMessage extends ServletServerHttpRequest implemen return this.multipartServletRequest.getParameterMap(); } - /** - * Once we depend upon Spring 3.1 as a minimum, this code can be changed to: - * this.multipartServletRequest.getMultipartContentType(String paramOrFileName) - */ public String getMultipartContentType(String paramOrFileName) { - MultipartFile file = getFile(paramOrFileName); - if (file != null) { - return file.getContentType(); - } - else { - throw new UnsupportedOperationException("unable to retrieve multipart content-type for parameter"); - } + return this.multipartServletRequest.getMultipartContentType(paramOrFileName); } } diff --git a/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/AbstractHttpRequestExecutingMessageHandler.java b/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/AbstractHttpRequestExecutingMessageHandler.java index 22d97e4f11..74b5810dc5 100644 --- a/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/AbstractHttpRequestExecutingMessageHandler.java +++ b/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/AbstractHttpRequestExecutingMessageHandler.java @@ -338,9 +338,6 @@ public abstract class AbstractHttpRequestExecutingMessageHandler extends Abstrac return replyBuilder.copyHeaders(headers); } - /** - * Convert Set-Cookie to Cookie - */ private void doConvertSetCookie(Map headers) { String keyName = null; for (String key : headers.keySet()) { @@ -464,7 +461,7 @@ public abstract class AbstractHttpRequestExecutingMessageHandler extends Abstrac return true; } - /** + /* * If all keys are Strings, and some values are not Strings we'll consider * the Map to be multipart/form-data */ diff --git a/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/HttpRequestExecutingMessageHandler.java b/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/HttpRequestExecutingMessageHandler.java index bbc2bed4aa..e1fbe5c087 100755 --- a/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/HttpRequestExecutingMessageHandler.java +++ b/spring-integration-http/src/main/java/org/springframework/integration/http/outbound/HttpRequestExecutingMessageHandler.java @@ -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. @@ -93,7 +93,7 @@ public class HttpRequestExecutingMessageHandler extends AbstractHttpRequestExecu } /** - * Create a handler that will send requests to the provided URI using a provided RestTemplate + * Create a handler that will send requests to the provided URI using a provided RestTemplate. * @param uri The URI. * @param restTemplate The rest template. */ @@ -107,8 +107,8 @@ public class HttpRequestExecutingMessageHandler extends AbstractHttpRequestExecu Assert.hasText(uri, "URI is required"); } - /** - * Create a handler that will send requests to the provided URI using a provided RestTemplate + /**4 + * Create a handler that will send requests to the provided URI using a provided RestTemplate. * @param uriExpression A SpEL Expression that can be resolved against the message object and * {@link org.springframework.beans.factory.BeanFactory}. * @param restTemplate The rest template. diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolReceivingChannelAdapter.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolReceivingChannelAdapter.java index bea28742a1..7e98fa4e74 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolReceivingChannelAdapter.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolReceivingChannelAdapter.java @@ -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(); diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolSendingMessageHandler.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolSendingMessageHandler.java index dd788086f3..70bfd18edc 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolSendingMessageHandler.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/AbstractInternetProtocolSendingMessageHandler.java @@ -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) { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java index 3789ad6cb3..6ec6709226 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/CommonSocketOptions.java @@ -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); diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/TcpOutboundGateway.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/TcpOutboundGateway.java index 175e7baeff..d9042c81ab 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/TcpOutboundGateway.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/TcpOutboundGateway.java @@ -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() { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java index ebaefa7255..149140b70a 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java @@ -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() { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/CachingClientConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/CachingClientConnectionFactory.java index afb34e68ce..b667976f0d 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/CachingClientConnectionFactory.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/CachingClientConnectionFactory.java @@ -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(); diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/FailoverClientConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/FailoverClientConnectionFactory.java index edce0c99c0..74da615ec3 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/FailoverClientConnectionFactory.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/FailoverClientConnectionFactory.java @@ -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() { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnectionInterceptorSupport.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnectionInterceptorSupport.java index 844b102703..05867f5669 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnectionInterceptorSupport.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnectionInterceptorSupport.java @@ -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) { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpListener.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpListener.java index 9c24c0eebb..0b35c0e413 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpListener.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpListener.java @@ -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 { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioConnectionSupport.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioConnectionSupport.java index 51cb432a6b..4a7b478a48 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioConnectionSupport.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioConnectionSupport.java @@ -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 diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayElasticRawDeserializer.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayElasticRawDeserializer.java index 4a2c987ef8..0fd0c9f658 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayElasticRawDeserializer.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayElasticRawDeserializer.java @@ -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 { /** * 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); diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayLengthHeaderSerializer.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayLengthHeaderSerializer.java index 6521b048f4..ef5ece45c3 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayLengthHeaderSerializer.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayLengthHeaderSerializer.java @@ -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); diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/JdbcTypesEnum.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/JdbcTypesEnum.java index 8418608485..65ee086df3 100644 --- a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/JdbcTypesEnum.java +++ b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/JdbcTypesEnum.java @@ -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. @@ -26,6 +26,7 @@ import org.springframework.util.Assert; * looking up the respective JDBC Type (int-value). * * @author Gunnar Hillert + * * @since 2.1 * */ @@ -67,9 +68,8 @@ public enum JdbcTypesEnum { NCLOB(Types.NCLOB), SQLXML(Types.SQLXML); - private int code; + private final int code; - /** Constructor */ JdbcTypesEnum(int code) { this.code = code; } @@ -77,7 +77,6 @@ public enum JdbcTypesEnum { /** * Get the numerical representation of the JDBC Type enum. The numerical value * matches exactly the equivalent value in {@link Types} - * * @return The numerical representation of the constant. */ public int getCode() { @@ -85,24 +84,20 @@ public enum JdbcTypesEnum { } /** - * Retrieves the matching enum constant for a provided String representation + * Retrieve the matching enum constant for a provided String representation * of the SQL Types. The provided name must match exactly the identifier as * used to declare the enum constant. - * * @param sqlTypeAsString Name of the enum to convert. Must be not null and not empty. * @return The enumeration that matches. Returns Null of no match was found. * */ public static JdbcTypesEnum convertToJdbcTypesEnum(String sqlTypeAsString) { - Assert.hasText(sqlTypeAsString, "Parameter sqlTypeAsString, must not be null nor empty"); - for (JdbcTypesEnum jdbcType : JdbcTypesEnum.values()) { if (jdbcType.name().equalsIgnoreCase(sqlTypeAsString)) { return jdbcType; } } - return null; } } diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcMessageStore.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcMessageStore.java index afe3745505..f62438ea44 100644 --- a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcMessageStore.java +++ b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcMessageStore.java @@ -592,7 +592,7 @@ public class JdbcMessageStore extends AbstractMessageGroupStore implements Messa /** * To be used to get a reference to JdbcOperations - * in case this class is subclassed + * in case this class is subclassed. * @return the JdbcOperations implementation */ protected JdbcOperations getJdbcOperations() { diff --git a/spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsChannelFactoryBean.java b/spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsChannelFactoryBean.java index 72e795a236..eb229843e9 100644 --- a/spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsChannelFactoryBean.java +++ b/spring-integration-jms/src/main/java/org/springframework/integration/jms/config/JmsChannelFactoryBean.java @@ -120,7 +120,7 @@ public class JmsChannelFactoryBean extends AbstractFactoryBean> /** * @param destination the destination * @return the spec. - * @see JmsListenerContainerSpec#destination(Destination) * @deprecated since 5.5 in favor of {@link #requestDestination(Destination)} + * @see JmsListenerContainerSpec#destination(Destination) */ @Deprecated public JmsInboundGatewayListenerContainerSpec destination(Destination destination) { @@ -224,8 +224,8 @@ public class JmsInboundGatewaySpec> * Specify a request destination for incoming messages. * @param requestDestination the destination * @return the spec. - * @see JmsListenerContainerSpec#destination(Destination) * @since 5.5 + * @see JmsListenerContainerSpec#destination(Destination) */ public JmsInboundGatewayListenerContainerSpec requestDestination(Destination requestDestination) { this.spec.destination(requestDestination); @@ -235,8 +235,8 @@ public class JmsInboundGatewaySpec> /** * @param destinationName the destinationName * @return the spec. - * @see JmsListenerContainerSpec#destination(String) * @deprecated since 5.5 in favor of {@link #requestDestination(String)} + * @see JmsListenerContainerSpec#destination(String) */ @Deprecated public JmsInboundGatewayListenerContainerSpec destination(String destinationName) { @@ -247,8 +247,8 @@ public class JmsInboundGatewaySpec> * Specify a request destination for incoming messages. * @param requestDestinationName the destination name * @return the spec. - * @see JmsListenerContainerSpec#destination(String) * @since 5.5 + * @see JmsListenerContainerSpec#destination(String) */ public JmsInboundGatewayListenerContainerSpec requestDestination(String requestDestinationName) { this.spec.destination(requestDestinationName); diff --git a/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsMessageChannelSpec.java b/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsMessageChannelSpec.java index 6c8ec6a3af..043f844870 100644 --- a/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsMessageChannelSpec.java +++ b/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsMessageChannelSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -31,6 +31,7 @@ import org.springframework.util.ErrorHandler; * {@link org.springframework.integration.jms.AbstractJmsChannel}s. * * @param the target {@link JmsMessageChannelSpec} implementation type. + * @param the target channel implementation type. * * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsOutboundChannelAdapterSpec.java b/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsOutboundChannelAdapterSpec.java index b44a6e1d5c..ea23723ce8 100644 --- a/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsOutboundChannelAdapterSpec.java +++ b/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsOutboundChannelAdapterSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -167,8 +167,8 @@ public class JmsOutboundChannelAdapterSpec the expected payload type. * @return the spec - * @see FunctionExpression * @since 5.1 + * @see FunctionExpression */ public

    S timeToLiveFunction(Function, ?> timeToLiveFunction) { this.target.setTimeToLiveExpression(new FunctionExpression<>(timeToLiveFunction)); diff --git a/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsPollableMessageChannelSpec.java b/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsPollableMessageChannelSpec.java index c4e03b1dfa..ce02d32bfe 100644 --- a/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsPollableMessageChannelSpec.java +++ b/spring-integration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsPollableMessageChannelSpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -32,6 +32,7 @@ import org.springframework.lang.Nullable; * A {@link MessageChannelSpec} for an {@link AbstractJmsChannel}. * * @param the target {@link JmsPollableMessageChannelSpec} implementation type. + * @param the target channel implementation type. * * @author Artem Bilan * @author Gary Russell diff --git a/spring-integration-jmx/src/main/java/org/springframework/integration/jmx/MBeanTreePollingMessageSource.java b/spring-integration-jmx/src/main/java/org/springframework/integration/jmx/MBeanTreePollingMessageSource.java index 552ba59dee..767cb75076 100644 --- a/spring-integration-jmx/src/main/java/org/springframework/integration/jmx/MBeanTreePollingMessageSource.java +++ b/spring-integration-jmx/src/main/java/org/springframework/integration/jmx/MBeanTreePollingMessageSource.java @@ -1,5 +1,5 @@ /* - * Copyright 2013-2019 the original author or authors. + * Copyright 2013-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. @@ -36,6 +36,7 @@ import org.springframework.util.Assert; * * @author Stuart Williams * @author Gary Russell + * * @since 3.0 * */ @@ -61,15 +62,11 @@ public class MBeanTreePollingMessageSource extends AbstractMessageSource return "jmx:tree-polling-channel-adapter"; } - /** - * Provides the mapped tree object - */ @Override protected Object doReceive() { Assert.notNull(this.server, "MBeanServer is required"); - try { - Map beans = new HashMap(); + Map beans = new HashMap<>(); Set results = this.server.queryMBeans(this.queryName, this.queryExpression); for (ObjectInstance instance : results) { @@ -87,7 +84,6 @@ public class MBeanTreePollingMessageSource extends AbstractMessageSource /** * Provide the MBeanServer where the JMX MBean has been registered. - * * @param server The MBean server connection. */ public void setServer(MBeanServerConnection server) { @@ -133,4 +129,5 @@ public class MBeanTreePollingMessageSource extends AbstractMessageSource public void setQueryExpressionReference(QueryExp queryExpression) { this.queryExpression = queryExpression; } + } diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaInboundChannelAdapterParser.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaInboundChannelAdapterParser.java index 51ec9b8717..3d5f4a7152 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaInboundChannelAdapterParser.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaInboundChannelAdapterParser.java @@ -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. @@ -30,7 +30,7 @@ import org.springframework.integration.config.xml.IntegrationNamespaceUtils; import org.springframework.integration.jpa.inbound.JpaPollingChannelAdapter; /** - * The JPA Inbound Channel adapter parser + * The JPA Inbound Channel adapter parser. * * @author Amol Nayak * @author Gunnar Hillert diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaNamespaceHandler.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaNamespaceHandler.java index 2352b9203d..9e4be0dd59 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaNamespaceHandler.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaNamespaceHandler.java @@ -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. @@ -19,7 +19,7 @@ package org.springframework.integration.jpa.config.xml; import org.springframework.integration.config.xml.AbstractIntegrationNamespaceHandler; /** - * The namespace handler for the JPA namespace + * The namespace handler for the JPA namespace. * * @author Amol Nayak * @author Gunnar Hillert diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaOutboundChannelAdapterParser.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaOutboundChannelAdapterParser.java index 8d1559c222..58d8d4dabc 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaOutboundChannelAdapterParser.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/config/xml/JpaOutboundChannelAdapterParser.java @@ -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. @@ -28,7 +28,7 @@ import org.springframework.integration.config.xml.IntegrationNamespaceUtils; import org.springframework.integration.jpa.outbound.JpaOutboundGatewayFactoryBean; /** - * The parser for JPA outbound channel adapter + * The parser for JPA outbound channel adapter. * * @author Amol Nayak * @author Gunnar Hillert diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaExecutor.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaExecutor.java index dc2ef01535..8ba6b2a646 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaExecutor.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaExecutor.java @@ -50,7 +50,7 @@ import org.springframework.util.CollectionUtils; *
  • Sql Native Query
    • *
  • JpQl Named Query
    • *
  • Sql Native Named Query
    • - * + * . * * When objects are being retrieved, it also possibly to: * @@ -330,7 +330,7 @@ public class JpaExecutor implements InitializingBean, BeanFactoryAware { /** * Set the expression that will be evaluated to get the {@code primaryKey} for - * {@link javax.persistence.EntityManager#find(Class, Object)} + * {@link javax.persistence.EntityManager#find(Class, Object)}. * @param idExpression the SpEL expression for entity {@code primaryKey}. * @since 4.0 */ diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperationFailedException.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperationFailedException.java index ef2fda4448..9e6f95600b 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperationFailedException.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperationFailedException.java @@ -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. @@ -17,10 +17,11 @@ package org.springframework.integration.jpa.core; /** - * An Exception that would be thrown if any of the Operations from {@link JpaOperations} fails + * An Exception that would be thrown if any of the Operations from {@link JpaOperations} fails. * * @author Amol Nayak * @author Gary Russell + * * @since 2.2 * */ diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperations.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperations.java index 6bac69d5d1..09a5159e68 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperations.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/core/JpaOperations.java @@ -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. @@ -122,7 +122,7 @@ public interface JpaOperations { int maxNumberOfResults); /** - * Executes the provided query to return a list of results + * Execute the provided query to return a list of results. * @param query The query. * @param source the Parameter source for this query to be executed, if none then set as null * @return The list of found entities. @@ -140,7 +140,7 @@ public interface JpaOperations { List getResultListForQuery(String query, ParameterSource source, int firstResult, int maxNumberOfResults); /** - * Executes the provided query to return a single element + * Execute the provided query to return a single element. * @param query Must not be empty * @param source the Parameter source for this query to be executed, if none then set as null * @return Will always return a result. If no object was found in the database an exception is raised. diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/dsl/JpaRetrievingOutboundGatewaySpec.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/dsl/JpaRetrievingOutboundGatewaySpec.java index c2ce78f5ca..6257b04350 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/dsl/JpaRetrievingOutboundGatewaySpec.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/dsl/JpaRetrievingOutboundGatewaySpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -81,7 +81,7 @@ public class JpaRetrievingOutboundGatewaySpec extends JpaBaseOutboundEndpointSpe /** * Specify a SpEL expression that will be evaluated to get the {@code primaryKey} for - * {@link javax.persistence.EntityManager#find(Class, Object)} + * {@link javax.persistence.EntityManager#find(Class, Object)}. * @param idExpression the SpEL expression for entity {@code primaryKey}. * @return the spec */ @@ -91,7 +91,7 @@ public class JpaRetrievingOutboundGatewaySpec extends JpaBaseOutboundEndpointSpe /** * Specify a SpEL expression that will be evaluated to get the {@code primaryKey} for - * {@link javax.persistence.EntityManager#find(Class, Object)} + * {@link javax.persistence.EntityManager#find(Class, Object)}. * @param idExpression the SpEL expression for entity {@code primaryKey}. * @return the spec */ diff --git a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/inbound/JpaPollingChannelAdapter.java b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/inbound/JpaPollingChannelAdapter.java index 005cabf2f6..c52f6dc4d2 100644 --- a/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/inbound/JpaPollingChannelAdapter.java +++ b/spring-integration-jpa/src/main/java/org/springframework/integration/jpa/inbound/JpaPollingChannelAdapter.java @@ -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. @@ -29,7 +29,7 @@ import org.springframework.util.Assert; *
  • Sql Native Query
    • *
  • JpQl Named Query
    • *
  • Sql Native Named Query
    • - * + * . * * After the objects have been polled, it also possibly to either: * @@ -64,7 +64,7 @@ public class JpaPollingChannelAdapter extends AbstractMessageSource { } /** - * Check for mandatory attributes + * Check for mandatory attributes. */ @Override protected void onInit() { diff --git a/spring-integration-mail/src/main/java/org/springframework/integration/mail/ImapMailReceiver.java b/spring-integration-mail/src/main/java/org/springframework/integration/mail/ImapMailReceiver.java index 3911f12004..359cd72380 100755 --- a/spring-integration-mail/src/main/java/org/springframework/integration/mail/ImapMailReceiver.java +++ b/spring-integration-mail/src/main/java/org/springframework/integration/mail/ImapMailReceiver.java @@ -99,7 +99,7 @@ public class ImapMailReceiver extends AbstractMailReceiver { /** * Provides a way to set custom {@link SearchTermStrategy} to compile a {@link SearchTerm} - * to be applied when retrieving mail + * to be applied when retrieving mail. * @param searchTermStrategy The search term strategy implementation. */ public void setSearchTermStrategy(SearchTermStrategy searchTermStrategy) { diff --git a/spring-integration-mail/src/main/java/org/springframework/integration/mail/MailSendingMessageHandler.java b/spring-integration-mail/src/main/java/org/springframework/integration/mail/MailSendingMessageHandler.java index 457d636853..750a1c4e70 100644 --- a/spring-integration-mail/src/main/java/org/springframework/integration/mail/MailSendingMessageHandler.java +++ b/spring-integration-mail/src/main/java/org/springframework/integration/mail/MailSendingMessageHandler.java @@ -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. @@ -43,12 +43,13 @@ import org.springframework.util.StringUtils; * header is required. Otherwise, a String type is expected, and its content * will be used as the text within a {@link SimpleMailMessage}. * - * @see MailHeaders * * @author Marius Bogoevici * @author Mark Fisher * @author Oleg Zhurakousky * @author Artem Bilan + * + * @see MailHeaders */ public class MailSendingMessageHandler extends AbstractMessageHandler { diff --git a/spring-integration-mail/src/main/java/org/springframework/integration/mail/SearchTermStrategy.java b/spring-integration-mail/src/main/java/org/springframework/integration/mail/SearchTermStrategy.java index 9970c75aee..0f471c945d 100644 --- a/spring-integration-mail/src/main/java/org/springframework/integration/mail/SearchTermStrategy.java +++ b/spring-integration-mail/src/main/java/org/springframework/integration/mail/SearchTermStrategy.java @@ -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. @@ -21,20 +21,19 @@ import javax.mail.Folder; import javax.mail.search.SearchTerm; /** - * Strategy to be used to generate a {@link SearchTerm} - * - * See {@link ImapMailReceiver} + * Strategy to be used to generate a {@link SearchTerm}. * * @author Oleg Zhurakousky + * * @since 2.2 * + * @see ImapMailReceiver */ @FunctionalInterface public interface SearchTermStrategy { /** - * Will generate an instance of the {@link SearchTerm} - * + * Will generate an instance of the {@link SearchTerm}. * @param supportedFlags The supported flags. * @param folder The folder. * @return The search term. diff --git a/spring-integration-mail/src/main/java/org/springframework/integration/mail/dsl/ImapIdleChannelAdapterSpec.java b/spring-integration-mail/src/main/java/org/springframework/integration/mail/dsl/ImapIdleChannelAdapterSpec.java index 549ab5852a..72372e302f 100644 --- a/spring-integration-mail/src/main/java/org/springframework/integration/mail/dsl/ImapIdleChannelAdapterSpec.java +++ b/spring-integration-mail/src/main/java/org/springframework/integration/mail/dsl/ImapIdleChannelAdapterSpec.java @@ -374,8 +374,8 @@ public class ImapIdleChannelAdapterSpec * Seconds; default 120 (2 minutes). * @param interval the interval. * @return the spec. - * @see ImapMailReceiver#setCancelIdleInterval(long) * @since 5.2 + * @see ImapMailReceiver#setCancelIdleInterval(long) */ public ImapIdleChannelAdapterSpec cancelIdleInterval(long interval) { assertReceiver(); @@ -387,8 +387,8 @@ public class ImapIdleChannelAdapterSpec * Determine how the content is rendered. * @param simpleContent true for simple content. * @return the spec. - * @see ImapMailReceiver#setSimpleContent(boolean) * @since 5.5 + * @see ImapMailReceiver#setSimpleContent(boolean) */ public ImapIdleChannelAdapterSpec simpleContent(boolean simpleContent) { assertReceiver(); diff --git a/spring-integration-mail/src/main/java/org/springframework/integration/mail/transformer/AbstractMailMessageTransformer.java b/spring-integration-mail/src/main/java/org/springframework/integration/mail/transformer/AbstractMailMessageTransformer.java index e3f08cbeeb..1f07e59686 100644 --- a/spring-integration-mail/src/main/java/org/springframework/integration/mail/transformer/AbstractMailMessageTransformer.java +++ b/spring-integration-mail/src/main/java/org/springframework/integration/mail/transformer/AbstractMailMessageTransformer.java @@ -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. @@ -33,6 +33,8 @@ import org.springframework.messaging.Message; * Base class for Transformers that convert from a JavaMail Message to a * Spring Integration Message. * + * @param the target payload type. + * * @author Mark Fisher * @author Gary Russell * @author Artem Bilan @@ -88,7 +90,7 @@ public abstract class AbstractMailMessageTransformer implements Transformer, throws Exception; // NOSONAR - private Map extractHeaderMapFromMailMessage(javax.mail.Message mailMessage) { + private static Map extractHeaderMapFromMailMessage(javax.mail.Message mailMessage) { return MailUtils.extractStandardHeaders(mailMessage); } diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbInboundChannelAdapterParser.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbInboundChannelAdapterParser.java index 3f49688497..4791f75a51 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbInboundChannelAdapterParser.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbInboundChannelAdapterParser.java @@ -27,7 +27,7 @@ import org.springframework.integration.config.xml.IntegrationNamespaceUtils; import org.springframework.integration.mongodb.inbound.MongoDbMessageSource; /** - * Parser for MongoDb store inbound adapters + * Parser for MongoDb store inbound adapters. * * @author Amol Nayak * @author Oleg Zhurakousky diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundChannelAdapterParser.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundChannelAdapterParser.java index bd93ae5d3e..a66595385b 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundChannelAdapterParser.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundChannelAdapterParser.java @@ -1,5 +1,5 @@ /* - * Copyright 2007-2019 the original author or authors. + * Copyright 2007-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. @@ -24,9 +24,10 @@ import org.springframework.beans.factory.xml.ParserContext; import org.springframework.integration.config.xml.AbstractOutboundChannelAdapterParser; import org.springframework.integration.mongodb.outbound.MongoDbStoringMessageHandler; /** - * Parser for Mongodb store outbound adapters + * Parser for Mongodb store outbound adapters. * * @author Oleg Zhurakousky + * * @since 2.2 */ public class MongoDbOutboundChannelAdapterParser extends AbstractOutboundChannelAdapterParser { diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundGatewayParser.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundGatewayParser.java index 559be1fcad..fdd6a2cce9 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundGatewayParser.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoDbOutboundGatewayParser.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -27,7 +27,7 @@ import org.springframework.integration.mongodb.outbound.MongoDbOutboundGateway; import org.springframework.util.StringUtils; /** - * Parser for MongoDb outbound gateways + * Parser for MongoDb outbound gateways. * * @author Xavier Padro * @author Artem Bilan diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoParserUtils.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoParserUtils.java index 26353913c5..d1aaa5532d 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoParserUtils.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/config/MongoParserUtils.java @@ -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. @@ -25,7 +25,7 @@ import org.springframework.integration.config.xml.IntegrationNamespaceUtils; import org.springframework.util.StringUtils; /** - * Utility class used by mongo parsers + * Utility class used by mongo parsers. * * @author Oleg Zhurakousky * @author Gary Russell @@ -40,7 +40,7 @@ final class MongoParserUtils { /** * Will parse and validate - * 'mongodb-template', 'mongodb-factory', 'collection-name', 'collection-name-expression' and 'mongo-converter' + * 'mongodb-template', 'mongodb-factory', 'collection-name', 'collection-name-expression' and 'mongo-converter'. * @param element the element to parse * @param parserContext the context for parsing * @param builder the bean definition builder diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/AbstractMongoDbMessageSourceSpec.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/AbstractMongoDbMessageSourceSpec.java index ac0128c5ef..7d3235cd9f 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/AbstractMongoDbMessageSourceSpec.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/AbstractMongoDbMessageSourceSpec.java @@ -30,6 +30,9 @@ import org.springframework.integration.mongodb.inbound.AbstractMongoDbMessageSou /** * A {@link MessageSourceSpec} extension for common MongoDB sources options. * + * @param target spec type. + * @param target message source type. + * * @author Artem Bilan * * @since 5.5 @@ -39,7 +42,7 @@ public class AbstractMongoDbMessageSourceSpec { /** - * Allow you to set the type of the entityClass that will be passed to the the MongoDB query method. + * Allow you to set the type of the entityClass that will be passed to the MongoDB query method. * Default is {@link com.mongodb.DBObject}. * @param entityClass The entity class. * @return the spec diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDb.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDb.java index 2ea1ab06f4..17015bf374 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDb.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDb.java @@ -27,7 +27,7 @@ import org.springframework.integration.expression.ValueExpression; import org.springframework.integration.mongodb.inbound.MongoDbChangeStreamMessageProducer; /** - * Factory class for building MongoDb components + * Factory class for building MongoDb components. * * @author Xavier Padro * @author Artem Bilan diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDbOutboundGatewaySpec.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDbOutboundGatewaySpec.java index ff59898a34..b857237247 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDbOutboundGatewaySpec.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/MongoDbOutboundGatewaySpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -30,7 +30,7 @@ import org.springframework.integration.mongodb.outbound.MongoDbOutboundGateway; import org.springframework.messaging.Message; /** - * A {@link MessageHandlerSpec} extension for the MongoDb Outbound endpoint {@link MongoDbOutboundGateway} + * A {@link MessageHandlerSpec} extension for the MongoDb Outbound endpoint {@link MongoDbOutboundGateway}. * * @author Xavier Padro * @author Artem Bilan diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/metadata/MongoDbMetadataStore.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/metadata/MongoDbMetadataStore.java index 4aa96428e4..d5d0fc3457 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/metadata/MongoDbMetadataStore.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/metadata/MongoDbMetadataStore.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2020 the original author or authors. + * Copyright 2015-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 MongoDbMetadataStore implements ConcurrentMetadataStore { /** * Configure the MongoDbMetadataStore by provided {@link MongoDatabaseFactory} and - * collection name + * collection name. * @param factory the mongodb factory * @param collectionName the collection name where it persists the data */ diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MessageCollectionCallback.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MessageCollectionCallback.java index 72d8fba201..8ce0726c91 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MessageCollectionCallback.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MessageCollectionCallback.java @@ -1,5 +1,5 @@ /* - * Copyright 2018-2019 the original author or authors. + * Copyright 2018-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. @@ -34,6 +34,8 @@ import com.mongodb.client.MongoCollection; * but with {@code Message requestMessage} context during {@code handleMessage()} * process in the {@link MongoDbOutboundGateway}. * + * @param the expected item type. + * * @author Artem Bilan * * @since 5.0.11 diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbOutboundGateway.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbOutboundGateway.java index 72b036c519..eed6fac6b9 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbOutboundGateway.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbOutboundGateway.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -37,7 +37,7 @@ import org.springframework.messaging.Message; import org.springframework.util.Assert; /** - * Makes outbound operations to query a MongoDb database using a {@link MongoOperations} + * Makes outbound operations to query a MongoDb database using a {@link MongoOperations}. * * @author Xavier Padro * @author Artem Bilan diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbStoringMessageHandler.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbStoringMessageHandler.java index 899d649d6a..bca3eedf37 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbStoringMessageHandler.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/MongoDbStoringMessageHandler.java @@ -1,5 +1,5 @@ /* - * Copyright 2007-2020 the original author or authors. + * Copyright 2007-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,51 +35,48 @@ import org.springframework.util.Assert; * @author Amol Nayak * @author Oleg Zhurakousky * @author Gary Russell + * * @since 2.2 * */ public class MongoDbStoringMessageHandler extends AbstractMessageHandler { - private volatile MongoOperations mongoTemplate; + private final MongoDatabaseFactory mongoDbFactory; - private volatile MongoDatabaseFactory mongoDbFactory; + private MongoOperations mongoTemplate; - private volatile MongoConverter mongoConverter; + private MongoConverter mongoConverter; - private volatile StandardEvaluationContext evaluationContext; + private StandardEvaluationContext evaluationContext; - private volatile Expression collectionNameExpression = new LiteralExpression("data"); + private Expression collectionNameExpression = new LiteralExpression("data"); private volatile boolean initialized = false; /** - * Will construct this instance using provided {@link MongoDatabaseFactory} - * + * Will construct this instance using provided {@link MongoDatabaseFactory}. * @param mongoDbFactory The mongodb factory. */ public MongoDbStoringMessageHandler(MongoDatabaseFactory mongoDbFactory) { Assert.notNull(mongoDbFactory, "'mongoDbFactory' must not be null"); - this.mongoDbFactory = mongoDbFactory; } /** * Will construct this instance using fully created and initialized instance of - * provided {@link MongoOperations} - * + * provided {@link MongoOperations}. * @param mongoTemplate The MongoOperations implementation. */ public MongoDbStoringMessageHandler(MongoOperations mongoTemplate) { Assert.notNull(mongoTemplate, "'mongoTemplate' must not be null"); - this.mongoTemplate = mongoTemplate; + this.mongoDbFactory = null; } /** - * Allows you to provide custom {@link MongoConverter} used to assist in serialization + * Allow providing custom {@link MongoConverter} used to assist in serialization * of data written to MongoDb. Only allowed if this instance was constructed with a * {@link MongoDatabaseFactory}. - * * @param mongoConverter The mongo converter. */ public void setMongoConverter(MongoConverter mongoConverter) { @@ -89,9 +86,8 @@ public class MongoDbStoringMessageHandler extends AbstractMessageHandler { } /** - * Sets the SpEL {@link Expression} that should resolve to a collection name + * Set the SpEL {@link Expression} that should resolve to a collection name * used by {@link MongoOperations} to store data - * * @param collectionNameExpression The collection name expression. */ public void setCollectionNameExpression(Expression collectionNameExpression) { @@ -124,4 +120,5 @@ public class MongoDbStoringMessageHandler extends AbstractMessageHandler { this.mongoTemplate.save(payload, collectionName); } + } diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/ReactiveMongoDbStoringMessageHandler.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/ReactiveMongoDbStoringMessageHandler.java index 06eee23a9d..b21a15036b 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/ReactiveMongoDbStoringMessageHandler.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/outbound/ReactiveMongoDbStoringMessageHandler.java @@ -1,5 +1,5 @@ /* - * Copyright 2019-2020 the original author or authors. + * Copyright 2019-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. @@ -55,7 +55,7 @@ public class ReactiveMongoDbStoringMessageHandler extends AbstractReactiveMessag private volatile boolean initialized = false; /** - * Construct this instance using a provided {@link ReactiveMongoDatabaseFactory} + * Construct this instance using a provided {@link ReactiveMongoDatabaseFactory}. * @param mongoDbFactory The reactive mongoDatabase factory. */ public ReactiveMongoDbStoringMessageHandler(ReactiveMongoDatabaseFactory mongoDbFactory) { @@ -65,7 +65,7 @@ public class ReactiveMongoDbStoringMessageHandler extends AbstractReactiveMessag /** * Construct this instance using a fully created and initialized instance of provided - * {@link ReactiveMongoOperations} + * {@link ReactiveMongoOperations}. * @param mongoTemplate The ReactiveMongoOperations implementation. */ public ReactiveMongoDbStoringMessageHandler(ReactiveMongoOperations mongoTemplate) { diff --git a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/support/MongoHeaders.java b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/support/MongoHeaders.java index dd6a6b61fb..1b4f61c5f5 100644 --- a/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/support/MongoHeaders.java +++ b/spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/support/MongoHeaders.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2020 the original author or authors. + * Copyright 2016-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. @@ -17,8 +17,8 @@ package org.springframework.integration.mongodb.support; /** - * Pre-defined names and prefixes to be used for - * for dealing with headers required by Mongo components + * Pre-defined names and prefixes to be used + * for dealing with headers required by Mongo components. * * @author Gary Russell * @author Artem Bilan diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java index 91b75f1c3b..c0f05904be 100644 --- a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttMessageDrivenChannelAdapterParser.java @@ -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. @@ -26,10 +26,11 @@ import org.springframework.integration.config.xml.IntegrationNamespaceUtils; import org.springframework.integration.mqtt.inbound.MqttPahoMessageDrivenChannelAdapter; /** - * The MqttAdapter Message Driven Channel adapter parser + * The MqttAdapter Message Driven Channel adapter parser. * * @author Gary Russell * @author Artem Bilan + * * @since 4.0 * */ diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java index 805116e40a..3966a94d38 100644 --- a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/config/xml/MqttNamespaceHandler.java @@ -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. @@ -19,9 +19,10 @@ package org.springframework.integration.mqtt.config.xml; import org.springframework.integration.config.xml.AbstractIntegrationNamespaceHandler; /** - * The namespace handler for the MqttAdapter namespace + * The namespace handler for the MqttAdapter namespace. * * @author Gary Russell + * * @since 4.0 * */ diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java index 01c287e9f4..6f638cbdf1 100644 --- a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/outbound/AbstractMqttMessageHandler.java @@ -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. @@ -117,8 +117,8 @@ public abstract class AbstractMqttMessageHandler extends AbstractMessageHandler * Set the qos expression; default "headers['mqtt_qos']". * Only applies if a message converter is not provided. * @param qosExpression the expression. - * @see #setConverter(MessageConverter) * @since 5.0 + * @see #setConverter(MessageConverter) */ public void setQosExpression(Expression qosExpression) { Assert.notNull(qosExpression, "'qosExpression' cannot be null"); @@ -129,8 +129,8 @@ public abstract class AbstractMqttMessageHandler extends AbstractMessageHandler * Set the qos expression; default "headers['mqtt_qos']". * Only applies if a message converter is not provided. * @param qosExpression the expression. - * @see #setConverter(MessageConverter) * @since 5.0 + * @see #setConverter(MessageConverter) */ public void setQosExpressionString(String qosExpression) { Assert.hasText(qosExpression, "'qosExpression' must not be null or empty"); @@ -152,8 +152,8 @@ public abstract class AbstractMqttMessageHandler extends AbstractMessageHandler * Set the retained expression; default "headers['mqtt_retained']". * Only applies if a message converter is not provided. * @param retainedExpression the expression. - * @see #setConverter(MessageConverter) * @since 5.0 + * @see #setConverter(MessageConverter) */ public void setRetainedExpression(Expression retainedExpression) { Assert.notNull(retainedExpression, "'qosExpression' cannot be null"); @@ -164,8 +164,8 @@ public abstract class AbstractMqttMessageHandler extends AbstractMessageHandler * Set the retained expression; default "headers['mqtt_retained']". * Only applies if a message converter is not provided. * @param retainedExpression the expression. - * @see #setConverter(MessageConverter) * @since 5.0 + * @see #setConverter(MessageConverter) */ public void setRetainedExpressionString(String retainedExpression) { Assert.hasText(retainedExpression, "'qosExpression' must not be null or empty"); diff --git a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java index 22e67499bc..b9bb5bba06 100644 --- a/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java +++ b/spring-integration-mqtt/src/main/java/org/springframework/integration/mqtt/support/MqttUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-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,9 +21,10 @@ import org.eclipse.paho.client.mqttv3.MqttConnectOptions; import org.springframework.beans.BeanUtils; /** - * MQTT Utilities + * MQTT Utilities. * * @author Gary Russell + * * @since 5.4 * */ diff --git a/spring-integration-r2dbc/src/main/java/org/springframework/integration/r2dbc/outbound/R2dbcMessageHandler.java b/spring-integration-r2dbc/src/main/java/org/springframework/integration/r2dbc/outbound/R2dbcMessageHandler.java index 810898c1e0..9e4bdaac46 100644 --- a/spring-integration-r2dbc/src/main/java/org/springframework/integration/r2dbc/outbound/R2dbcMessageHandler.java +++ b/spring-integration-r2dbc/src/main/java/org/springframework/integration/r2dbc/outbound/R2dbcMessageHandler.java @@ -1,5 +1,5 @@ /* - * Copyright 2020 the original author or authors. + * Copyright 2020-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. @@ -73,7 +73,7 @@ public class R2dbcMessageHandler extends AbstractReactiveMessageHandler { /** * Construct this instance using a fully created and initialized instance of provided - * {@link R2dbcEntityOperations} + * {@link R2dbcEntityOperations}. * @param r2dbcEntityOperations The R2dbcEntityOperations implementation. */ @SuppressWarnings("deprecation") diff --git a/spring-integration-redis/src/main/java/org/springframework/integration/redis/outbound/RedisStoreWritingMessageHandler.java b/spring-integration-redis/src/main/java/org/springframework/integration/redis/outbound/RedisStoreWritingMessageHandler.java index 77a15d1904..95ec60d0f9 100644 --- a/spring-integration-redis/src/main/java/org/springframework/integration/redis/outbound/RedisStoreWritingMessageHandler.java +++ b/spring-integration-redis/src/main/java/org/springframework/integration/redis/outbound/RedisStoreWritingMessageHandler.java @@ -150,8 +150,8 @@ public class RedisStoreWritingMessageHandler extends AbstractMessageHandler { * {@link #setKey(String)} method instead of this one (they are mutually exclusive). * If neither setter is called, the default expression will be 'headers.{@link RedisHeaders#KEY}'. * @param keyExpression The key expression. - * @see #setKey(String) * @since 5.0 + * @see #setKey(String) */ public void setKeyExpressionString(String keyExpression) { Assert.hasText(keyExpression, "'keyExpression' must not be empty"); diff --git a/spring-integration-rsocket/src/main/java/org/springframework/integration/rsocket/dsl/RSocketOutboundGatewaySpec.java b/spring-integration-rsocket/src/main/java/org/springframework/integration/rsocket/dsl/RSocketOutboundGatewaySpec.java index bc052ccdd2..6ac0e4868f 100644 --- a/spring-integration-rsocket/src/main/java/org/springframework/integration/rsocket/dsl/RSocketOutboundGatewaySpec.java +++ b/spring-integration-rsocket/src/main/java/org/springframework/integration/rsocket/dsl/RSocketOutboundGatewaySpec.java @@ -1,5 +1,5 @@ /* - * Copyright 2019-2020 the original author or authors. + * Copyright 2019-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. @@ -62,8 +62,8 @@ public class RSocketOutboundGatewaySpec extends MessageHandlerSpec(interactionModel)); @@ -75,8 +75,8 @@ public class RSocketOutboundGatewaySpec extends MessageHandlerSpec the expected request message payload type. * @return the spec - * @see RSocketOutboundGateway#setInteractionModelExpression(Expression) * @since 5.2.2 + * @see RSocketOutboundGateway#setInteractionModelExpression(Expression) */ public

    RSocketOutboundGatewaySpec interactionModel(Function, ?> interactionModelFunction) { return interactionModel(new FunctionExpression<>(interactionModelFunction)); @@ -87,8 +87,8 @@ public class RSocketOutboundGatewaySpec extends MessageHandlerSpec the paylaod type. + * * @author Mark Fisher * @author Stefan Reuter * @author Artem Bilan @@ -79,7 +81,7 @@ public abstract class AbstractScriptExecutingMessageProcessor } /** - * Executes the script and returns the result. + * Execute the script and return the result. */ @Override @Nullable diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java index d9c3719ee5..141b6dc935 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java @@ -191,8 +191,8 @@ public class DefaultSftpSessionFactory implements SessionFactory, Share * Required if {@link #setAllowUnknownKeys(boolean) allowUnknownKeys} is * false (default). * @param knownHosts The known hosts. - * @see JSch#setKnownHosts(String) * @deprecated since 5.2.5 in favor of {@link #setKnownHostsResource(Resource)} + * @see JSch#setKnownHosts(String) */ @Deprecated public void setKnownHosts(String knownHosts) { @@ -203,8 +203,8 @@ public class DefaultSftpSessionFactory implements SessionFactory, Share * Specifies the filename that will be used for a host key repository. * The file has the same format as OpenSSH's known_hosts file. * @param knownHosts the resource for known hosts. - * @see JSch#setKnownHosts(java.io.InputStream) * @since 5.2.5 + * @see JSch#setKnownHosts(java.io.InputStream) */ public void setKnownHostsResource(Resource knownHosts) { this.knownHosts = knownHosts; @@ -351,8 +351,8 @@ public class DefaultSftpSessionFactory implements SessionFactory, Share * {@link #setPrivateKeyPassphrase(String) passphrase} are not allowed because those values * will be obtained from the {@link UserInfo}. * @param userInfo the UserInfo. - * @see com.jcraft.jsch.Session#setUserInfo(com.jcraft.jsch.UserInfo) * @since 4.1.7 + * @see com.jcraft.jsch.Session#setUserInfo(com.jcraft.jsch.UserInfo) */ public void setUserInfo(UserInfo userInfo) { this.userInfo = userInfo; @@ -371,7 +371,7 @@ public class DefaultSftpSessionFactory implements SessionFactory, Share } /** - * Set the connect timeout. + * Set the connection timeout. * @param timeout the timeout to set. * @since 5.2 */ diff --git a/spring-integration-stomp/src/main/java/org/springframework/integration/stomp/support/IntegrationStompHeaders.java b/spring-integration-stomp/src/main/java/org/springframework/integration/stomp/support/IntegrationStompHeaders.java index 45ab0c1de7..1a11cbcd23 100644 --- a/spring-integration-stomp/src/main/java/org/springframework/integration/stomp/support/IntegrationStompHeaders.java +++ b/spring-integration-stomp/src/main/java/org/springframework/integration/stomp/support/IntegrationStompHeaders.java @@ -1,5 +1,5 @@ /* - * Copyright 2015-2019 the original author or authors. + * Copyright 2015-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. @@ -26,8 +26,10 @@ import org.springframework.messaging.simp.stomp.StompHeaders; * The STOMP headers with Integration-friendly {@code stomp_} prefix. * * @author Artem Bilan - * @see StompHeaders + * * @since 4.2 + * + * @see StompHeaders */ public abstract class IntegrationStompHeaders { diff --git a/spring-integration-stream/src/main/java/org/springframework/integration/stream/CharacterStreamReadingMessageSource.java b/spring-integration-stream/src/main/java/org/springframework/integration/stream/CharacterStreamReadingMessageSource.java index 55876f398c..450394047f 100644 --- a/spring-integration-stream/src/main/java/org/springframework/integration/stream/CharacterStreamReadingMessageSource.java +++ b/spring-integration-stream/src/main/java/org/springframework/integration/stream/CharacterStreamReadingMessageSource.java @@ -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. @@ -133,7 +133,7 @@ public class CharacterStreamReadingMessageSource extends AbstractMessageSource responseValidator) { this.responseValidator = responseValidator; diff --git a/spring-integration-ws/src/main/java/org/springframework/integration/ws/AbstractWebServiceOutboundGateway.java b/spring-integration-ws/src/main/java/org/springframework/integration/ws/AbstractWebServiceOutboundGateway.java index 49f64213fc..48e857bfe1 100644 --- a/spring-integration-ws/src/main/java/org/springframework/integration/ws/AbstractWebServiceOutboundGateway.java +++ b/spring-integration-ws/src/main/java/org/springframework/integration/ws/AbstractWebServiceOutboundGateway.java @@ -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. @@ -118,9 +118,9 @@ public abstract class AbstractWebServiceOutboundGateway extends AbstractReplyPro * Specify whether the URI should be encoded after any uriVariables * are expanded and before sending the request. The default value is true. * @param encodeUri true if the URI should be encoded. - * @see org.springframework.web.util.UriComponentsBuilder * @since 4.1 * @deprecated since 5.3 in favor of {@link #setEncodingMode} + * @see org.springframework.web.util.UriComponentsBuilder */ @Deprecated public void setEncodeUri(boolean encodeUri) { @@ -132,7 +132,7 @@ public abstract class AbstractWebServiceOutboundGateway extends AbstractReplyPro /** * Set the encoding mode to use. - * By default this is set to {@link DefaultUriBuilderFactory.EncodingMode#TEMPLATE_AND_VALUES}. + * By default, this is set to {@link DefaultUriBuilderFactory.EncodingMode#TEMPLATE_AND_VALUES}. * @param encodingMode the mode to use for uri encoding * @since 5.3 */ diff --git a/spring-integration-xml/src/main/java/org/springframework/integration/xml/splitter/XPathMessageSplitter.java b/spring-integration-xml/src/main/java/org/springframework/integration/xml/splitter/XPathMessageSplitter.java index eca16e93ab..3d615024fa 100644 --- a/spring-integration-xml/src/main/java/org/springframework/integration/xml/splitter/XPathMessageSplitter.java +++ b/spring-integration-xml/src/main/java/org/springframework/integration/xml/splitter/XPathMessageSplitter.java @@ -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. @@ -190,8 +190,8 @@ public class XPathMessageSplitter extends AbstractMessageSplitter { * used to override any of the same properties in affect * for the transformation. * @param outputProperties the {@link Transformer} output properties. - * @see Transformer#setOutputProperties(Properties) * @since 4.2 + * @see Transformer#setOutputProperties(Properties) */ public void setOutputProperties(Properties outputProperties) { this.outputProperties = outputProperties; diff --git a/src/checkstyle/checkstyle-suppressions.xml b/src/checkstyle/checkstyle-suppressions.xml index 8414a71994..51b0e52494 100644 --- a/src/checkstyle/checkstyle-suppressions.xml +++ b/src/checkstyle/checkstyle-suppressions.xml @@ -11,4 +11,5 @@ + diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml index 4ce3280c1b..19d80b6458 100644 --- a/src/checkstyle/checkstyle.xml +++ b/src/checkstyle/checkstyle.xml @@ -111,31 +111,28 @@ - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +