Spring/spring-amqp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Eliminate javadoc warnings

Browse Source
This commit is contained in:
Chris Beams
2010-07-29 22:55:57 +02:00
parent ef57164a1b
commit 5dcf6d5931
22 changed files with 66 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-amqp-core/src/main/java/org/springframework/amqp/config/AbstractAmqpConfiguration.java
View File

@@ -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 {

4
spring-amqp-core/src/main/java/org/springframework/amqp/core/AmqpTemplate.java
View File

@@ -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

1
spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/MarshallingMessageConverter.java
View File

@@ -17,6 +17,7 @@
package org.springframework.amqp.support.converter;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;

6
spring-amqp-core/src/main/java/org/springframework/amqp/support/converter/SimpleMessageConverter.java
View File

@@ -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

4
spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/config/client/RabbitClientConfiguration.java
View File

@@ -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}
* <p>
* 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() {

7
spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/ExecutionVenueService.java
View File

@@ -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 {

5
spring-amqp-samples/stocks/src/main/java/org/springframework/amqp/rabbit/stocks/service/TradingService.java
View File

@@ -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);
}

5
spring-erlang/src/main/java/org/springframework/util/exec/Execute.java
View File

@@ -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 <em>key=value</em>
*/
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 <code>INVALID</code>
* @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 =

2
spring-erlang/src/main/java/org/springframework/util/exec/Os.java
View File

@@ -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<br />
* @param family The OS family type desired<br />
* Possible values:<br />
* <ul><li>dos</li>
* <li>mac</li>

10
spring-rabbit-admin/src/main/java/org/springframework/amqp/rabbit/admin/RabbitBrokerOperations.java
View File

