8000 Fix Javadoc errors on JDK 8/Maven 3.3 · aashish13/rabbitmq-java-client@0cfdf17 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0cfdf17

Browse files
michaelklishinmichaelklishin
committed
Fix Javadoc errors on JDK 8/Maven 3.3
1 parent 2a4d2bd commit 0cfdf17

15 files changed

+55
-98
lines changed

‎src/main/java/com/rabbitmq/client/Channel.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -891,10 +891,11 @@ void basicNack(long deliveryTag, boolean multiple, boolean requeue)
891891
void basicCancel(String consumerTag) throws IOException;
892892

893893
/**
894-
* Ask the broker to resend unacknowledged messages. In 0-8
894+
* <p>
895+
* Ask the broker to resend unacknowledged messages. In 0-8
895896
* basic.recover is asynchronous; in 0-9-1 it is synchronous, and
896897
* the new, deprecated method basic.recover_async is asynchronous.
897-
* <p/>
898+
* </p>
898899
* Equivalent to calling <code>basicRecover(true)</code>, messages
899900
* will be requeued and possibly delivered to a different consumer.
900901
* @see #basicRecover(boolean)

‎src/main/java/com/rabbitmq/client/Consumer.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,16 @@
1818
import java.io.IOException;
1919

2020
/**
21-
* Interface for application callback objects to receive notifications and messages from
21+
* <p>Interface for application callback objects to receive notifications and messages from
2222
* a queue by subscription.
2323
* Most implementations will subclass {@link DefaultConsumer}.
24-
* <p/>
24+
* </p>
25+
* <p>
2526
* The methods of this interface are invoked in a dispatch
2627
* thread which is separate from the {@link Connection}'s thread. This
2728
* allows {@link Consumer}s to call {@link Channel} or {@link
2829
* Connection} methods without causing a deadlock.
29-
* <p/>
30+
* </p>
3031
* The {@link Consumer}s on a particular {@link Channel} are invoked serially on one or more
3132
* dispatch threads. {@link Consumer}s should avoid executing long-running code
3233
* because this will delay dispatch of messages to other {@link Consumer}s on the same

‎src/main/java/com/rabbitmq/client/LongString.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,24 @@ public interface LongString
3030
public static final long MAX_LENGTH = 0xffffffffL;
3131

3232
/**
33-
* @return the length of the {@link LongString} in bytes >= 0 <= MAX_LENGTH
33+
* @return the length of the string in bytes between 0 and MAX_LENGTH (inclusive)
3434
*/
3535
public long length();
3636

3737
/**
3838
* Get the content stream.
3939
* Repeated calls to this function return the same stream,
4040
* which may not support rewind.
41-
* @return An input stream that reads the content of the {@link LongString}
41+
* @return An input stream that reads the content of the string
4242
* @throws IOException if an error is encountered
4343
*/
4444
public DataInputStream getStream() throws IOException;
4545

4646
/**
4747
* Get the content as a byte array. This need not be a copy. Updates to the
48-
* returned array may change the value of the {@link LongString}.
48+
* returned array may change the value of the string.
4949
* Repeated calls to this function may return the same array.
50-
* This function will fail if <code><b>this</b>.length() > Integer.MAX_VALUE</code>,
50+
* This function will fail if this string's length is greater than {@link Integer#MAX_VALUE},
5151
* throwing an {@link IllegalStateException}.
5252
* @return the array of bytes containing the content of the {@link LongString}
5353
*/

‎src/main/java/com/rabbitmq/client/MapRpcServer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public static byte[] encode(Map<String, Object> reply)
7474
}
7575

7676
/**
77-
* Delegates to handleMapCall(Map<String, Object>).
77+
* Delegates to {@link MapRpcServer#handleMapCall(Map)}.
7878
*/
7979
public Map<String, Object> handleMapCall(Map<String, Object> request,
8080
AMQP.BasicProperties replyProperties)
@@ -83,7 +83,7 @@ public Map<String, Object> handleMapCall(Map<String, Object> request,
8383
}
8484

8585
/**
86-
* Default implementation - override in subclasses. Returns the empty string.
86+
* Default implementation override in subclasses. Returns the empty string.
8787
*/
8888
public Map<String, Object> handleMapCall(Map<String, Object> request)
8989
{
@@ -103,7 +103,7 @@ public void handleCast(byte[] requestBody)
103103
}
104104

105105
/**
106-
* Default implementation - override in subclasses. Does nothing.
106+
* Default implementation override in subclasses. Does nothing.
107107
*/
108108
public void handleMapCast(Map<String, Object> requestBody) {
109109
// Do nothing.

‎src/main/java/com/rabbitmq/client/QueueingConsumer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,8 @@
5555
*
5656
* <p>For a more complete example, see LogTail in the <code>test/src/com/rabbitmq/examples</code>
5757
* directory of the source distribution.</p>
58-
* <p/>
5958
*
60-
* <h4>Historical Perspective</h4>
59+
* <h3>Historical Perspective</h3>
6160
*
6261
* <p><code>QueueingConsumer</code> was introduced to allow
6362
* applications to overcome a limitation in the way <code>Connection</code>

‎src/main/java/com/rabbitmq/client/RpcClient.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,11 @@ public RpcClient(Channel channel, String exchange, String routingKey) throws IOE
125125

126126

127127
/**
128+
* <p>
128129
* Construct a new RpcClient that will communicate on the given channel, sending
129130
* requests to the given exchange with the given routing key.
130-
* <p/>
131+
* </p>
132+
*
131133
* Causes the creation of a temporary private autodelete queue. The name of this queue will be
132134
* "amq.rabbitmq.reply-to".
133135
* @param channel the channel to use for communication

‎src/main/java/com/rabbitmq/client/SaslMechanism.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ public interface SaslMechanism {
3434
* @param username name of user
3535
* @param password for username
3636
* @return response
37-
* @throws IOException
3837
*/
3938
LongString handleChallenge(LongString challenge, String username, String password);
4039
}

‎src/main/java/com/rabbitmq/client/impl/AMQCommand.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
import com.rabbitmq.client.Command;
2424

2525
/**
26-
* AMQ-specific implementation of {@link Command} which accumulates
26+
* AMQP 0-9-1-specific implementation of {@link Command} which accumulates
2727
* method, header and body from a series of frames, unless these are
2828
* supplied at construction time.
29-
* <p/><b>Concurrency</b><br/>
29+
* <h2>Concurrency</h2>
3030
* This class is thread-safe.
3131
*/
3232
public class AMQCommand implements Command {

‎src/main/java/com/rabbitmq/client/impl/Frame.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ else if(value == null) {
307307
return acc;
308308
}
309309

310-
/** Computes the AMQP wire-protocol length of an encoded field-array of type List<?> */
310+
/** Computes the AMQP 0-9-1 wire-protocol length of an encoded field-array of type List */
311311
public static long arraySize(List<?> values)
312312
throws UnsupportedEncodingException
313313
{

‎src/main/java/com/rabbitmq/client/impl/FrameHandler.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222

2323
/**
2424
* Interface to a frame handler.
25-
* <p/>
26-
* <b>Concurrency</b><br/>
25+
* <h2>Concurrency</h2>
2726
* Implementations must be thread-safe, and not allow frames to be interleaved, either while reading or writing.
2827
*/
2928

0 commit comments

Comments
 (0)
0