This is an automated email from the ASF dual-hosted git repository.
tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git
The following commit(s) were added to refs/heads/main by this push:
new 624d9d1 Fix issues in the Javadocs that cause errors or warnings
during build
624d9d1 is described below
commit 624d9d1101ff9175950589de43df587386e107ab
Author: Timothy Bish <tabish...@gmail.com>
AuthorDate: Wed Apr 21 14:43:23 2021 -0400
Fix issues in the Javadocs that cause errors or warnings during build
Updates some out-dated references and remove param docs for now removed
values that were missed previously.
---
.../qpid/protonj2/client/ConnectionOptions.java | 10 +++++-----
.../qpid/protonj2/client/StreamSenderMessage.java | 13 +++++++------
.../apache/qpid/protonj2/client/TargetOptions.java | 6 ++++++
.../exceptions/ClientLinkRedirectedException.java | 1 +
.../protonj2/client/impl/ClientErrorCondition.java | 2 +-
.../protonj2/client/impl/StreamSenderTest.java | 3 ---
.../EncodedCompositingDataSectionMatcher.java | 10 ++++------
.../driver/matchers/types/EncodedDataMatcher.java | 13 +++++--------
.../types/EncodedPartialDataSectionMatcher.java | 22 ++++++++--------------
.../protonj2/test/driver/netty/SslSupport.java | 6 ------
.../apache/qpid/protonj2/engine/EngineHandler.java | 14 +++++++-------
.../qpid/protonj2/engine/OutgoingAMQPEnvelope.java | 2 +-
.../qpid/protonj2/engine/OutgoingDelivery.java | 3 +--
.../apache/qpid/protonj2/engine/Transaction.java | 4 ++--
.../protonj2/engine/sasl/SaslClientListener.java | 8 ++++----
.../protonj2/engine/sasl/SaslServerListener.java | 8 ++++----
.../apache/qpid/protonj2/engine/util/SplayMap.java | 6 +++---
.../protonj2/codec/legacy/LegacyCodecAdapter.java | 2 +-
.../qpid/protonj2/types/transport/AttachTest.java | 4 ++--
19 files changed, 62 insertions(+), 75 deletions(-)
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
index 374de8d..d444894 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
@@ -558,9 +558,9 @@ public class ConnectionOptions {
*
* @return this {@link ConnectionOptions} instance.
*
- * @see #connectionInterrupted
- * @see #connectionRestored
- * @see #connectionFailed
+ * @see #interruptedHandler
+ * @see #connectedHandler
+ * @see #disconnectedHandler
*/
public ConnectionOptions disconnectedHandler(BiConsumer<Connection,
DisconnectionEvent> disconnectedHandler) {
this.disconnectedHandler = disconnectedHandler;
@@ -615,7 +615,7 @@ public class ConnectionOptions {
*
* @see #connectedhedHandler
* @see #reconnectedHandler
- * @see #failedHandler
+ * @see #disconnectedHandler
*/
public ConnectionOptions interruptedHandler(BiConsumer<Connection,
DisconnectionEvent> interruptedHandler) {
this.interruptedHandler = interruptedHandler;
@@ -641,7 +641,7 @@ public class ConnectionOptions {
*
* @see #connectedhedHandler
* @see #interruptedHandler
- * @see #failedHandler
+ * @see #disconnectedHandler
*/
public ConnectionOptions reconnectedHandler(BiConsumer<Connection,
ConnectionEvent> reconnectedHandler) {
this.reconnectedHandler = reconnectedHandler;
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
index c0d7fc1..8cfbed3 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/StreamSenderMessage.java
@@ -61,7 +61,7 @@ public interface StreamSenderMessage extends
AdvancedMessage<OutputStream> {
/**
* Marks the currently streaming message as being complete.
* <p>
- * Marking a message as complete finalizes the {@link SendContext} and
causes a
+ * Marking a message as complete finalizes the streaming send operation
and causes a
* final {@link Transfer} frame to be sent to the remote indicating that
the ongoing
* streaming delivery is done and no more message data will arrive.
*
@@ -90,7 +90,7 @@ public interface StreamSenderMessage extends
AdvancedMessage<OutputStream> {
StreamSenderMessage abort() throws ClientException;
/**
- * @return true if this {@link SendContext} has been marked as aborted
previously.
+ * @return true if this {@link StreamSenderMessage} has been marked as
aborted previously.
*/
boolean aborted();
@@ -104,16 +104,16 @@ public interface StreamSenderMessage extends
AdvancedMessage<OutputStream> {
* based component. The {@link Data} section based stream allows for
control over the AMQP
* message {@link Section} values that are sent but does the encoding
itself. For stream
* of message data where the content source already consists of an AMQP
encoded message refer
- * to the {@link #rawOutputStream(OutputStreamOptions)} method.
+ * to the {@link #rawOutputStream} method.
*
* @param options
- * The stream options to use to configure the returned {@link
MessageOutputStream}
+ * The stream options to use to configure the returned {@link
OutputStream}
*
* @return a {@link OutputStream} instance configured using the given
options.
*
* @throws ClientException if an error occurs while creating the {@link
OutputStream}.
*
- * @see #rawOutputStream(OutputStreamOptions)
+ * @see #rawOutputStream
*/
OutputStream body(OutputStreamOptions options) throws ClientException;
@@ -133,7 +133,8 @@ public interface StreamSenderMessage extends
AdvancedMessage<OutputStream> {
*
* @throws ClientException if an error occurs while creating the {@link
OutputStream}.
*
- * @see #dataOutputStream(OutputStreamOptions)
+ * @see #body
+ * @see #body(OutputStreamOptions)
*/
OutputStream rawOutputStream() throws ClientException;
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TargetOptions.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TargetOptions.java
index f5c6b55..7ab40f7 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TargetOptions.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TargetOptions.java
@@ -21,6 +21,12 @@ package org.apache.qpid.protonj2.client;
*/
public final class TargetOptions extends TerminusOptions<TargetOptions> {
+ /**
+ * @param other
+ * The instance which should receive the configuration
from this options instance.
+ *
+ * @return the given {@link TargetOptions} instance with all configuration
copied from this instance.
+ */
public TargetOptions copyInto(TargetOptions other) {
super.copyInto(other);
return this;
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
index 1c9bb4c..5c49fc6 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
@@ -22,6 +22,7 @@ import org.apache.qpid.protonj2.client.Connection;
import org.apache.qpid.protonj2.client.ConnectionOptions;
import org.apache.qpid.protonj2.client.ErrorCondition;
import org.apache.qpid.protonj2.client.Receiver;
+import org.apache.qpid.protonj2.client.Sender;
import org.apache.qpid.protonj2.client.impl.ClientRedirect;
import org.apache.qpid.protonj2.types.transport.Open;
diff --git
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
index 1b9915e..24ad8d9 100644
---
a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
+++
b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
@@ -25,7 +25,7 @@ import org.apache.qpid.protonj2.types.Symbol;
/**
* Client implementation of the {@link ErrorCondition} type that wraps a
- * Proton specific AMQP {@link
org.apache.qpid.protonj2.amqp.transport.ErrorCondition}.
+ * Proton specific AMQP {@link
org.apache.qpid.protonj2.types.transport.ErrorCondition}.
*/
public final class ClientErrorCondition implements ErrorCondition {
diff --git
a/protonj2-client/src/test/java/org/apache/qpid/protonj2/client/impl/StreamSenderTest.java
b/protonj2-client/src/test/java/org/apache/qpid/protonj2/client/impl/StreamSenderTest.java
index b3738da..7125a28 100644
---
a/protonj2-client/src/test/java/org/apache/qpid/protonj2/client/impl/StreamSenderTest.java
+++
b/protonj2-client/src/test/java/org/apache/qpid/protonj2/client/impl/StreamSenderTest.java
@@ -85,9 +85,6 @@ import org.junit.jupiter.api.Timeout;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Tests the {@link message} implementation
- */
@Timeout(20)
public class StreamSenderTest extends ImperativeClientTestCase {
diff --git
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedCompositingDataSectionMatcher.java
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedCompositingDataSectionMatcher.java
index d7862d8..1377349 100644
---
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedCompositingDataSectionMatcher.java
+++
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedCompositingDataSectionMatcher.java
@@ -21,6 +21,7 @@ package org.apache.qpid.protonj2.test.driver.matchers.types;
import java.util.Objects;
import org.apache.qpid.protonj2.test.driver.codec.EncodingCodes;
+import org.apache.qpid.protonj2.test.driver.codec.messaging.Data;
import org.apache.qpid.protonj2.test.driver.codec.primitives.Binary;
import org.apache.qpid.protonj2.test.driver.codec.primitives.Symbol;
import org.apache.qpid.protonj2.test.driver.codec.primitives.UnsignedLong;
@@ -54,8 +55,7 @@ public class EncodedCompositingDataSectionMatcher extends
TypeSafeMatcher<ByteBu
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedCompositingDataSectionMatcher(byte[] expectedValue) {
this(Unpooled.wrappedBuffer(expectedValue));
@@ -63,8 +63,7 @@ public class EncodedCompositingDataSectionMatcher extends
TypeSafeMatcher<ByteBu
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedCompositingDataSectionMatcher(Binary expectedValue) {
this(Unpooled.wrappedBuffer(expectedValue.asByteBuffer()));
@@ -72,8 +71,7 @@ public class EncodedCompositingDataSectionMatcher extends
TypeSafeMatcher<ByteBu
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedCompositingDataSectionMatcher(ByteBuf expectedValue) {
Objects.requireNonNull(expectedValue, "The expected value cannot be
null for this matcher");
diff --git
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedDataMatcher.java
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedDataMatcher.java
index 77ea14e..0a4861f 100644
---
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedDataMatcher.java
+++
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedDataMatcher.java
@@ -19,6 +19,7 @@
package org.apache.qpid.protonj2.test.driver.matchers.types;
import org.apache.qpid.protonj2.test.driver.codec.messaging.AmqpValue;
+import org.apache.qpid.protonj2.test.driver.codec.messaging.Data;
import org.apache.qpid.protonj2.test.driver.codec.primitives.Binary;
import org.apache.qpid.protonj2.test.driver.codec.primitives.Symbol;
import org.apache.qpid.protonj2.test.driver.codec.primitives.UnsignedLong;
@@ -31,8 +32,7 @@ public class EncodedDataMatcher extends
EncodedAmqpTypeMatcher {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedDataMatcher(byte[] expectedValue) {
this(new Binary(expectedValue), false);
@@ -40,8 +40,7 @@ public class EncodedDataMatcher extends
EncodedAmqpTypeMatcher {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedDataMatcher(Binary expectedValue) {
this(expectedValue, false);
@@ -49,8 +48,7 @@ public class EncodedDataMatcher extends
EncodedAmqpTypeMatcher {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
* @param permitTrailingBytes
* if it is permitted for bytes to be left in the Binary after
* consuming the {@link AmqpValue}
@@ -61,8 +59,7 @@ public class EncodedDataMatcher extends
EncodedAmqpTypeMatcher {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
* @param permitTrailingBytes
* if it is permitted for bytes to be left in the Binary after
* consuming the {@link AmqpValue}
diff --git
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedPartialDataSectionMatcher.java
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedPartialDataSectionMatcher.java
index a94e364..e06e24a 100644
---
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedPartialDataSectionMatcher.java
+++
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/matchers/types/EncodedPartialDataSectionMatcher.java
@@ -19,6 +19,7 @@
package org.apache.qpid.protonj2.test.driver.matchers.types;
import org.apache.qpid.protonj2.test.driver.codec.EncodingCodes;
+import org.apache.qpid.protonj2.test.driver.codec.messaging.Data;
import org.apache.qpid.protonj2.test.driver.codec.primitives.Binary;
import org.apache.qpid.protonj2.test.driver.codec.primitives.Symbol;
import org.apache.qpid.protonj2.test.driver.codec.primitives.UnsignedLong;
@@ -45,8 +46,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
* the actual encoded size the Data section binary should eventually
* receive once all split frame transfers have arrived.
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedPartialDataSectionMatcher(int expectedEncodedSize, byte[]
expectedValue) {
this(expectedEncodedSize, Unpooled.wrappedBuffer(expectedValue), true);
@@ -57,8 +57,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
* the actual encoded size the Data section binary should eventually
* receive once all split frame transfers have arrived.
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedPartialDataSectionMatcher(int expectedEncodedSize, Binary
expectedValue) {
this(expectedEncodedSize,
Unpooled.wrappedBuffer(expectedValue.asByteBuffer()), true);
@@ -69,8 +68,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
* the actual encoded size the Data section binary should eventually
* receive once all split frame transfers have arrived.
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedPartialDataSectionMatcher(int expectedEncodedSize, ByteBuf
expectedValue) {
this(expectedEncodedSize, expectedValue, true);
@@ -78,8 +76,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedPartialDataSectionMatcher(byte[] expectedValue) {
this(-1, Unpooled.wrappedBuffer(expectedValue), false);
@@ -87,8 +84,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedPartialDataSectionMatcher(Binary expectedValue) {
this(-1, Unpooled.wrappedBuffer(expectedValue.asByteBuffer()), false);
@@ -96,8 +92,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
/**
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
*/
public EncodedPartialDataSectionMatcher(ByteBuf expectedValue) {
this(-1, expectedValue, false);
@@ -108,8 +103,7 @@ public class EncodedPartialDataSectionMatcher extends
TypeSafeMatcher<ByteBuf> {
* the actual encoded size the Data section binary should eventually
* receive once all split frame transfers have arrived.
* @param expectedValue
- * the value that is expected to be IN the received
- * {@link org.apache.qpid.proton.amqp.messaging.Data}
+ * the value that is expected to be IN the received {@link Data}
* @param expectDataSectionPreamble
* should the matcher check for the Data and Binary section encoding
* meta-data or only match the payload to the given expected value.
diff --git
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/netty/SslSupport.java
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/netty/SslSupport.java
index e0b3c49..b163f84 100644
---
a/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/netty/SslSupport.java
+++
b/protonj2-test-driver/src/main/java/org/apache/qpid/protonj2/test/driver/netty/SslSupport.java
@@ -59,8 +59,6 @@ public class SslSupport {
* when creating the handler. If they do not, an SSLContext will first be
created
* using the other option values.
*
- * @param allocator
- * The Netty Buffer Allocator to use when Netty resources need
to be created.
* @param remote
* The URI of the remote peer that the SslHandler will be used
against.
* @param options
@@ -91,8 +89,6 @@ public class SslSupport {
* when creating the handler. If they do not, an SSLContext will first be
created
* using the other option values.
*
- * @param allocator
- * The Netty Buffer Allocator to use when Netty resources need to
be created.
* @param remote
* The URI of the remote peer that the SslHandler will be used
against.
* @param options
@@ -183,8 +179,6 @@ public class SslSupport {
* the URI of the remote peer that will be used to initialize the
engine, may be null if none should.
* @param context
* the SSLContext to use when creating the engine.
- * @param client
- * indicates if the context is meant for use with a client or sever
* @param options
* the TransportOptions to use to configure the new SSLEngine.
*
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandler.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandler.java
index 0c12a3f..c797a50 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandler.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandler.java
@@ -133,10 +133,10 @@ public interface EngineHandler {
/**
* Handles write of AMQPHeader either by directly writing it to the output
target or by
* converting it to bytes and firing a write using the {@link
ProtonBuffer} based API
- * in {@link EngineHandlerContext#fireWrite(ProtonBuffer)}
+ * in {@link EngineHandlerContext#fireWrite(ProtonBuffer, Runnable)}
*
* @param context
- * The {@link EngineHandlerContext} associated with this {@link
EngineWriteHandler} instance.
+ * The {@link EngineHandlerContext} associated with this {@link
EngineHandler} instance.
* @param envelope
* The {@link HeaderEnvelope} instance to write.
*/
@@ -147,10 +147,10 @@ public interface EngineHandler {
/**
* Handles write of AMQP performative envelope either by directly writing
it to the output target or
* by converting it to bytes and firing a write using the {@link
ProtonBuffer} based API in
- * {@link EngineHandlerContext#fireWrite(ProtonBuffer)}
+ * {@link EngineHandlerContext#fireWrite(ProtonBuffer, Runnable)}
*
* @param context
- * The {@link EngineHandlerContext} associated with this {@link
EngineWriteHandler} instance.
+ * The {@link EngineHandlerContext} associated with this {@link
EngineHandler} instance.
* @param envelope
* The {@link OutgoingAMQPEnvelope} instance to write.
*/
@@ -161,10 +161,10 @@ public interface EngineHandler {
/**
* Handles write of SaslPerformative either by directly writing it to the
output target or by
* converting it to bytes and firing a write using the {@link
ProtonBuffer} based API
- * in {@link EngineHandlerContext#fireWrite(ProtonBuffer)}
+ * in {@link EngineHandlerContext#fireWrite(ProtonBuffer, Runnable)}
*
* @param context
- * The {@link EngineHandlerContext} associated with this {@link
EngineWriteHandler} instance.
+ * The {@link EngineHandlerContext} associated with this {@link
EngineHandler} instance.
* @param envelope
* The {@link SASLEnvelope} instance to write.
*/
@@ -179,7 +179,7 @@ public interface EngineHandler {
* as an output sink is required for all low level engine writes.
*
* @param context
- * The {@link EngineHandlerContext} associated with this {@link
EngineWriteHandler} instance.
+ * The {@link EngineHandlerContext} associated with this {@link
EngineHandler} instance.
* @param buffer
* The {@link ProtonBuffer} whose payload is to be written to the
output target.
* @param ioComplete
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingAMQPEnvelope.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingAMQPEnvelope.java
index 2d34bbe..6616976 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingAMQPEnvelope.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingAMQPEnvelope.java
@@ -75,7 +75,7 @@ public class OutgoingAMQPEnvelope extends
PerformativeEnvelope<Performative> {
* @param frameWriteCompleteHandler
* Runnable handler that will update state or otherwise respond to
the write of a frame.
*
- * @return this {@link OutgoingProtocolFrame} instance.
+ * @return this {@link OutgoingAMQPEnvelope} instance.
*/
public OutgoingAMQPEnvelope setFrameWriteCompletionHandler(Runnable
frameWriteCompleteHandler) {
this.frameWriteCompleteHandler = frameWriteCompleteHandler;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
index 85e6ca7..adf4637 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/OutgoingDelivery.java
@@ -33,7 +33,7 @@ public interface OutgoingDelivery {
Sender getLink();
/**
- * @return the {@link Attachments} instance that is associated with this
{@link Delivery}
+ * @return the {@link Attachments} instance that is associated with this
{@link OutgoingDelivery}
*/
Attachments getAttachments();
@@ -151,7 +151,6 @@ public interface OutgoingDelivery {
* @return true if the delivery is partial
*
* @see #isAborted()
- * @see #isComplete()
*/
boolean isPartial();
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Transaction.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Transaction.java
index d896253..0f47295 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Transaction.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Transaction.java
@@ -42,7 +42,7 @@ public interface Transaction<E extends Endpoint<?>> {
* For a {@link Transaction} that has either been requested to discharge
or has successfully
* discharged the {@link DischargeState} reflects whether the transaction
was to be committed or
* rolled back. Prior to a discharge being attempted there is no state
value and this method
- * returns {@link DischargeState.NONE}.
+ * returns a {@link DischargeState} of none.
*
* @return the current {@link DischargeState} of the transaction.
*/
@@ -68,7 +68,7 @@ public interface Transaction<E extends Endpoint<?>> {
boolean isFailed();
/**
- * If the declare or discharge of the transaction caused its state to
become {@link TransactionState#FAILED}
+ * If the declare or discharge of the transaction caused its state to
become {@link TransactionState} FAILED
* this method returns the {@link ErrorCondition} that the remote used to
describe the reason for the failure.
*
* @return the {@link ErrorCondition} that the {@link TransactionManager}
used to fail the {@link Transaction}.
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientListener.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientListener.java
index b1ba36d..5c93936 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientListener.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientListener.java
@@ -37,7 +37,7 @@ public interface SaslClientListener {
* authentication properties.
* <p>
* In the event that the client implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslClientContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
+ * {@link SaslClientContext#saslFailure(javax.security.sasl.SaslException)}
* to signal the {@link Engine} that it should transition to a failed
state.
*
* @param context
@@ -53,7 +53,7 @@ public interface SaslClientListener {
* or later using the same thread that triggered this event.
* <p>
* In the event that the client implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslClientContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
to fail
+ * {@link
SaslClientContext#saslFailure(javax.security.sasl.SaslException)} to fail
* the SASL negotiation and signal the {@link Engine} that it should
transition to a failed state.
*
* @param context
@@ -74,7 +74,7 @@ public interface SaslClientListener {
* thread that triggered this event.
* <p>
* In the event that the client implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslClientContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
to fail
+ * {@link
SaslClientContext#saslFailure(javax.security.sasl.SaslException)} to fail
* the SASL negotiation and signal the {@link Engine} that it should
transition to a failed state.
*
* @param context
@@ -94,7 +94,7 @@ public interface SaslClientListener {
* indicate that negotiations have failed and the server has not
authenticated the client.
* <p>
* In the event that the client implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslClientContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
to fail
+ * {@link
SaslClientContext#saslFailure(javax.security.sasl.SaslException)} to fail
* the SASL negotiation and signal the {@link Engine} that it should
transition to a failed state.
*
* @param context
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerListener.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerListener.java
index d6ec3ce..f17d90d 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerListener.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerListener.java
@@ -38,7 +38,7 @@ public interface SaslServerListener {
* authentication properties.
* <p>
* In the event that the server implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslServerContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
signal
+ * {@link
SaslServerContext#saslFailure(javax.security.sasl.SaslException)} signal
* the {@link Engine} that it should transition to a failed state.
*
* @param context
@@ -52,7 +52,7 @@ public interface SaslServerListener {
* method immediately or later using the same thread that invoked this
event handler.
* <p>
* In the event that the server implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslServerContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
to fail
+ * {@link
SaslServerContext#saslFailure(javax.security.sasl.SaslException)} to fail
* the SASL negotiation and signal the {@link Engine} that it should
transition to a failed state.
*
* @param context
@@ -72,7 +72,7 @@ public interface SaslServerListener {
* can either respond immediately or it should response using the same
thread that invoked this handler.
* <p>
* In the event that the server implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslServerContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
to fail
+ * {@link
SaslServerContext#saslFailure(javax.security.sasl.SaslException)} to fail
* the SASL negotiation and signal the {@link Engine} that it should
transition to a failed state.
*
* @param context
@@ -95,7 +95,7 @@ public interface SaslServerListener {
* same thread that the response handler was invoked from.
* <p>
* In the event that the server implementation cannot proceed with SASL
authentication it should call the
- * {@link
SaslServerContext#saslFailure(org.apache.qpid.protonj2.engine.exceptions.SaslException)}
to fail
+ * {@link
SaslServerContext#saslFailure(javax.security.sasl.SaslException)} to fail
* the SASL negotiation and signal the {@link Engine} that it should
transition to a failed state.
*
* @param context
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SplayMap.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SplayMap.java
index cdd5097..925b131 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SplayMap.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SplayMap.java
@@ -85,7 +85,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
* immediately without modifying the {@link Map}.
*
* @param key
- * the integer key value to search for in the {@link
BottomUpSplayMap}.
+ * the integer key value to search for in the {@link SplayMap}.
*
* @return the value stored for the given key if found or null if not in
the {@link Map}.
*/
@@ -314,13 +314,13 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
/**
* A specialized forEach implementation that accepts a {@link Consumer}
function that will
- * be called for each value in the {@link BottomUpSplayMap}. This method
can save overhead as it does not
+ * be called for each value in the {@link SplayMap}. This method can save
overhead as it does not
* need to box the primitive key values into an object for the call to the
provided function.
* Unless otherwise specified by the implementing class, actions are
performed in the order of entry
* set iteration (if an iteration order is specified.)
*
* @param action
- * The action to be performed for each of the values in the {@link
BottomUpSplayMap}.
+ * The action to be performed for each of the values in the {@link
SplayMap}.
*/
public void forEach(Consumer<? super E> action) {
Objects.requireNonNull(action);
diff --git
a/protonj2/src/test/java/org/apache/qpid/protonj2/codec/legacy/LegacyCodecAdapter.java
b/protonj2/src/test/java/org/apache/qpid/protonj2/codec/legacy/LegacyCodecAdapter.java
index 53b3879..941c3e8 100644
---
a/protonj2/src/test/java/org/apache/qpid/protonj2/codec/legacy/LegacyCodecAdapter.java
+++
b/protonj2/src/test/java/org/apache/qpid/protonj2/codec/legacy/LegacyCodecAdapter.java
@@ -76,7 +76,7 @@ public final class LegacyCodecAdapter {
* @param buffer
* The buffer containing the encoded type.
*
- * @return a {@link LegacyTypeAdapter} that can compare against the new
version of the type.
+ * @return a decoded version of the legacy encoded type that can compare
against the new version of the type.
*/
public Object decodeLegacyType(ProtonBuffer buffer) {
ByteBuffer byteBuffer = buffer.toByteBuffer();
diff --git
a/protonj2/src/test/java/org/apache/qpid/protonj2/types/transport/AttachTest.java
b/protonj2/src/test/java/org/apache/qpid/protonj2/types/transport/AttachTest.java
index a27afa0..e334c9d 100644
---
a/protonj2/src/test/java/org/apache/qpid/protonj2/types/transport/AttachTest.java
+++
b/protonj2/src/test/java/org/apache/qpid/protonj2/types/transport/AttachTest.java
@@ -270,8 +270,8 @@ public class AttachTest {
original.setTarget((Coordinator) null);
original.setMaxMessageSize(null);
original.setUnsettled(null);
- original.setOfferedCapabilities(null);
- original.setDesiredCapabilities(null);
+ original.setOfferedCapabilities((Symbol[]) null);
+ original.setDesiredCapabilities((Symbol[]) null);
assertFalse(original.hasTarget());
assertFalse(original.hasSource());
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org