@@ -110,18 +110,18 @@ public interface RabbitBrokerOperations extends AmqpAdmin {
* Removes the node from any cluster it belongs to, removes all data from the management database,
* such as configured users and vhosts, and deletes all persistent messages.
* <p>
* For {@link resetNode} and {@link forceReset} to succeed the RabbitMQ application must have
* been stopped, e.g. {@link stopBroker}
* For {@link #resetNode} and {@link #forceResetNode} to succeed the RabbitMQ application must have
* been stopped, e.g. {@link #stopBrokerApplication}
*/
void resetNode();
/**
* The forceResetNode command differs from {@link resetNode()} in that it resets the node unconditionally,
* The forceResetNode command differs from {@link #resetNode} in that it resets the node unconditionally,
* regardless of the current management database state and cluster configuration. It should only be
* used as a last resort if the database or cluster configuration has been corrupted.
* <p>
* For {@link resetNode} and {@link forceReset} to succeed the RabbitMQ application must have
* been stopped, e.g. {@link stopBroker}
* For {@link #resetNode} and {@link #forceResetNode} to succeed the RabbitMQ application must have
* been stopped, e.g. {@link #stopBrokerApplication}
*/
void forceResetNode();

1
spring-rabbit-admin/src/main/java/org/springframework/amqp/rabbit/test/RabbitTestExecutionListener.java
View File

@@ -90,7 +90,6 @@ public class RabbitTestExecutionListener extends AbstractTestExecutionListener{
* {@link TransactionConfiguration} will be used instead.
* @param clazz the Class object corresponding to the test class for which
* the configuration attributes should be retrieved
* @return a new TransactionConfigurationAttributes instance
*/
private void initializeRabbitAdminTemplate(TestContext testContext) {

1
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/AbstractRabbitConfiguration.java
View File

@@ -40,7 +40,6 @@ public abstract class AbstractRabbitConfiguration extends AbstractAmqpConfigurat
* one may want to set after creating a RabbitTemplate from a ConnectionFactory, this
* abstact method is provided to allow for that flexibility as compared to
* automatically creating a RabbitTemplate by specifying a ConnectionFactory.
* @return
*/
@Bean
public abstract RabbitTemplate rabbitTemplate();

16
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/NamespaceUtils.java
View File

@@ -48,7 +48,7 @@ public abstract class NamespaceUtils {
* of the attribute whose name is provided if that attribute is
* defined in the given element.
*
* @param beanDefinition the bean definition to be configured
* @param builder the bean definition builder to be configured
* @param element the XML element where the attribute should be defined
* @param attributeName the name of the attribute whose value will be
* used to populate the property
@@ -73,9 +73,9 @@ public abstract class NamespaceUtils {
*
* @see Conventions#attributeNameToPropertyName(String)
*
* @param beanDefinition - the bean definition to be configured
* @param element - the XML element where the attribute should be defined
* @param attributeName - the name of the attribute whose value will be set
* @param builder the bean definition builder to be configured
* @param element the XML element where the attribute should be defined
* @param attributeName the name of the attribute whose value will be set
* on the property
*/
public static void setValueIfAttributeDefined(BeanDefinitionBuilder builder,
@@ -90,7 +90,7 @@ public abstract class NamespaceUtils {
* attribute whose name is provided if that attribute is defined in
* the given element.
*
* @param beanDefinition the bean definition to be configured
* @param builder the bean definition builder to be configured
* @param element the XML element where the attribute should be defined
* @param attributeName the name of the attribute whose value will be
* used as a bean reference to populate the property
@@ -115,9 +115,9 @@ public abstract class NamespaceUtils {
*
* @see Conventions#attributeNameToPropertyName(String)
*
* @param beanDefinition - the bean definition to be configured
* @param element - the XML element where the attribute should be defined
* @param attributeName - the name of the attribute whose value will be
* @param builder the bean definition builder to be configured
* @param element the XML element where the attribute should be defined
* @param attributeName the name of the attribute whose value will be
* used as a bean reference to populate the property
*
* @see Conventions#attributeNameToPropertyName(String)

1
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/CachingConnectionFactory.java
View File

@@ -79,7 +79,6 @@ public class CachingConnectionFactory extends SingleConnectionFactory implements
* Create a new CachingConnectionFactory for the given target
* ConnectionFactory.
* @param rabbitConnectionFactory the target ConnectionFactory
* @param hostName the host name to connect to
*/
public CachingConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory) {
super(rabbitConnectionFactory);

3
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/SingleConnectionFactory.java
View File

@@ -74,7 +74,7 @@ public class SingleConnectionFactory implements ConnectionFactory, DisposableBea
/**
* Create a new SingleConnectionFactory given a host name.
* @param hostName the host name to connect to
* @param hostname the host name to connect to
*/
public SingleConnectionFactory(String hostname) {
Assert.hasText(hostname, "hostname is required");
@@ -85,7 +85,6 @@ public class SingleConnectionFactory implements ConnectionFactory, DisposableBea
/**
* Create a new SingleConnectionFactory for the given target ConnectionFactory.
* @param rabbitConnectionFactory the target ConnectionFactory
* @param hostName the host name to connect to
*/
public SingleConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory) {
Assert.notNull(rabbitConnectionFactory, "Target ConnectionFactory must not be null");

5
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitMessageProperties.java
View File

@@ -30,12 +30,13 @@ import com.rabbitmq.client.AMQP.BasicProperties;
/**
* Rabbit implementation of MessageProperties that stores much of the message property
* information in Rabbit's {@link BasicProperites} class. Empty headers will be created on
* demand if they are null in the underlying BasicProperties instance.
* information in Rabbit's {@link BasicProperties} class. Empty headers will be created
* on demand if they are null in the underlying BasicProperties instance.
*
* @author Mark Pollack
* @author Mark Fisher
*/
public class RabbitMessageProperties implements MessageProperties {
private static final String DEFAULT_CHARSET = "UTF-8";

2
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitTemplate.java
View File

@@ -125,7 +125,7 @@ public class RabbitTemplate extends RabbitAccessor implements RabbitOperations {
*
* @see #convertAndSend
* @see #receiveAndConvert
* @see org.springframework.amqp.support.converter.rabbit.support.converter.SimpleMessageConverter
* @see org.springframework.amqp.support.converter.SimpleMessageConverter
*/
public void setMessageConverter(MessageConverter messageConverter) {
this.messageConverter = messageConverter;

18
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractMessageListenerContainer.java
View File

@@ -130,10 +130,11 @@ public abstract class AbstractMessageListenerContainer extends AbstractRabbitLis
* Check the given message listener, throwing an exception
* if it does not correspond to a supported listener type.
* <p>By default, only a Spring {@link MessageListener} object or a
* Spring {@link SessionAwareMessageListener} object will be accepted.
* Spring {@link org.springframework.jms.listener.SessionAwareMessageListener}
* object will be accepted.
* @param messageListener the message listener object to check
* @throws IllegalArgumentException if the supplied listener is not a
* {@link MessageListener} or a {@link SessionAwareMessageListener}
* MessageListener or SessionAwareMessageListener
* @see MessageListener
* @see ChannelAwareMessageListener
*/
@@ -266,11 +267,11 @@ public abstract class AbstractMessageListenerContainer extends AbstractRabbitLis
* exposing a new Rabbit Session (potentially with its own transaction)
* to the listener if demanded.
* @param listener the Spring ChannelAwareMessageListener to invoke
* @param session the Rabbit Channel to operate on
* @param channel the Rabbit Channel to operate on
* @param message the received Rabbit Message
* @throws Exception if thrown by Rabbit API methods
* @see ChannelAwareMessageListener
* @see #setExposeListenerSession
* @see #setExposeListenerChannel(boolean)
*/
protected void doInvokeListener(ChannelAwareMessageListener listener, Channel channel, Message message) throws Exception {
@@ -309,8 +310,7 @@ public abstract class AbstractMessageListenerContainer extends AbstractRabbitLis
* <code>onMessage</code> method.
* @param listener the Rabbit MessageListener to invoke
* @param message the received Rabbit Message
* @throws Exception if thrown by RAbbit API methods
* @see org.springframework.core.amq.MessageListener#onMessage
* @see org.springframework.amqp.core.MessageListener#onMessage
*/
protected void doInvokeListener(MessageListener listener, Message message) {
listener.onMessage(message);
@@ -322,7 +322,6 @@ public abstract class AbstractMessageListenerContainer extends AbstractRabbitLis
* Perform a commit or message acknowledgement, as appropriate.
* @param channel the Rabbit channel to commit
* @param message the Message to acknowledge
* @throws Exception in case of commit failure
*/
protected void commitIfNecessary(Channel channel, Message message) {
@@ -344,8 +343,7 @@ public abstract class AbstractMessageListenerContainer extends AbstractRabbitLis
/**
* Perform a rollback, if appropriate.
* @param session the Rabbit Channel to rollback
* @throws Exception in case of a rollback error
* @param channel the Rabbit Channel to roll back
*/
protected void rollbackIfNecessary(Channel channel) {
if (this.isChannelLocallyTransacted(channel)) {
@@ -356,7 +354,7 @@ public abstract class AbstractMessageListenerContainer extends AbstractRabbitLis
/**
* Perform a rollback, handling rollback exceptions properly.
* @param session the Rabbit Channel to rollback
* @param channel the Rabbit Channel to roll back
* @param ex the thrown application exception or error
* @throws Exception in case of a rollback error
*/

6
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractRabbitListeningContainer.java
View File

@@ -204,7 +204,7 @@ public abstract class AbstractRabbitListeningContainer extends RabbitAccessor im
/**
* Start the shared Connection, if any, and notify all invoker tasks.
* @throws Exception if thrown by Rabbit API methods
* @see #startSharedConnection
* @see #establishSharedConnection
*/
protected void doStart() throws Exception {
// Lazily establish a shared Connection, if necessary.
@@ -341,8 +341,8 @@ public abstract class AbstractRabbitListeningContainer extends RabbitAccessor im
}
/**
* Stop the shared Connection.
* @throws Exception if thrown by Rabbit API methods
* Stop the shared Connection, logging any exception thrown by
* Rabbit API methods.
*/
protected void stopSharedConnection() {
if (this.sharedConnection != null) {

27
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/adapter/MessageListenerAdapter.java
View File

@@ -123,7 +123,7 @@ import com.rabbitmq.client.Channel;
* @author Mark Fisher
* @see #setDelegate
* @see #setDefaultListenerMethod
* @see #setDefaultResponseDestination
* @see #setDefaultResponseExchange(String)
* @see #setMessageConverter
* @see org.springframework.amqp.support.converter.SimpleMessageConverter
* @see org.springframework.amqp.rabbit.core.ChannelAwareMessageListener
@@ -302,7 +302,8 @@ public class MessageListenerAdapter implements MessageListener, ChannelAwareMess
}
/**
* Spring {@link SessionAwareMessageListener} entry point.
* Spring {@link org.springframework.jms.listener.SessionAwareMessageListener}
* entry point.
* <p>Delegates the message to the target listener method, with appropriate
* conversion of the message argument. If the target method returns a
* non-null object, wrap in a Rabbit message and send it back.
@@ -365,8 +366,9 @@ public class MessageListenerAdapter implements MessageListener, ChannelAwareMess
* Handle the given exception that arose during listener execution.
* The default implementation logs the exception at error level.
* <p>This method only applies when using a Rabbit {@link MessageListener}.
* In case of the Spring {@link SessionAwareMessageListener} mechanism,
* exceptions get handled by the caller instead.
* In case of the Spring
* {@link org.springframework.jms.listener.SessionAwareMessageListener}
* mechanism, exceptions get handled by the caller instead.
* @param ex the exception to handle
* @see #onMessage(Message)
*/
@@ -475,7 +477,7 @@ public class MessageListenerAdapter implements MessageListener, ChannelAwareMess
* @throws Exception if thrown by Rabbit API methods
* @see #buildMessage
* @see #postProcessResponse
* @see #getResponseDestination
* @see #getResponseReplyTo(Message, Message, Channel)
* @see #sendResponse
*/
protected void handleResult(Object result, Message request, Channel channel) throws Exception {
@@ -545,17 +547,17 @@ public class MessageListenerAdapter implements MessageListener, ChannelAwareMess
* <p>The default implementation first checks the Rabbit Reply-To
* Queue of the supplied request; if that is not <code>null</code>
* it is returned; if it is <code>null</code>, then the configured
* {@link #resolveDefaultResponseQueue default response destination}
* is returned; if this too is <code>null</code>, then an
* {@link InvalidDestinationException} is thrown.
* default response destination is returned; if this too is
* <code>null</code>, then an {@link AmqpException} is thrown.
* @param request the original incoming Rabbit message
* @param response the outgoing Rabbit message about to be sent
* @param channel the Rabbit Channel to operate on
* @return the response destination (never <code>null</code>)
* @throws Exception if thrown by Rabbit API methods
* @throws InvalidDestinationException if no {@link Destination} can be determined
* @see #setDefaultResponseDestination
* @see org.springframework.amqp.core.Message.getMessageProperties().getReplyTo();
* @throws AmqpException if no {@link Destination} can be determined
* @see #setDefaultResponseExchange(String)
* @see org.springframework.amqp.core.Message#getMessageProperties()
* @see org.springframework.amqp.core.MessageProperties#getReplyTo()
*/
protected String getResponseReplyTo(Message request, Message response, Channel channel)
throws Exception {
@@ -579,7 +581,7 @@ public class MessageListenerAdapter implements MessageListener, ChannelAwareMess
* @param replyTo the Rabbit ReplyTo string to use when sending. Currently interpreted to be the routing key.
* @param message the Rabbit message to send
* @throws Exception if thrown by Rabbit API methods
* @see #postProcessProducer
* @see #postProcessResponse(Message, Message)
*/
protected void sendResponse(Channel channel, String receivedExchange, String replyTo, Message message) throws Exception {
@@ -607,7 +609,6 @@ public class MessageListenerAdapter implements MessageListener, ChannelAwareMess
/**
* Post-process the given message producer before using it to send the response.
* <p>The default implementation is empty.
* @param producer the Rabbit Channel that will be used to send the message
* @param response the outgoing Rabbit message about to be sent
* @throws Exception if thrown by Rabbit API methods
*/

2
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/support/RabbitAccessor.java
View File

@@ -82,7 +82,7 @@ public abstract class RabbitAccessor implements InitializingBean {
* and its host and port values.
* @return the new RabbitMQ Connection
* @throws IOException if thrown by RabbitMQ API methods
* @see ConnectionFactory#newConnection(String, int)
* @see ConnectionFactory#createConnection
*/
protected Connection createConnection() throws IOException {
return getConnectionFactory().createConnection();

2
spring-rabbit/src/main/java/org/springframework/amqp/rabbit/support/RabbitUtils.java
View File

@@ -89,8 +89,6 @@ public abstract class RabbitUtils {
/**
* Commit the Channel if not within a JTA transaction.
* @param channel the RabbitMQ Channel to commit
* @throws IOException
* @throws IOException if committing failed
*/
public static void commitIfNecessary(Channel channel) {
Assert.notNull(channel, "Channel must not be null");