Permalink
Browse files

AMQP-361 Fix Javadocs for JDK8

  • Loading branch information...
1 parent cbfc7f1 commit 2fcea29bc40a56554f0f654cb031a197ced84759 @garyrussell garyrussell committed Jan 15, 2014
Showing with 383 additions and 114 deletions.
  1. +4 −4 spring-amqp/src/main/java/org/springframework/amqp/core/Address.java
  2. +4 −2 spring-amqp/src/main/java/org/springframework/amqp/core/AmqpAdmin.java
  3. +13 −1 spring-amqp/src/main/java/org/springframework/amqp/core/AmqpTemplate.java
  4. +4 −1 spring-amqp/src/main/java/org/springframework/amqp/core/ReceiveAndReplyCallback.java
  5. +3 −2 spring-amqp/src/main/java/org/springframework/amqp/core/UniquelyNamedQueue.java
  6. +8 −1 spring-amqp/src/main/java/org/springframework/amqp/remoting/client/AmqpClientInterceptor.java
  7. +6 −1 spring-amqp/src/main/java/org/springframework/amqp/remoting/service/AmqpInvokerServiceExporter.java
  8. +3 −1 ...g-amqp/src/main/java/org/springframework/amqp/support/converter/AbstractJsonMessageConverter.java
  9. +8 −1 ...ng-amqp/src/main/java/org/springframework/amqp/support/converter/MarshallingMessageConverter.java
  10. +2 −1 spring-amqp/src/main/java/org/springframework/amqp/support/converter/MessageConverter.java
  11. +2 −0 spring-amqp/src/main/java/org/springframework/amqp/support/converter/SerializerMessageConverter.java
  12. +4 −0 spring-amqp/src/main/java/org/springframework/amqp/support/converter/SimpleMessageConverter.java
  13. +4 −1 spring-erlang/src/main/java/org/springframework/erlang/connection/ConnectionFactoryUtils.java
  14. +10 −4 spring-erlang/src/main/java/org/springframework/erlang/connection/SingleConnectionFactory.java
  15. +4 −2 spring-erlang/src/main/java/org/springframework/erlang/core/ConnectionCallback.java
  16. +8 −2 spring-erlang/src/main/java/org/springframework/util/exec/Background.java
  17. +5 −2 spring-erlang/src/main/java/org/springframework/util/exec/Escape.java
  18. +7 −3 spring-erlang/src/main/java/org/springframework/util/exec/Execute.java
  19. +8 −3 spring-erlang/src/main/java/org/springframework/util/exec/ExecuteStreamHandler.java
  20. +9 −6 spring-erlang/src/main/java/org/springframework/util/exec/ExecuteWatchdog.java
  21. +11 −3 spring-erlang/src/main/java/org/springframework/util/exec/Os.java
  22. +17 −8 spring-erlang/src/main/java/org/springframework/util/exec/PumpStreamHandler.java
  23. +21 −1 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/config/NamespaceUtils.java
  24. +11 −0 ...it/src/main/java/org/springframework/amqp/rabbit/connection/AbstractRoutingConnectionFactory.java
  25. +1 −1 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/CachingConnectionFactory.java
  26. +6 −4 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/ConnectionFactoryUtils.java
  27. +8 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/ConsumerChannelRegistry.java
  28. +6 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/RabbitAccessor.java
  29. +6 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/RabbitResourceHolder.java
  30. +2 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/connection/RabbitUtils.java
  31. +2 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/ChannelAwareMessageListener.java
  32. +3 −1 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/ChannelCallback.java
  33. +1 −1 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitAdmin.java
  34. +46 −5 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/RabbitTemplate.java
  35. +9 −5 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/core/support/RabbitGatewaySupport.java
  36. +37 −13 ...bbit/src/main/java/org/springframework/amqp/rabbit/listener/AbstractMessageListenerContainer.java
  37. +31 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/listener/BlockingQueueConsumer.java
  38. +14 −7 ...rabbit/src/main/java/org/springframework/amqp/rabbit/listener/SimpleMessageListenerContainer.java
  39. +20 −4 ...rabbit/src/main/java/org/springframework/amqp/rabbit/listener/adapter/MessageListenerAdapter.java
  40. +3 −6 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/log4j/AmqpAppender.java
  41. +3 −3 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/support/PendingConfirm.java
  42. +9 −2 spring-rabbit/src/main/java/org/springframework/amqp/rabbit/support/PublisherCallbackChannel.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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
