From 5dcf6d5931e84a73d52a8a666f83f107427358ac Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Thu, 29 Jul 2010 22:55:57 +0200 Subject: [PATCH] Eliminate javadoc warnings --- .../config/AbstractAmqpConfiguration.java | 9 ++++--- .../amqp/core/AmqpTemplate.java | 4 +-- .../MarshallingMessageConverter.java | 1 + .../converter/SimpleMessageConverter.java | 6 ++--- .../client/RabbitClientConfiguration.java | 4 +-- .../stocks/service/ExecutionVenueService.java | 7 ++--- .../rabbit/stocks/service/TradingService.java | 5 ++-- .../springframework/util/exec/Execute.java | 5 ++-- .../org/springframework/util/exec/Os.java | 2 +- .../rabbit/admin/RabbitBrokerOperations.java | 10 +++---- .../test/RabbitTestExecutionListener.java | 1 - .../config/AbstractRabbitConfiguration.java | 1 - .../amqp/rabbit/config/NamespaceUtils.java | 16 +++++------ .../connection/CachingConnectionFactory.java | 1 - .../connection/SingleConnectionFactory.java | 3 +-- .../rabbit/core/RabbitMessageProperties.java | 5 ++-- .../amqp/rabbit/core/RabbitTemplate.java | 2 +- .../AbstractMessageListenerContainer.java | 18 ++++++------- .../AbstractRabbitListeningContainer.java | 6 ++--- .../adapter/MessageListenerAdapter.java | 27 ++++++++++--------- .../amqp/rabbit/support/RabbitAccessor.java | 2 +- .../amqp/rabbit/support/RabbitUtils.java | 2 -- 22 files changed, 66 insertions(+), 71 deletions(-) diff --git a/spring-amqp-core/src/main/java/org/springframework/amqp/config/AbstractAmqpConfiguration.java b/spring-amqp-core/src/main/java/org/springframework/amqp/config/AbstractAmqpConfiguration.java index 3204aeda..8f2f2b3e 100644 --- a/spring-amqp-core/src/main/java/org/springframework/amqp/config/AbstractAmqpConfiguration.java +++ b/spring-amqp-core/src/main/java/org/springframework/amqp/config/AbstractAmqpConfiguration.java @@ -18,6 +18,7 @@ package org.springframework.amqp.config; import java.util.Collection; + import org.springframework.amqp.core.AmqpAdmin; import org.springframework.amqp.core.Binding; import org.springframework.amqp.core.DirectExchange; @@ -39,10 +40,10 @@ import org.springframework.context.annotation.Configuration; * * @author Mark Pollack * @author Mark Fisher - * @see AbstractExhange - * @see Queue - * @see Binding - * @see BindingBuilder + * @see org.springframework.amqp.core.AbstractExchange + * @see org.springframework.amqp.core.Binding + * @see org.springframework.amqp.core.Queue + * @see org.springframework.amqp.core.BindingBuilder */ @Configuration public abstract class AbstractAmqpConfiguration implements ApplicationContextAware, SmartLifecycle { diff --git a/spring-amqp-core/src/main/java/org/springframework/amqp/core/AmqpTemplate.java b/spring-amqp-core/src/main/java/org/springframework/amqp/core/AmqpTemplate.java index d285553b..6ee0b5c0 100644 --- a/spring-amqp-core/src/main/java/org/springframework/amqp/core/AmqpTemplate.java +++ b/spring-amqp-core/src/main/java/org/springframework/amqp/core/AmqpTemplate.java @@ -23,8 +23,8 @@ import org.springframework.amqp.AmqpException; * * Provides synchronous send an receive methods. The convertAndSend and receiveAndConvert * methods allow let you send and receive POJO objects. Implementations are expected to - * delegate to an instance of {@link org.springframework.support.converter.MessageConverter} to perform - * conversion to and from AMQP byte[] payload type. + * delegate to an instance of {@link org.springframework.amqp.support.converter.MessageConverter} + * to perform conversion to and from AMQP byte[] payload type. * * @author Mark Pollack * @author Mark Fisher diff --git a/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/MarshallingMessageConverter.java b/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/MarshallingMessageConverter.java index ecd96367..578f6820 100644 --- a/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/MarshallingMessageConverter.java +++ b/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/MarshallingMessageConverter.java @@ -17,6 +17,7 @@ package org.springframework.amqp.support.converter; import java.io.ByteArrayInputStream; + import java.io.ByteArrayOutputStream; import java.io.IOException; diff --git a/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/SimpleMessageConverter.java b/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/SimpleMessageConverter.java index e5926669..1f92a424 100644 --- a/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/SimpleMessageConverter.java +++ b/spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/SimpleMessageConverter.java @@ -25,9 +25,9 @@ import org.springframework.amqp.utils.SerializationUtils; /** * Implementation of {@link MessageConverter} that can work with Strings, Serializable instances, - * or byte arrays. The {@link #toMessage(Object)} method simply checks the type of the provided - * instance while the {@link #fromMessage(Message)} method relies upon the - * {@link DefaultMessageProperties#getContentType() content-type} of the provided Message. + * or byte arrays. The {@link #toMessage(Object, MessageProperties)} method simply checks the + * type of the provided instance while the {@link #fromMessage(Message)} method relies upon the + * {@link MessageProperties#getContentType() content-type} of the provided Message. * * @author Mark Fisher * @author Oleg Zhurakousky diff --git a/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/config/client/RabbitClientConfiguration.java b/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/config/client/RabbitClientConfiguration.java index 6186598f..0d73576f 100644 --- a/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/config/client/RabbitClientConfiguration.java +++ b/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/config/client/RabbitClientConfiguration.java @@ -19,7 +19,6 @@ package org.springframework.amqp.rabbit.stocks.config.client; import org.springframework.amqp.core.Binding; import org.springframework.amqp.core.BindingBuilder; - import org.springframework.amqp.core.Queue; import org.springframework.amqp.rabbit.core.RabbitTemplate; import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer; @@ -57,7 +56,7 @@ public class RabbitClientConfiguration extends AbstractStockAppRabbitConfigurati /** * The client's template will by default send to the exchange defined - * in {@link AbstractRabbitConfiguration.rabbitTemplate()} + * in {@link org.springframework.amqp.rabbit.config.AbstractRabbitConfiguration#rabbitTemplate()} * with the routing key {@link AbstractStockAppRabbitConfiguration#STOCK_REQUEST_QUEUE_NAME} *

* The default exchange will delivery to a queue whose name matches the routing key value. @@ -110,7 +109,6 @@ public class RabbitClientConfiguration extends AbstractStockAppRabbitConfigurati /** * Binds to the market data exchange. Interested in any stock quotes. - * @return */ @Bean public Binding marketDataBinding() { diff --git a/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/ExecutionVenueService.java b/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/ExecutionVenueService.java index 7896ca9d..51d4b81a 100644 --- a/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/ExecutionVenueService.java +++ b/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/ExecutionVenueService.java @@ -19,10 +19,11 @@ import org.springframework.amqp.rabbit.stocks.domain.TradeRequest; import org.springframework.amqp.rabbit.stocks.domain.TradeResponse; /** - * Executes the trade request, creating a Trade response. See the code flow in {@link ServerHandler} for - * its usage. - * @author Mark Pollack + * Executes the trade request, creating a Trade response. See the + * code flow in {@link org.springframework.amqp.rabbit.stocks.handler.ServerHandler} + * for its usage. * + * @author Mark Pollack */ public interface ExecutionVenueService { diff --git a/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/TradingService.java b/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/TradingService.java index e3889ad4..a3717467 100644 --- a/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/TradingService.java +++ b/spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/TradingService.java @@ -20,12 +20,13 @@ import org.springframework.amqp.rabbit.stocks.domain.TradeResponse; /** * Trading Service to process trade requests and response. This is the place to perform - * any trade processing after executions. See code flow in {@link ServerHandler}. + * any trade processing after executions. See code flow in + * {@link org.springframework.amqp.rabbit.stocks.handler.ServerHandler} * * @author Mark Pollack - * */ public interface TradingService { void processTrade(TradeRequest request, TradeResponse response); + } diff --git a/spring-erlang/src/main/java/org/springframework/util/exec/Execute.java b/spring-erlang/src/main/java/org/springframework/util/exec/Execute.java index cbcb1264..8ba47334 100644 --- a/spring-erlang/src/main/java/org/springframework/util/exec/Execute.java +++ b/spring-erlang/src/main/java/org/springframework/util/exec/Execute.java @@ -211,7 +211,7 @@ public class Execute { /** * Sets the environment variables for the subprocess to launch. * - * @param commandline array of Strings, each element of which has + * @param env array of Strings, each element of which has * an environment variable settings in format key=value */ public void setEnvironment(String[] env) { @@ -244,8 +244,7 @@ public class Execute { * Runs a process defined by the command line and returns its exit status. * * @return the exit status of the subprocess or INVALID - * @exception java.io.IOExcpetion The exception is thrown, if launching - * of the subprocess failed + * @throws Exception if launching of the subprocess failed */ public int execute() throws Exception { process = diff --git a/spring-erlang/src/main/java/org/springframework/util/exec/Os.java b/spring-erlang/src/main/java/org/springframework/util/exec/Os.java index 111d4abc..d5277266 100644 --- a/spring-erlang/src/main/java/org/springframework/util/exec/Os.java +++ b/spring-erlang/src/main/java/org/springframework/util/exec/Os.java @@ -37,7 +37,7 @@ public class Os { * Determines if the OS on which Ant is executing matches the * given OS family. * - * @param f The OS family type desired
+ * @param family The OS family type desired
* Possible values:
*