From 6c1454ae3ddf34b851b768c54bfaa19cc20864cd Mon Sep 17 00:00:00 2001 From: Mark Fisher Date: Tue, 22 Nov 2011 21:38:04 -0500 Subject: [PATCH] INT-2238 removing warnings in JavaDoc --- .../aggregator/CorrelatingMessageBarrier.java | 16 ++++++++++++---- .../aggregator/MessageGroupProcessor.java | 4 ++-- .../mapping/AbstractHeaderMapper.java | 4 ++-- .../transformer/ContentEnricher.java | 2 +- .../ContinuousQueryMessageProducer.java | 3 +-- .../TcpConnectionFactoryFactoryBean.java | 11 +++++------ .../jdbc/StoredProcOutboundGateway.java | 6 +++--- .../jdbc/StoredProcPollingChannelAdapter.java | 2 +- .../jdbc/config/StoredProcParserUtils.java | 19 +++++-------------- .../integration/scripting/ScriptExecutor.java | 7 ++----- .../sftp/gateway/SftpOutboundGateway.java | 1 - .../sftp/session/SftpFileInfo.java | 5 ----- .../test/support/RequestResponseScenario.java | 8 ++++---- .../SingleRequestResponseScenarioTest.java | 11 ++++++----- .../ws/DefaultSoapHeaderMapper.java | 4 ++-- .../xmpp/support/XmppHeaderMapper.java | 2 +- 16 files changed, 47 insertions(+), 58 deletions(-) diff --git a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/CorrelatingMessageBarrier.java b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/CorrelatingMessageBarrier.java index d99cef548c..1191c6aedc 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/CorrelatingMessageBarrier.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/CorrelatingMessageBarrier.java @@ -10,6 +10,7 @@ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. */ + package org.springframework.integration.aggregator; import java.util.Iterator; @@ -18,6 +19,7 @@ import java.util.concurrent.ConcurrentMap; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; + import org.springframework.integration.Message; import org.springframework.integration.core.MessageSource; import org.springframework.integration.handler.AbstractMessageHandler; @@ -32,7 +34,7 @@ import org.springframework.integration.store.SimpleMessageStore; * {@link org.springframework.integration.aggregator.ReleaseStrategy#canRelease(org.springframework.integration.store.MessageGroup) canRelease(..)} * method). *

- * This class differs from CorrelatingMessageHandler in that it completely decouples the receiver and the sender. It can + * This class differs from AbstractCorrelatingMessageHandler in that it completely decouples the receiver and the sender. It can * be applied in scenarios where completion of a message group is not well defined but only a certain amount of messages * for any given correlation key may be processed at a time. *

@@ -42,17 +44,21 @@ import org.springframework.integration.store.SimpleMessageStore; * @author Iwein Fuld * @author Oleg Zhurakousky * - * @see CorrelatingMessageHandler + * @see AbstractCorrelatingMessageHandler */ public class CorrelatingMessageBarrier extends AbstractMessageHandler implements MessageSource { + private static final Log log = LogFactory.getLog(CorrelatingMessageBarrier.class); - private CorrelationStrategy correlationStrategy; - private ReleaseStrategy releaseStrategy; + private volatile CorrelationStrategy correlationStrategy; + + private volatile ReleaseStrategy releaseStrategy; private final ConcurrentMap correlationLocks = new ConcurrentHashMap(); + private final MessageGroupStore store; + public CorrelatingMessageBarrier(MessageGroupStore store) { this.store = store; } @@ -61,6 +67,7 @@ public class CorrelatingMessageBarrier extends AbstractMessageHandler implements this(new SimpleMessageStore(0)); } + /** * Set the CorrelationStrategy to be used to determine the correlation key for incoming messages */ @@ -127,4 +134,5 @@ public class CorrelatingMessageBarrier extends AbstractMessageHandler implements correlationLocks.remove(key); store.removeMessageGroup(key); } + } diff --git a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/MessageGroupProcessor.java b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/MessageGroupProcessor.java index 6e69291dda..4c61b4e9eb 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/aggregator/MessageGroupProcessor.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/aggregator/MessageGroupProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2010 the original author or authors. + * Copyright 2002-2011 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -19,7 +19,7 @@ import org.springframework.integration.store.MessageGroup; * A processor for correlated groups of messages. * * @author Iwein Fuld - * @see org.springframework.integration.aggregator.CorrelatingMessageHandler + * @see org.springframework.integration.aggregator.AbstractCorrelatingMessageHandler */ public interface MessageGroupProcessor { 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 e36fc469ea..3203da4879 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 @@ -76,7 +76,7 @@ public abstract class AbstractHeaderMapper implements RequestReplyHeaderMappe * The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched. *

* This will match the header name directly or, for non-standard headers, it will match - * the header name prefixed with the value specified by {@link #setInboundPrefix(String)}. + * the header name prefixed with the value, if specified, by {@link #setUserDefinedHeaderPrefix(String)}. */ public void setRequestHeaderNames(String[] requestHeaderNames) { Assert.notNull(requestHeaderNames, "'requestHeaderNames' must not be null"); @@ -88,7 +88,7 @@ public abstract class AbstractHeaderMapper implements RequestReplyHeaderMappe * FROM a Spring Integration Message's headers. * The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched. *

- * Any non-standard headers will be prefixed with the value specified by {@link #setOutboundPrefix(String)}. + * Any non-standard headers will be prefixed with the value specified by {@link #setUserDefinedHeaderPrefix(String)}. */ public void setReplyHeaderNames(String[] replyHeaderNames) { Assert.notNull(replyHeaderNames, "'replyHeaderNames' must not be null"); 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 f28f63c235..b1a036ca9e 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 @@ -88,7 +88,7 @@ public class ContentEnricher extends AbstractReplyProducingMessageHandler implem /** * Sets the content enricher's request channel. If specified, then an internal - * {@link Gateway} will be initialized. Setting a request channel is optional. + * Gateway will be initialized. Setting a request channel is optional. * Not setting a request channel is useful in situations where * message payloads shall be enriched with static values only. */ diff --git a/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/ContinuousQueryMessageProducer.java b/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/ContinuousQueryMessageProducer.java index c340a3e228..3af438e809 100644 --- a/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/ContinuousQueryMessageProducer.java +++ b/spring-integration-gemfire/src/main/java/org/springframework/integration/gemfire/inbound/ContinuousQueryMessageProducer.java @@ -58,8 +58,7 @@ public class ContinuousQueryMessageProducer extends SpelMessageProducerSupport i /** * - * @param queryListenerContainer a - * {@link org.springframework.data.gemfire.listener.QueryListenerContainer} + * @param queryListenerContainer a {@link org.springframework.data.gemfire.listener.ContinuousQueryListenerContainer} * @param query the query string */ public ContinuousQueryMessageProducer(ContinuousQueryListenerContainer queryListenerContainer, String query) { diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java index 0e85635220..9434e8b7aa 100644 --- a/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java +++ b/spring-integration-ip/src/main/java/org/springframework/integration/ip/config/TcpConnectionFactoryFactoryBean.java @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.integration.ip.config; import java.util.concurrent.Executor; @@ -38,10 +39,8 @@ import org.springframework.integration.ip.tcp.serializer.ByteArrayCrLfSerializer * * @author Gary Russell * @since 2.0.5 - * */ -public class TcpConnectionFactoryFactoryBean extends AbstractFactoryBean - implements SmartLifecycle, BeanNameAware { +public class TcpConnectionFactoryFactoryBean extends AbstractFactoryBean implements SmartLifecycle, BeanNameAware { private volatile AbstractConnectionFactory connectionFactory; @@ -168,7 +167,7 @@ public class TcpConnectionFactoryFactoryBean extends AbstractFactoryBeanPostgreSQL * * - * See also: {@link http://static.springsource.org/spring/docs/3.1.0.M2/spring-framework-reference/html/jdbc.html} + * See also: http://static.springsource.org/spring/docs/3.1.0.M2/spring-framework-reference/html/jdbc.html */ public void setSqlParameters(List sqlParameters) { this.executor.setSqlParameters(sqlParameters); @@ -137,7 +138,7 @@ public class StoredProcOutboundGateway extends AbstractReplyProducingMessageHand /** * Does your stored procedure return one or more result sets? If so, you - * can use the provided method for setting the respective Rowmappers. + * can use the provided method for setting the respective RowMappers. */ public void setReturningResultSetRowMappers( Map> returningResultSetRowMappers) { @@ -256,7 +257,6 @@ public class StoredProcOutboundGateway extends AbstractReplyProducingMessageHand * * Only few developers will probably ever like to process update counts, thus * the value defaults to true. - * */ public void setSkipUndeclaredResults(boolean skipUndeclaredResults) { this.executor.setSkipUndeclaredResults(skipUndeclaredResults); diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/StoredProcPollingChannelAdapter.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/StoredProcPollingChannelAdapter.java index 21bdd7dae2..7e9d7f3052 100644 --- a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/StoredProcPollingChannelAdapter.java +++ b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/StoredProcPollingChannelAdapter.java @@ -167,7 +167,7 @@ public class StoredProcPollingChannelAdapter extends IntegrationObjectSupport im *

  • PostgreSQL
    • * * - * See also: {@link http://static.springsource.org/spring/docs/3.1.0.M2/spring-framework-reference/html/jdbc.html} + * See also: http://static.springsource.org/spring/docs/3.1.0.M2/spring-framework-reference/html/jdbc.html */ public void setSqlParameters(List sqlParameters) { this.executor.setSqlParameters(sqlParameters); diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/StoredProcParserUtils.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/StoredProcParserUtils.java index 1de0e2ac8f..75096e9d4b 100644 --- a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/StoredProcParserUtils.java +++ b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/config/StoredProcParserUtils.java @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.integration.jdbc.config; import java.sql.Types; @@ -35,16 +36,12 @@ import org.springframework.util.xml.DomUtils; import org.w3c.dom.Element; /** - * - * * @author Gunnar Hillert * @since 2.1 - * */ public final class StoredProcParserUtils { - private static final Log LOGGER = LogFactory - .getLog(StoredProcParserUtils.class); + private static final Log LOGGER = LogFactory.getLog(StoredProcParserUtils.class); /** Prevent instantiation. */ private StoredProcParserUtils() { @@ -52,10 +49,8 @@ public final class StoredProcParserUtils { } /** - * - * @param gatewayElement + * @param storedProcComponent * @param parserContext - * @return */ public static ManagedList getSqlParameterDefinitionBeanDefinitions( Element storedProcComponent, ParserContext parserContext) { @@ -110,10 +105,8 @@ public final class StoredProcParserUtils { } /** - * - * @param gatewayElement + * @param storedProcComponent * @param parserContext - * @return */ public static ManagedList getProcedureParameterBeanDefinitions( Element storedProcComponent, ParserContext parserContext) { @@ -169,10 +162,8 @@ public final class StoredProcParserUtils { } /** - * - * @param gatewayElement + * @param storedProcComponent * @param parserContext - * @return */ public static ManagedMap getReturningResultsetBeanDefinitions( Element storedProcComponent, ParserContext parserContext) { diff --git a/spring-integration-scripting/src/main/java/org/springframework/integration/scripting/ScriptExecutor.java b/spring-integration-scripting/src/main/java/org/springframework/integration/scripting/ScriptExecutor.java index 9530901b09..d0b3d8d55e 100644 --- a/spring-integration-scripting/src/main/java/org/springframework/integration/scripting/ScriptExecutor.java +++ b/spring-integration-scripting/src/main/java/org/springframework/integration/scripting/ScriptExecutor.java @@ -10,6 +10,7 @@ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. */ + package org.springframework.integration.scripting; import java.util.Map; @@ -23,18 +24,14 @@ import org.springframework.scripting.ScriptSource; public interface ScriptExecutor { /** - * * @param scriptSource - * @return */ public abstract Object executeScript(ScriptSource scriptSource); /** - * * @param scriptSource * @param variables -bind variable - * @return */ public abstract Object executeScript(ScriptSource scriptSource,Map variables); -} \ No newline at end of file +} diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/SftpOutboundGateway.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/SftpOutboundGateway.java index 52fcf2c38d..cdb3755be9 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/SftpOutboundGateway.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/SftpOutboundGateway.java @@ -38,7 +38,6 @@ public class SftpOutboundGateway extends AbstractRemoteFileOutboundGateway sessionFactory, String command, String expression) { diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpFileInfo.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpFileInfo.java index 801c9adf66..90a39ca63f 100644 --- a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpFileInfo.java +++ b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpFileInfo.java @@ -43,7 +43,6 @@ public class SftpFileInfo extends AbstractFileInfo { } /** - * @return * @see com.jcraft.jsch.SftpATTRS#isDir() */ public boolean isDirectory() { @@ -51,7 +50,6 @@ public class SftpFileInfo extends AbstractFileInfo { } /** - * @return * @see com.jcraft.jsch.SftpATTRS#isLink() */ public boolean isLink() { @@ -59,7 +57,6 @@ public class SftpFileInfo extends AbstractFileInfo { } /** - * @return * @see com.jcraft.jsch.SftpATTRS#getSize() */ public long getSize() { @@ -67,7 +64,6 @@ public class SftpFileInfo extends AbstractFileInfo { } /** - * @return * @see com.jcraft.jsch.SftpATTRS#getMTime() */ public long getModified() { @@ -75,7 +71,6 @@ public class SftpFileInfo extends AbstractFileInfo { } /** - * @return * @see com.jcraft.jsch.ChannelSftp.LsEntry#getFilename() */ public String getFilename() { diff --git a/spring-integration-test/src/main/java/org/springframework/integration/test/support/RequestResponseScenario.java b/spring-integration-test/src/main/java/org/springframework/integration/test/support/RequestResponseScenario.java index 23f50b0da1..128eb55e45 100644 --- a/spring-integration-test/src/main/java/org/springframework/integration/test/support/RequestResponseScenario.java +++ b/spring-integration-test/src/main/java/org/springframework/integration/test/support/RequestResponseScenario.java @@ -99,7 +99,7 @@ public class RequestResponseScenario { * Set the response validator * @see AbstractResponseValidator * @param responseValidator - * @return + * @return this */ public RequestResponseScenario setResponseValidator(AbstractResponseValidator responseValidator) { this.responseValidator = responseValidator; @@ -110,15 +110,15 @@ public class RequestResponseScenario { /** * Set the request message (as an alternative to setPayload()) * @param message - * @return + * @return this */ public RequestResponseScenario setMessage(Message message) { this.message = message; return this; } - - protected void init(){ + protected void init() { Assert.state(message == null || payload == null,"cannot set both message and payload"); } + } diff --git a/spring-integration-test/src/main/java/org/springframework/integration/test/support/SingleRequestResponseScenarioTest.java b/spring-integration-test/src/main/java/org/springframework/integration/test/support/SingleRequestResponseScenarioTest.java index 48670e45b0..83e895f5d9 100644 --- a/spring-integration-test/src/main/java/org/springframework/integration/test/support/SingleRequestResponseScenarioTest.java +++ b/spring-integration-test/src/main/java/org/springframework/integration/test/support/SingleRequestResponseScenarioTest.java @@ -10,22 +10,23 @@ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. */ + package org.springframework.integration.test.support; + import java.util.Collections; import java.util.List; /** - * Convenience class for a single {@link RequestResponsScenario} test + * Convenience class for a single {@link RequestResponseScenario} test * @author David Turanski - * */ - public abstract class SingleRequestResponseScenarioTest extends AbstractRequestResponseScenarioTest { @Override - protected List defineRequestResponseScenarios() { + protected List defineRequestResponseScenarios() { return Collections.singletonList(defineRequestResponseScenario()); } - protected abstract RequestResponseScenario defineRequestResponseScenario(); + protected abstract RequestResponseScenario defineRequestResponseScenario(); + } diff --git a/spring-integration-ws/src/main/java/org/springframework/integration/ws/DefaultSoapHeaderMapper.java b/spring-integration-ws/src/main/java/org/springframework/integration/ws/DefaultSoapHeaderMapper.java index f3f389c3e3..7e15f25d20 100644 --- a/spring-integration-ws/src/main/java/org/springframework/integration/ws/DefaultSoapHeaderMapper.java +++ b/spring-integration-ws/src/main/java/org/springframework/integration/ws/DefaultSoapHeaderMapper.java @@ -35,8 +35,8 @@ import org.springframework.xml.namespace.QNameUtils; /** * A {@link HeaderMapper} implementation for mapping to and from a SoapHeader. - * The {@link #inboundHeaderNames} and {@link #outboundHeaderNames} may be configured. - * They accept exact name Strings or simple patterns (e.g. "start*", "*end", or "*"). + * The {@link #setRequestHeaderNames(String[])} and {@link #setReplyHeaderNames(String[])} + * accept exact name Strings or simple patterns (e.g. "start*", "*end", or "*"). * By default all inbound headers will be accepted, but any outbound header that should * be mapped must be configured explicitly. Note that the outbound mapping only writes * String header values into attributes on the SoapHeader. For anything more advanced, diff --git a/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/support/XmppHeaderMapper.java b/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/support/XmppHeaderMapper.java index 3a24d63ac7..91c30e4874 100644 --- a/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/support/XmppHeaderMapper.java +++ b/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/support/XmppHeaderMapper.java @@ -23,7 +23,7 @@ import org.springframework.integration.mapping.RequestReplyHeaderMapper; /** * A convenience interface that extends {@link HeaderMapper} - * but parameterized with {@link MessageProperties}. + * but parameterized with the Smack API {@link Message}. * * @author Mark Fisher * @since 2.1