@@ -82,9 +82,9 @@ public Address(String address) {
* Create an Address given the exchange type, exchange name and routing key. This will set the exchange type, name
* and the routing key explicitly.
*
- * @param exchangeType
- * @param exchangeName
- * @param routingKey
+ * @param exchangeType The exchange type.
+ * @param exchangeName The exchange name.
+ * @param routingKey The routing key.
*/
public Address(String exchangeType, String exchangeName, String routingKey) {
this.exchangeType = exchangeType;
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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
@@ -17,7 +17,7 @@
/**
- * Specifies a basic set of portable AMQP administrative operations for AMQP > 0.8
+ * Specifies a basic set of portable AMQP administrative operations for AMQP > 0.8
*
* @author Mark Pollack
* @author Dave Syer
@@ -44,6 +44,8 @@
/**
* Declare a queue whose name is automatically named. It is created with exclusive = true, autoDelete=true, and
* durable = false.
+ *
+ * @return The queue.
*/
Queue declareQueue();
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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
@@ -170,6 +170,8 @@ void convertAndSend(String exchange, String routingKey, Object message, MessageP
*
* @param callback a user-provided {@link ReceiveAndReplyCallback} implementation to process received message
* and return a reply message.
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
* @return {@code true}, if message was received
* @throws AmqpException if there is a problem
*/
@@ -185,6 +187,8 @@ void convertAndSend(String exchange, String routingKey, Object message, MessageP
* @param queueName the queue name to receive a message.
* @param callback a user-provided {@link ReceiveAndReplyCallback} implementation to process received message
* and return a reply message.
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
* @return {@code true}, if message was received.
* @throws AmqpException if there is a problem.
*/
@@ -199,6 +203,8 @@ void convertAndSend(String exchange, String routingKey, Object message, MessageP
* and return a reply message.
* @param replyExchange the exchange name to send reply message.
* @param replyRoutingKey the routing key to send reply message.
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
* @return {@code true}, if message was received.
* @throws AmqpException if there is a problem.
*/
@@ -216,6 +222,8 @@ void convertAndSend(String exchange, String routingKey, Object message, MessageP
* and return a reply message.
* @param replyExchange the exchange name to send reply message.
* @param replyRoutingKey the routing key to send reply message.
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
* @return {@code true}, if message was received
* @throws AmqpException if there is a problem
*/
@@ -231,6 +239,8 @@ void convertAndSend(String exchange, String routingKey, Object message, MessageP
* @param callback a user-provided {@link ReceiveAndReplyCallback} implementation to process received message
* and return a reply message.
* @param replyToAddressCallback the callback to determine replyTo address at runtime.
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
* @return {@code true}, if message was received.
* @throws AmqpException if there is a problem.
*/
@@ -247,6 +257,8 @@ void convertAndSend(String exchange, String routingKey, Object message, MessageP
* @param callback a user-provided {@link ReceiveAndReplyCallback} implementation to process received message
* and return a reply message.
* @param replyToAddressCallback the callback to determine replyTo address at runtime.
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
* @return {@code true}, if message was received
* @throws AmqpException if there is a problem
*/
@@ -1,5 +1,5 @@
/*
- * Copyright 2013 the original author or authors.
+ * Copyright 2014 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
@@ -18,6 +18,9 @@
* as processor for inbound object and producer for outbound object.
*
* <p>This often as an anonymous class within a method implementation.
+
+ * @param <R> The type of the request after conversion from the {@link Message}.
+ * @param <S> The type of the response.
*
* @author Artem Bilan
* @since 1.3
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,8 @@ public UniquelyNamedQueue() {
/**
* Create a uniquely named queue with a fixed prefix. The constructor argument specifies
* the prefix which is prepended to a random UUID.
- * @param prefix
+ *
+ * @param prefix The prefix.
*/
public UniquelyNamedQueue(String prefix) {
super(prefix + "-" + UUID.randomUUID());
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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
@@ -15,6 +15,7 @@
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
+
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.amqp.remoting.service.AmqpInvokerServiceExporter;
import org.springframework.remoting.RemoteProxyFailureException;
@@ -77,6 +78,8 @@ public AmqpTemplate getAmqpTemplate() {
* sending messages as described <a href=
* "http://static.springsource.org/spring-amqp/reference/html/amqp.html#request-reply" >in the Spring-AMQP
* documentation</a>.
+ *
+ * @param amqpTemplate The amqp template.
*/
public void setAmqpTemplate(AmqpTemplate amqpTemplate) {
this.amqpTemplate = amqpTemplate;
@@ -91,6 +94,8 @@ public String getRoutingKey() {
* broker. If not set, the {@link AmqpTemplate}'s default routing key will be used.
* <p>
* This property is useful if you want to use the same AmqpTemplate to talk to multiple services.
+ *
+ * @param routingKey The routing key.
*/
public void setRoutingKey(String routingKey) {
this.routingKey = routingKey;
@@ -104,6 +109,8 @@ public RemoteInvocationFactory getRemoteInvocationFactory() {
* Set the RemoteInvocationFactory to use for this accessor. Default is a {@link DefaultRemoteInvocationFactory}.
* <p>
* A custom invocation factory can add further context information to the invocation, for example user credentials.
+ *
+ * @param remoteInvocationFactory The remote invocation factory.
*/
public void setRemoteInvocationFactory(RemoteInvocationFactory remoteInvocationFactory) {
this.remoteInvocationFactory = remoteInvocationFactory;
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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
@@ -92,6 +92,9 @@ public AmqpTemplate getAmqpTemplate() {
* of those the respective parameters from the original message's <code>returnAddress</code> are being used.
* <p>
* Also, the template's {@link MessageConverter} is not used for the reply.
+ *
+ * @param amqpTemplate The amqp template.
+ *
* @see #setMessageConverter(MessageConverter)
*/
public void setAmqpTemplate(AmqpTemplate amqpTemplate) {
@@ -111,6 +114,8 @@ public MessageConverter getMessageConverter() {
* <p>
* Note that this class never uses the message converter of the underlying {@link AmqpTemplate}!
*
+ * @param messageConverter The message converter.
+ *
* @see org.springframework.amqp.support.converter.SimpleMessageConverter
*/
public void setMessageConverter(MessageConverter messageConverter) {
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors. Licensed under the Apache License, Version 2.0 (the "License");
+ * Copyright 2002-2014 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
* http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
@@ -36,6 +36,8 @@ public void setClassMapper(ClassMapper classMapper) {
/**
* Specify the default charset to use when converting to or from text-based
* Message body content. If not specified, the charset will be "UTF-8".
+ *
+ * @param defaultCharset The default charset.
*/
public void setDefaultCharset(String defaultCharset) {
this.defaultCharset = (defaultCharset != null) ? defaultCharset
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -98,13 +98,17 @@ public MarshallingMessageConverter(Marshaller marshaller, Unmarshaller unmarshal
/**
* Set the contentType to be used by this message converter.
+ *
+ * @param contentType The content type.
*/
public void setContentType(String contentType) {
this.contentType = contentType;
}
/**
* Set the {@link Marshaller} to be used by this message converter.
+ *
+ * @param marshaller The marshaller.
*/
public void setMarshaller(Marshaller marshaller) {
Assert.notNull(marshaller, "marshaller must not be null");
@@ -113,12 +117,15 @@ public void setMarshaller(Marshaller marshaller) {
/**
* Set the {@link Unmarshaller} to be used by this message converter.
+ *
+ * @param unmarshaller The unmarshaller.
*/
public void setUnmarshaller(Unmarshaller unmarshaller) {
Assert.notNull(unmarshaller, "unmarshaller must not be null");
this.unmarshaller = unmarshaller;
}
+ @Override
public void afterPropertiesSet() {
Assert.notNull(this.marshaller, "Property 'marshaller' is required");
Assert.notNull(this.unmarshaller, "Property 'unmarshaller' is required");
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,7 @@
/**
* Convert a Java object to a Message.
* @param object the object to convert
+ * @param messageProperties The message properties.
* @return the Message
* @throws MessageConversionException in case of conversion failure
*/
@@ -58,6 +58,8 @@ public void setIgnoreContentType(boolean ignoreContentType) {
/**
* Specify the default charset to use when converting to or from text-based Message body content. If not specified,
* the charset will be "UTF-8".
+ *
+ * @param defaultCharset The default charset.
*/
public void setDefaultCharset(String defaultCharset) {
this.defaultCharset = (defaultCharset != null) ? defaultCharset : DEFAULT_CHARSET;
@@ -60,6 +60,8 @@ public void setBeanClassLoader(ClassLoader beanClassLoader) {
* <p>
* Follows RMI's codebase conventions for dynamic class download.
*
+ * @param codebaseUrl The codebase URL.
+ *
* @see org.springframework.remoting.rmi.CodebaseAwareObjectInputStream
* @see java.rmi.server.RMIClassLoader
*/
@@ -70,6 +72,8 @@ public void setCodebaseUrl(String codebaseUrl) {
/**
* Specify the default charset to use when converting to or from text-based
* Message body content. If not specified, the charset will be "UTF-8".
+ *
+ * @param defaultCharset The default charset.
*/
public void setDefaultCharset(String defaultCharset) {
this.defaultCharset = (defaultCharset != null) ? defaultCharset : DEFAULT_CHARSET;
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,6 +30,9 @@
/**
* Release the given Connection by closing it.
+ *
+ * @param con The connection.
+ * @param cf The connection factory.
*/
public static void releaseConnection(Connection con, ConnectionFactory cf) {
if (con == null) {
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,7 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.erlang.OtpIOException;
@@ -86,11 +87,11 @@
private boolean uniqueSelfNodeName = true;
- private String selfNodeName;
+ private final String selfNodeName;
private String cookie;
- private String peerNodeName;
+ private final String peerNodeName;
private OtpSelf otpSelf;
@@ -125,6 +126,7 @@ public void setUniqueSelfNodeName(boolean uniqueSelfNodeName) {
this.uniqueSelfNodeName = uniqueSelfNodeName;
}
+ @Override
public Connection createConnection() throws UnknownHostException,
OtpAuthException {
synchronized (this.connectionMonitor) {
@@ -163,6 +165,7 @@ public void initConnection() throws IOException, OtpAuthException {
* <p>As this bean implements DisposableBean, a bean factory will
* automatically invoke this on destruction of its cached singletons.
*/
+ @Override
public void destroy() {
resetConnection();
}
@@ -204,7 +207,8 @@ protected void closeConnection(Connection connection) {
* Create a JInterface Connection via this class's ConnectionFactory.
*
* @return the new Otp Connection
- * @throws OtpAuthException
+ * @throws OtpAuthException Any.
+ * @throws IOException Any.
*/
protected Connection doCreateConnection() throws IOException,
OtpAuthException {
@@ -239,6 +243,7 @@ protected Connection getSharedConnectionProxy(Connection target) {
* @see
* org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
*/
+ @Override
public void afterPropertiesSet() {
Assert.isTrue(this.selfNodeName != null || this.peerNodeName != null,
"'selfNodeName' or 'peerNodeName' is required");
@@ -268,6 +273,7 @@ public SharedConnectionInvocationHandler(Connection target) {
this.target = target;
}
+ @Override
public Object invoke(Object proxy, Method method, Object[] args)
throws Throwable {
if (method.getName().equals("equals")) {
Oops, something went wrong.

0 comments on commit 2fcea29

Please sign in to comment.