This is an automated email from the ASF dual-hosted git repository.
tabish121 pushed a commit to branch 1.x
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git
The following commit(s) were added to refs/heads/1.x by this push:
new b0203386 PROTON-2998 Clean up old types and errors in javadocs, error
messages and logs
b0203386 is described below
commit b0203386a648e6ee692307f78570d3339236ad2c
Author: Timothy Bish <[email protected]>
AuthorDate: Tue Nov 3 14:35:01 2026 -0500
PROTON-2998 Clean up old types and errors in javadocs, error messages and
logs
Perform a sweep of the API docs and fix errors there
Fix some error messages to report correct details
Improve some logging calls where checking for trace enabled makes sense
Fix some other minor cut and paste errors spotted during review
(cherry picked from commit 5afcb3f3ae4051b784377862f5dd25afebb94de0)
---
.../protonj2/buffer/ProtonBufferAccessors.java | 2 +-
.../buffer/netty/Netty4ProtonBufferAllocator.java | 3 +-
.../apache/qpid/protonj2/codec/EncodingCodes.java | 2 +-
.../codec/decoders/PrimitiveArrayTypeDecoder.java | 2 +-
.../protonj2/codec/decoders/ProtonDecoder.java | 2 +-
.../codec/decoders/ProtonStreamDecoder.java | 2 +-
.../protonj2/codec/decoders/ProtonStreamUtils.java | 2 +-
.../decoders/UnknownDescribedTypeDecoder.java | 2 +-
.../engine/AMQPPerformativeEnvelopePool.java | 2 +-
.../apache/qpid/protonj2/engine/Connection.java | 20 +++++------
.../org/apache/qpid/protonj2/engine/Endpoint.java | 12 +++----
.../org/apache/qpid/protonj2/engine/Engine.java | 24 ++++++-------
.../apache/qpid/protonj2/engine/EngineHandler.java | 10 +++---
.../qpid/protonj2/engine/EngineHandlerContext.java | 2 +-
.../qpid/protonj2/engine/EnginePipeline.java | 2 +-
.../qpid/protonj2/engine/EngineSaslDriver.java | 8 ++---
.../apache/qpid/protonj2/engine/EngineState.java | 2 +-
.../qpid/protonj2/engine/HeaderEnvelope.java | 4 +--
.../qpid/protonj2/engine/IncomingDelivery.java | 18 +++++-----
.../java/org/apache/qpid/protonj2/engine/Link.java | 14 ++++----
.../qpid/protonj2/engine/OutgoingAMQPEnvelope.java | 6 ++--
.../qpid/protonj2/engine/OutgoingDelivery.java | 18 +++++-----
.../qpid/protonj2/engine/PerformativeEnvelope.java | 2 +-
.../org/apache/qpid/protonj2/engine/Receiver.java | 14 ++++----
.../org/apache/qpid/protonj2/engine/Scheduler.java | 8 ++---
.../org/apache/qpid/protonj2/engine/Sender.java | 2 +-
.../org/apache/qpid/protonj2/engine/Session.java | 16 ++++-----
.../apache/qpid/protonj2/engine/Transaction.java | 8 ++---
.../protonj2/engine/TransactionController.java | 18 +++++-----
.../qpid/protonj2/engine/TransactionManager.java | 20 +++++------
.../qpid/protonj2/engine/TransactionState.java | 8 ++---
.../engine/exceptions/EngineFailedException.java | 4 +--
.../engine/exceptions/EngineShutdownException.java | 2 +-
.../engine/exceptions/ProtonExceptionSupport.java | 6 ++--
.../engine/impl/ProtonDeliveryTagGenerator.java | 10 +++---
.../qpid/protonj2/engine/impl/ProtonEngine.java | 4 +--
.../engine/impl/ProtonEngineHandlerContext.java | 2 +-
.../engine/impl/ProtonFrameDecodingHandler.java | 6 ++--
.../engine/impl/ProtonFrameLoggingHandler.java | 16 ++++++---
.../engine/impl/ProtonPooledTagGenerator.java | 2 +-
.../engine/impl/ProtonSessionIncomingWindow.java | 2 ++
.../engine/impl/ProtonSessionOutgoingWindow.java | 10 ++++--
.../engine/impl/sasl/ProtonSaslHandler.java | 2 +-
.../protonj2/engine/sasl/SaslClientContext.java | 10 +++---
.../protonj2/engine/sasl/SaslClientListener.java | 7 ++--
.../protonj2/engine/sasl/SaslServerContext.java | 12 +++----
.../protonj2/engine/sasl/SaslServerListener.java | 12 +++----
.../protonj2/engine/sasl/client/Mechanism.java | 8 ++---
.../engine/sasl/client/OauthBearerMechanism.java | 4 +--
.../engine/sasl/client/SaslMechanismSelector.java | 8 ++---
.../engine/sasl/client/ScramSHA1Mechanism.java | 1 -
.../engine/sasl/client/ScramSHA256Mechanism.java | 1 -
.../engine/sasl/client/ScramSHA512Mechanism.java | 3 +-
.../engine/sasl/client/XOauth2Mechanism.java | 4 +--
.../protonj2/engine/util/DeliveryIdTracker.java | 2 +-
.../qpid/protonj2/engine/util/LinkedSplayMap.java | 4 +--
.../qpid/protonj2/engine/util/RingQueue.java | 4 +--
.../qpid/protonj2/engine/util/SequenceNumber.java | 18 +++++-----
.../apache/qpid/protonj2/engine/util/SplayMap.java | 40 +++++++++++-----------
.../qpid/protonj2/engine/util/StringUtils.java | 12 +++----
.../qpid/protonj2/engine/util/UnsettledMap.java | 10 +++---
61 files changed, 245 insertions(+), 236 deletions(-)
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/ProtonBufferAccessors.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/ProtonBufferAccessors.java
index bf681cb0..f40c51e2 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/ProtonBufferAccessors.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/ProtonBufferAccessors.java
@@ -222,7 +222,7 @@ public interface ProtonBufferAccessors {
ProtonBuffer setChar(int index, char value);
/**
- * Reads a character value from the buffer and advances the read index by
four.
+ * Reads a character value from the buffer and advances the read index by
two.
*
* @return char value read from the buffer.
*
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/netty/Netty4ProtonBufferAllocator.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/netty/Netty4ProtonBufferAllocator.java
index 8a22e6c9..b833924c 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/netty/Netty4ProtonBufferAllocator.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/buffer/netty/Netty4ProtonBufferAllocator.java
@@ -25,6 +25,7 @@ import io.netty.buffer.ByteBuf;
import io.netty.buffer.ByteBufAllocator;
import io.netty.buffer.PooledByteBufAllocator;
import io.netty.buffer.Unpooled;
+import io.netty.buffer.UnpooledByteBufAllocator;
/**
* Proton managed Netty 4 {@link ByteBufAllocator} wrapper.
@@ -33,7 +34,7 @@ public final class Netty4ProtonBufferAllocator implements
ProtonBufferAllocator
public static ProtonBufferAllocator POOLED = new
Netty4ProtonBufferAllocator(PooledByteBufAllocator.DEFAULT);
- public static ProtonBufferAllocator UNPOOLED = new
Netty4ProtonBufferAllocator(PooledByteBufAllocator.DEFAULT);
+ public static ProtonBufferAllocator UNPOOLED = new
Netty4ProtonBufferAllocator(UnpooledByteBufAllocator.DEFAULT);
private final ByteBufAllocator allocator;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/EncodingCodes.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/EncodingCodes.java
index 5ba6d465..a970331f 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/EncodingCodes.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/EncodingCodes.java
@@ -175,7 +175,7 @@ public interface EncodingCodes {
case MAP32:
return "MAP32:0xd1";
case ARRAY8:
- return "ARRAY32:0xe0";
+ return "ARRAY8:0xe0";
case ARRAY32:
return "ARRAY32:0xf0";
default:
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/PrimitiveArrayTypeDecoder.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/PrimitiveArrayTypeDecoder.java
index 884b5b6e..32edbc4c 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/PrimitiveArrayTypeDecoder.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/PrimitiveArrayTypeDecoder.java
@@ -162,7 +162,7 @@ public interface PrimitiveArrayTypeDecoder extends
PrimitiveTypeDecoder<Object>
} else if (Integer.compareUnsigned(count, state.getMaxArraySize()) >
0) {
throw new DecodeException(String.format(
"Encoded array count %d is specified to be greater than
the amount " +
- "of the configured max array length (%d)",
Integer.toUnsignedLong(count), state.getMaxStringSize()));
+ "of the configured max array length (%d)",
Integer.toUnsignedLong(count), state.getMaxArraySize()));
}
}
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoder.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoder.java
index 7eb7b136..8f9a7155 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoder.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonDecoder.java
@@ -727,7 +727,7 @@ public class ProtonDecoder implements Decoder {
case EncodingCodes.NULL:
return defaultValue;
default:
- throw new DecodeException("Expected Unsigned Long type but
found encoding: " + EncodingCodes.toString(encodingCode));
+ throw new DecodeException("Expected Long type but found
encoding: " + EncodingCodes.toString(encodingCode));
}
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoder.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoder.java
index e51179af..426ccd5c 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoder.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamDecoder.java
@@ -720,7 +720,7 @@ public final class ProtonStreamDecoder implements
StreamDecoder {
case EncodingCodes.NULL:
return defaultValue;
default:
- throw new DecodeException("Expected Unsigned Long type but
found encoding: " + EncodingCodes.toString(encodingCode));
+ throw new DecodeException("Expected Long type but found
encoding: " + EncodingCodes.toString(encodingCode));
}
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamUtils.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamUtils.java
index 7cc5016f..613d2a94 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamUtils.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/ProtonStreamUtils.java
@@ -48,7 +48,7 @@ public abstract class ProtonStreamUtils {
try {
stream.write(value);
} catch (IOException ex) {
- throw new DecodeException("Caught IO error writing to provided
stream", ex);
+ throw new EncodeException("Caught IO error writing to provided
stream", ex);
}
return stream;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/UnknownDescribedTypeDecoder.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/UnknownDescribedTypeDecoder.java
index fe180d88..03fd0339 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/UnknownDescribedTypeDecoder.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/codec/decoders/UnknownDescribedTypeDecoder.java
@@ -118,7 +118,7 @@ public abstract class UnknownDescribedTypeDecoder extends
AbstractDescribedTypeD
} else if (count > state.getMaxArraySize()) {
throw new DecodeException(String.format(
"Array encoded length %d is specified to be greater than the
amount " +
- "of the configured max array length (%d)", count,
state.getMaxStringSize()));
+ "of the configured max array length (%d)", count,
state.getMaxArraySize()));
}
final UnknownDescribedType[] result = new UnknownDescribedType[count];
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/AMQPPerformativeEnvelopePool.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/AMQPPerformativeEnvelopePool.java
index af7ddff6..5399ad37 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/AMQPPerformativeEnvelopePool.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/AMQPPerformativeEnvelopePool.java
@@ -72,7 +72,7 @@ public class AMQPPerformativeEnvelopePool<E extends
PerformativeEnvelope<Perform
}
/**
- * Requests an envelope from the pool and if non is available creates one
using the given
+ * Requests an envelope from the pool and if none is available creates one
using the given
* builder this pool was created with.
*
* @param body
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Connection.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Connection.java
index 905270f2..dd4b3d67 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Connection.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Connection.java
@@ -35,8 +35,8 @@ public interface Connection extends Endpoint<Connection> {
* send its AMQP header.
*
* Once a header is sent the remote should respond with the AMQP Header
that indicates what
- * protocol level it supports and if there is a mismatch the the engine
will be failed with
- * a error indicating the protocol support was not successfully negotiated.
+ * protocol level it supports and if there is a mismatch the engine will
be failed with
+ * an error indicating the protocol support was not successfully
negotiated.
*
* If the engine has a configured SASL layer then by starting the AMQP
Header exchange this
* will implicitly first attempt the SASL authentication step of the
connection process.
@@ -55,14 +55,14 @@ public interface Connection extends Endpoint<Connection> {
* send its AMQP header.
*
* Once a header is sent the remote should respond with the AMQP Header
that indicates what
- * protocol level it supports and if there is a mismatch the the engine
will be failed with
- * a error indicating the protocol support was not successfully negotiated.
+ * protocol level it supports and if there is a mismatch the engine will
be failed with
+ * an error indicating the protocol support was not successfully
negotiated.
*
* If the engine has a configured SASL layer then by starting the AMQP
Header exchange this
* will implicitly first attempt the SASL authentication step of the
connection process.
*
* The provided remote AMQP Header handler will be called once the remote
sends its AMQP Header to
- * the either preemptively or as a response to offered AMQP Header from
this peer, even if that has
+ * this peer preemptively or as a response to the offered AMQP Header from
this peer, even if that has
* already happened prior to this call.
*
* @param remoteAMQPHeaderHandler
@@ -216,7 +216,7 @@ public interface Connection extends Endpoint<Connection> {
* is called.
*
* @param maxFrameSize
- * The maximum number of bytes allowed for a single
+ * The maximum number of bytes allowed for a single incoming frame
*
* @return this connection.
*
@@ -304,7 +304,7 @@ public interface Connection extends Endpoint<Connection> {
* Sets a {@link EventHandler} for when an AMQP Begin frame is received
from the remote peer.
*
* Used to process remotely initiated Sessions. Locally initiated sessions
have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote Session creation.
+ * invoked instead. This method is typically used by servers to listen
for remote Session creation.
*
* @param remoteSessionOpenEventHandler
* the EventHandler that will be signaled when a session is
remotely opened.
@@ -317,7 +317,7 @@ public interface Connection extends Endpoint<Connection> {
* Sets a {@link EventHandler} for when an AMQP Attach frame is received
from the remote peer for a sending link.
*
* Used to process remotely initiated sending link. Locally initiated
links have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote Receiver creation.
+ * invoked instead. This method is typically used by servers to listen
for remote Receiver creation.
* If an event handler for remote sender open is registered on the Session
that the link is owned by then
* that handler will be invoked instead of this one.
*
@@ -332,7 +332,7 @@ public interface Connection extends Endpoint<Connection> {
* Sets a {@link EventHandler} for when an AMQP Attach frame is received
from the remote peer for a receiving link.
*
* Used to process remotely initiated receiving link. Locally initiated
links have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote Sender creation.
+ * invoked instead. This method is typically used by servers to listen
for remote Sender creation.
* If an event handler for remote receiver open is registered on the
Session that the link is owned by then
* that handler will be invoked instead of this one.
*
@@ -348,7 +348,7 @@ public interface Connection extends Endpoint<Connection> {
* coordination link.
*
* Used to process remotely initiated transaction manager link. Locally
initiated links have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote {@link TransactionController}
+ * invoked instead. This method is typically used by servers to listen
for remote {@link TransactionController}
* creation. If an event handler for remote {@link TransactionController}
open is registered on the Session that the
* link is owned by then that handler will be invoked instead of this one.
*
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Endpoint.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Endpoint.java
index 2ecb1c5c..e4f8e74b 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Endpoint.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Endpoint.java
@@ -99,7 +99,7 @@ public interface Endpoint<E extends Endpoint<E>> {
* @param <T> The type to cast the linked resource to if one is set.
* @param typeClass the type's Class which is used for casting the
returned value.
*
- * @return the user set linked resource for this Context instance.
+ * @return the user set linked resource for this endpoint instance.
*
* @throws ClassCastException if the linked resource cannot be cast to the
type requested.
*/
@@ -256,7 +256,7 @@ public interface Endpoint<E extends Endpoint<E>> {
//----- Events for AMQP Endpoint resources
/**
- * Sets a {@link EventHandler} for when an this {@link Endpoint} is opened
locally via a call to {@link Endpoint#open()}
+ * Sets a {@link EventHandler} for when this {@link Endpoint} is opened
locally via a call to {@link Endpoint#open()}
*
* Typically used by clients for logging or other state update event
processing. Clients should not perform any
* blocking calls within this context. It is an error for the handler to
throw an exception and the outcome of
@@ -270,7 +270,7 @@ public interface Endpoint<E extends Endpoint<E>> {
E localOpenHandler(EventHandler<E> localOpenHandler);
/**
- * Sets a {@link EventHandler} for when an this {@link Endpoint} is closed
locally via a call to {@link Connection#close()}
+ * Sets a {@link EventHandler} for when this {@link Endpoint} is closed
locally via a call to {@link #close()}
*
* Typically used by clients for logging or other state update event
processing. Clients should not perform any
* blocking calls within this context. It is an error for the handler to
throw an exception and the outcome of
@@ -284,7 +284,7 @@ public interface Endpoint<E extends Endpoint<E>> {
E localCloseHandler(EventHandler<E> localCloseHandler);
/**
- * Sets a EventHandler for when an AMQP Open frame is received from the
remote peer.
+ * Sets an EventHandler for when an AMQP Open frame is received from the
remote peer.
*
* Used to process remotely initiated Connections. Locally initiated
sessions have their own EventHandler
* invoked instead. This method is typically used by servers to listen
for the remote peer to open its
@@ -302,7 +302,7 @@ public interface Endpoint<E extends Endpoint<E>> {
E openHandler(EventHandler<E> remoteOpenEventHandler);
/**
- * Sets a EventHandler for when an AMQP Close frame is received from the
remote peer.
+ * Sets an EventHandler for when an AMQP Close frame is received from the
remote peer.
*
* @param remoteCloseEventHandler
* the EventHandler that will be signaled when the {@link
Endpoint} is remotely closed.
@@ -315,7 +315,7 @@ public interface Endpoint<E extends Endpoint<E>> {
* Sets an {@link EventHandler} that is invoked when the engine that
supports this {@link Endpoint} is shutdown
* via a call to {@link Engine#shutdown()} which indicates a desire to
terminate all engine operations. Any
* {@link Endpoint} that has been both locally and remotely closed will
not receive this event as it will no longer
- * be tracked by the parent its parent {@link Endpoint}.
+ * be tracked by its parent {@link Endpoint}.
*
* A typical use of this event would be from a locally closed {@link
Endpoint} that is awaiting response from
* the remote. If this event fires then there will never be a remote
response to any pending operations and
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Engine.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Engine.java
index a0ad5136..2a94f00d 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Engine.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Engine.java
@@ -39,7 +39,7 @@ public interface Engine extends Consumer<ProtonBuffer> {
* error being returned from the write operation. An engine that has not
been
* started or that has been failed or shutdown will report as not writable.
*
- * @return true if the engine is current accepting more input.
+ * @return true if the engine is currently accepting more input.
*/
boolean isWritable();
@@ -59,7 +59,7 @@ public interface Engine extends Consumer<ProtonBuffer> {
boolean isFailed();
/**
- * @return the error that caused the {@link Engine} fail and shutdown (or
null if not failed).
+ * @return the error that caused the {@link Engine} to fail and shutdown
(or null if not failed).
*/
Throwable failureCause();
@@ -86,7 +86,7 @@ public interface Engine extends Consumer<ProtonBuffer> {
*
* @return the Connection instance that is linked to this {@link Engine}
*
- * @throws EngineStateException if the Engine state has already transition
to shutdown or failed.
+ * @throws EngineStateException if the Engine state has already
transitioned to shutdown or failed.
*/
Connection start() throws EngineStateException;
@@ -121,13 +121,13 @@ public interface Engine extends Consumer<ProtonBuffer> {
/**
* Provide data input for this Engine from some external source. If the
engine is not writable
- * when this method is called an {@link EngineNotWritableException} will
be thrown if unless the
+ * when this method is called an {@link EngineNotWritableException} will
be thrown unless the
* reason for the not writable state is due to engine failure or the
engine already having been
* shut down in which case the appropriate {@link EngineStateException}
will be thrown to indicate
* the reason.
*
* @param input
- * The data to feed into to Engine.
+ * The data to feed into the Engine.
*
* @return this {@link Engine}
*
@@ -137,13 +137,13 @@ public interface Engine extends Consumer<ProtonBuffer> {
/**
* Provide data input for this Engine from some external source. If the
engine is not writable
- * when this method is called an {@link EngineNotWritableException} will
be thrown if unless the
+ * when this method is called an {@link EngineNotWritableException} will
be thrown unless the
* reason for the not writable state is due to engine failure or the
engine already having been
* shut down in which case the appropriate {@link EngineStateException}
will be thrown to indicate
* the reason.
*
* @param input
- * The data to feed into to Engine.
+ * The data to feed into the Engine.
*
* @throws EngineStateException if the Engine state precludes accepting
new input.
*/
@@ -185,7 +185,7 @@ public interface Engine extends Consumer<ProtonBuffer> {
/**
* Allows the engine to manage idle timeout processing by providing it the
single threaded executor
- * context where all transport work is done which ensures singled threaded
access while removing the
+ * context where all transport work is done which ensures single-threaded
access while removing the
* need for the client library or server application to manage calls to
the {@link Engine#tick} methods.
* <p>
* The API should allow for configuring auto idle timeout handling before
the connection has opened and
@@ -204,7 +204,7 @@ public interface Engine extends Consumer<ProtonBuffer> {
/**
* Allows the engine to manage idle timeout processing by providing it the
single threaded executor
- * context where all transport work is done which ensures singled threaded
access while removing the
+ * context where all transport work is done which ensures single-threaded
access while removing the
* need for the client library or server application to manage calls to
the {@link Engine#tick} methods.
* <p>
* The API should allow for configuring auto idle timeout handling before
the connection has opened and
@@ -288,7 +288,7 @@ public interface Engine extends Consumer<ProtonBuffer> {
/**
* Sets a {@link BiConsumer} instance that will be notified when data from
the engine is ready to
* be written to some output sink (socket etc). The {@link Runnable}
value provided (if non-null)
- * should be invoked once the I/O operation has completely successfully.
If the event of an error
+ * should be invoked once the I/O operation has completed successfully.
In the event of an error
* writing the data the handler should throw an error or if performed
asynchronously the {@link Engine}
* should be marked failed via a call to {@link
Engine#engineFailed(Throwable)}.
*
@@ -311,10 +311,10 @@ public interface Engine extends Consumer<ProtonBuffer> {
/**
* Sets a handler instance that will be notified when the engine is shut
down via a call to the
- * {@link Engine#shutdown()} method is called.
+ * {@link Engine#shutdown()} method.
*
* @param engineShutdownEventHandler
- * The {@link Engine} instance that was was explicitly shut down.
+ * The {@link EventHandler} instance that will be signaled if the
engine is shut down.
*
* @return this {@link Engine}
*/
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 c797a504..a06ad22a 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
@@ -36,7 +36,7 @@ public interface EngineHandler {
default void handlerAdded(EngineHandlerContext context) {}
/**
- * Called when the handler is successfully removed to the {@link
EnginePipeline}.
+ * Called when the handler is successfully removed from the {@link
EnginePipeline}.
*
* @param context
* The context that is assigned to this handler.
@@ -67,7 +67,7 @@ public interface EngineHandler {
/**
* Called when the engine has transitioned to a failed state and cannot
process any additional
- * input or output. The handler can free and resources used for normal
operations at this point
+ * input or output. The handler can free the resources used for normal
operations at this point
* as the engine is now considered shutdown.
*
* @param context
@@ -173,9 +173,9 @@ public interface EngineHandler {
}
/**
- * Writes the given bytes to the output target or if no handler in the
pipeline handles this
- * calls the registered output handler of the parent Engine instance. If
not output handler
- * is found or not handler in the output chain consumes this write the
Engine will be failed
+ * Writes the given bytes to the output target or if no handler in the
pipeline handles this it
+ * calls the registered output handler of the parent Engine instance. If
no output handler
+ * is found or no handler in the output chain consumes this write the
Engine will be failed
* as an output sink is required for all low level engine writes.
*
* @param context
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandlerContext.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandlerContext.java
index c999c6df..b99bbd48 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandlerContext.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineHandlerContext.java
@@ -35,7 +35,7 @@ public interface EngineHandlerContext {
Engine engine();
/**
- * @return the name that assigned to this {@link EngineHandler} when added
to the {@link EnginePipeline}.
+ * @return the name that was assigned to this {@link EngineHandler} when
added to the {@link EnginePipeline}.
*/
String name();
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EnginePipeline.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EnginePipeline.java
index 4f48bcf3..cb4b4057 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EnginePipeline.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EnginePipeline.java
@@ -258,7 +258,7 @@ public interface EnginePipeline {
* @param buffer
* The {@link ProtonBuffer} to inject into the engine pipeline.
* @param ioComplete
- * An optional callback that should be signaled when the underlying
transport complete the I/O write
+ * An optional callback that should be signaled when the underlying
transport completes the I/O write
*
* @return this {@link EnginePipeline}.
*/
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineSaslDriver.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineSaslDriver.java
index b0011c94..00d804b8 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineSaslDriver.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineSaslDriver.java
@@ -42,7 +42,7 @@ public interface EngineSaslDriver {
IDLE,
/**
- * Engine started and set configuration in use
+ * Engine started and the set configuration is now in use
*/
AUTHENTICATING,
@@ -71,7 +71,7 @@ public interface EngineSaslDriver {
* @return the SASL client context.
*
* @throws IllegalStateException if the engine is already in server mode
or the engine has not
- * been configure with SASL support.
+ * been configured with SASL support.
*/
SaslClientContext client();
@@ -83,7 +83,7 @@ public interface EngineSaslDriver {
* @return the SASL server context.
*
* @throws IllegalStateException if the engine is already in client mode
or the engine has not
- * been configure with SASL support.
+ * been configured with SASL support.
*/
SaslServerContext server();
@@ -118,7 +118,7 @@ public interface EngineSaslDriver {
* Set the maximum frame size the remote can send before an error is
indicated.
* <p>
* The AMQP specification defines a default of 512 bytes for this value
however in
- * some cases this value is to small for the data needed in some SASL
mechanisms.
+ * some cases this value is too small for the data needed in some SASL
mechanisms.
* This allows the user to configure a larger acceptable value, the lowest
possible
* value remains the default 512 bytes.
*
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineState.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineState.java
index 30cb7038..252abd6a 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineState.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/EngineState.java
@@ -27,7 +27,7 @@ public enum EngineState {
IDLE,
/**
- * Indicates the engine is in the starting phase and configuration be safe
to use now.
+ * Indicates the engine is in the starting phase and configuration should
not be changed now.
*/
STARTING,
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/HeaderEnvelope.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/HeaderEnvelope.java
index 43295617..907a18f3 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/HeaderEnvelope.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/HeaderEnvelope.java
@@ -30,7 +30,7 @@ public class HeaderEnvelope extends
PerformativeEnvelope<AMQPHeader> {
public static final byte HEADER_FRAME_TYPE = (byte) 1;
/**
- * A singleton instance of an SASL header that can be used to avoid
additional allocations.
+ * A singleton instance of a SASL header that can be used to avoid
additional allocations.
*/
public static final HeaderEnvelope SASL_HEADER_ENVELOPE = new
HeaderEnvelope(AMQPHeader.getSASLHeader());
@@ -40,7 +40,7 @@ public class HeaderEnvelope extends
PerformativeEnvelope<AMQPHeader> {
public static final HeaderEnvelope AMQP_HEADER_ENVELOPE = new
HeaderEnvelope(AMQPHeader.getAMQPHeader());
/**
- * Create an header envelope with the given AMQHeader body.
+ * Create a header envelope with the given AMQPHeader body.
*
* @param body
* The AMQP header instance that holds the header bytes.
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
index 3ac0c10a..15348792 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/IncomingDelivery.java
@@ -33,7 +33,7 @@ public interface IncomingDelivery {
Receiver getLink();
/**
- * Returns the number of bytes currently available for reading form this
delivery, which may not be complete yet.
+ * Returns the number of bytes currently available for reading from this
delivery, which may not be complete yet.
* <p>
* Note that this value will change as bytes are received, and is in
general not equal to the total length of
* a delivery, except the point where {@link #isPartial()} returns false
and no content has yet been received by
@@ -69,7 +69,7 @@ public interface IncomingDelivery {
/**
* Reads bytes from this delivery and writes them into the destination
ProtonBuffer reducing the available
- * bytes by the value of the number of bytes written to the target. The
number of bytes written will be the
+ * bytes by the value of the number of bytes written to the target. The
number of bytes written will be
* equal to the writable bytes of the target buffer. The write index of
the target buffer will be incremented
* by the number of bytes written into it.
*
@@ -133,7 +133,7 @@ public interface IncomingDelivery {
/**
* @param <T> The type that the linked resource should be cast to on
return.
*
- * @return the user set linked resource for this {@link Endpoint} instance.
+ * @return the user set linked resource for this {@link IncomingDelivery}
instance.
*/
<T> T getLinkedResource();
@@ -144,7 +144,7 @@ public interface IncomingDelivery {
* @param <T> The type to cast the linked resource to if one is set.
* @param typeClass the type's Class which is used for casting the
returned value.
*
- * @return the user set linked resource for this Context instance.
+ * @return the user set linked resource for this delivery instance.
*
* @throws ClassCastException if the linked resource cannot be cast to the
type requested.
*/
@@ -259,7 +259,7 @@ public interface IncomingDelivery {
/**
* Returns the total number of transfer frames that have occurred for the
given {@link IncomingDelivery}.
*
- * @return the number of {@link Transfer} frames that this {@link
OutgoingDelivery} has initiated.
+ * @return the number of {@link Transfer} frames that this {@link
IncomingDelivery} has initiated.
*/
int getTransferCount();
@@ -273,9 +273,9 @@ public interface IncomingDelivery {
* <p>
* This handler is useful in cases where an incoming delivery is split
across many incoming {@link Transfer}
* frames either due to a large size or a small max frame size setting and
the processing is handed off to some
- * other resource other than the {@link Receiver} that original handling
the first transfer frame. If the initial
+ * other resource other than the {@link Receiver} that originally handled
the first transfer frame. If the initial
* {@link Transfer} carries the entire delivery payload then this event
handler will never be called. Once set
- * this event handler receiver all updates of incoming delivery {@link
Transfer} frames which would otherwise have
+ * this event handler receives all updates of incoming delivery {@link
Transfer} frames which would otherwise have
* been sent to the {@link Receiver#deliveryReadHandler(EventHandler)}
instance.
*
* @param handler
@@ -289,8 +289,8 @@ public interface IncomingDelivery {
* Handler for aborted deliveries that is called if this delivery is
aborted by the {@link Sender}.
* <p>
* This handler is an optional convenience handler that supplements the
standard
- * {@link #deliveryReadHandler(EventHandler)} in cases where the users
wishes to break out the
- * processing of inbound delivery data from abort processing. If this
handler is not set the
+ * {@link #deliveryReadHandler(EventHandler)} in cases where the user
wishes to break out of the
+ * processing of inbound delivery data due to abort processing. If this
handler is not set the
* {@link Receiver} will call the registered {@link
#deliveryAbortedHandler(EventHandler)}
* if one is set.
*
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Link.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Link.java
index 63d511b9..540ff210 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Link.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Link.java
@@ -50,7 +50,7 @@ public interface Link<L extends Link<L>> extends Endpoint<L> {
* from {@link Link#getState()} is equal to {@link LinkState#DETACHED}. A
link
* is locally detached after a call to {@link Link#detach()}.
*
- * @return true if the link is locally closed.
+ * @return true if the link is locally detached.
*
* @see Link#isLocallyOpen()
* @see Link#isLocallyClosed()
@@ -335,14 +335,14 @@ public interface Link<L extends Link<L>> extends
Endpoint<L> {
* the underlying type is known by the caller or as a control to validate
the assumption of the
* underlying type.
* <p>
- * the currently set Target for this {@link Link}. A link target can be
either a {@link Target}
+ * The currently set Target for this {@link Link}. A link target can be
either a {@link Target}
* type for a {@link Sender} or {@link Receiver} link or if the link is to
be transaction resource
* then the target type will be a {@link Coordinator} instance.
*
* @param <T>
* The type that the remote {@link Terminus} will be cast to on
return.
*
- * @return the source {@link Terminus} for the remote end of this link.
+ * @return the target {@link Terminus} for the remote end of this link.
*/
<T extends Terminus> T getRemoteTarget();
@@ -360,7 +360,7 @@ public interface Link<L extends Link<L>> extends
Endpoint<L> {
* Gets the remote link receiver settlement mode, as conveyed from the
peer via the Attach frame
* when attaching the link to the session.
*
- * @return the sender receiver mode conveyed by the peer, or null if there
was none.
+ * @return the receiver settle mode conveyed by the peer, or null if there
was none.
*
* @see #setReceiverSettleMode(ReceiverSettleMode)
*/
@@ -382,7 +382,7 @@ public interface Link<L extends Link<L>> extends
Endpoint<L> {
//----- Remote events for AMQP Link resources
/**
- * Sets a {@link EventHandler} for when an this link is detached locally
via a call to {@link Link#detach()}
+ * Sets an {@link EventHandler} for when this link is detached locally via
a call to {@link Link#detach()}
*
* This is a convenience event that supplements the normal {@link
Endpoint#localCloseHandler(EventHandler)}
* event point if set. If no local detached event handler is set the
endpoint will route the detached event
@@ -400,8 +400,8 @@ public interface Link<L extends Link<L>> extends
Endpoint<L> {
L localDetachHandler(EventHandler<L> localDetachHandler);
/**
- * Sets a {@link EventHandler} for when an AMQP Detach frame is received
from the remote peer for this
- * {@link Link} which would have been locally opened previously, the
Detach from would have been marked
+ * Sets an {@link EventHandler} for when an AMQP Detach frame is received
from the remote peer for this
+ * {@link Link} which would have been locally opened previously, the
Detach frame would have been marked
* as not having been closed.
* <p>
* This is a convenience event that supplements the normal {@link
Endpoint#closeHandler(EventHandler)}
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 f7ab3a5e..dae06cb8 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
@@ -27,7 +27,7 @@ import
org.apache.qpid.protonj2.types.transport.Performative.PerformativeHandler
public class OutgoingAMQPEnvelope extends PerformativeEnvelope<Performative> {
/**
- * The frame type value to used when encoding the outgoing AMQP frame.
+ * The frame type value to be used when encoding the outgoing AMQP frame.
*/
public static final byte AMQP_FRAME_TYPE = (byte) 0;
@@ -48,7 +48,7 @@ public class OutgoingAMQPEnvelope extends
PerformativeEnvelope<Performative> {
/**
* Configures a handler to be invoked if the payload that is being
transmitted with this
- * performative is to large to allow encoding the frame within the maximum
configured AMQP
+ * performative is too large to allow encoding the frame within the
maximum configured AMQP
* frame size limit.
*
* @param payloadToLargeHandler
@@ -68,7 +68,7 @@ public class OutgoingAMQPEnvelope extends
PerformativeEnvelope<Performative> {
/**
* Called when the encoder determines that the encoding of the {@link
Performative} plus any
- * payload value is to large for a single AMQP frame. The configured
handler should update
+ * payload value is too large for a single AMQP frame. The configured
handler should update
* the {@link Performative} in preparation for encoding as a split framed
AMQP transfer.
*
* @return this {@link OutgoingAMQPEnvelope} instance
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 ed6a3a09..a81ad44f 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
@@ -38,10 +38,10 @@ public interface OutgoingDelivery {
Attachments getAttachments();
/**
- * Links a given resource to this {@link Endpoint}.
+ * Links a given resource to this {@link OutgoingDelivery}.
*
* @param resource
- * The resource to link to this {@link Endpoint}.
+ * The resource to link to this {@link OutgoingDelivery}.
*
* @return this {@link OutgoingDelivery} instance.
*/
@@ -50,7 +50,7 @@ public interface OutgoingDelivery {
/**
* @param <T> The type that the linked resource should be cast to on
return.
*
- * @return the user set linked resource for this {@link Endpoint} instance.
+ * @return the user set linked resource for this {@link OutgoingDelivery}
instance.
*/
<T> T getLinkedResource();
@@ -61,7 +61,7 @@ public interface OutgoingDelivery {
* @param <T> The type to cast the linked resource to if one is set.
* @param typeClass the type's Class which is used for casting the
returned value.
*
- * @return the user set linked resource for this Context instance.
+ * @return the user set linked resource for this delivery instance.
*
* @throws ClassCastException if the linked resource cannot be cast to the
type requested.
*/
@@ -88,7 +88,7 @@ public interface OutgoingDelivery {
/**
* Sets the message-format for this Delivery, representing the 32bit value
using an integer value. The message format can
- * only be set@Override prior to the first {@link Transfer} of delivery
payload having been written. If one of the delivery
+ * only be set prior to the first {@link Transfer} of delivery payload
having been written. If one of the delivery
* write methods is called prior to the message format being set then it
defaults to the AMQP default format of zero.
* <p>
* The default value is 0 as per the message format defined in the core
AMQP 1.0 specification.
@@ -186,7 +186,7 @@ public interface OutgoingDelivery {
* to {@link #writeBytes(ProtonBuffer)} is made.
* <p>
* The {@link Sender} will output as much of the buffer as possible within
the constraints of both the link
- * credit and the current capacity of the parent {@link Session}. The
caller must check that all bytes were0
+ * credit and the current capacity of the parent {@link Session}. The
caller must check that all bytes were
* written and if not they should await updates from the {@link
Sender#creditStateUpdateHandler(EventHandler)}
* that indicate that the {@link Sender#isSendable()} has become true
again or the caller should check
* {@link Sender#isSendable()} periodically until it becomes true once
again.
@@ -209,7 +209,7 @@ public interface OutgoingDelivery {
* buffer contents on that send are fully written.
* <p>
* The {@link Sender} will output as much of the buffer as possible within
the constraints of both the link
- * credit and the current capacity of the parent {@link Session}. The
caller must check that all bytes were0
+ * credit and the current capacity of the parent {@link Session}. The
caller must check that all bytes were
* written and if not they should await updates from the {@link
Sender#creditStateUpdateHandler(EventHandler)}
* that indicate that the {@link Sender#isSendable()} has become true
again or the caller should check
* {@link Sender#isSendable()} periodically until it becomes true once
again.
@@ -260,11 +260,11 @@ public interface OutgoingDelivery {
* <p>
* If there has yet to be any writes from this delivery the delivery state
and settlement
* value is cached and applied to the first (or only) write of payload
from this delivery.
- * If however a write has already been performed than this method result
in a {@link Disposition}
+ * If however a write has already been performed then this method results
in a {@link Disposition}
* frame being sent to the remote with the given delivery state and
settlement value. Once
* the delivery is marked as settled any future call to this method will
do nothing if the
* requested disposition and settlement is the same however if a new state
is applied which
- * cannot be conveyed due to having already locally settling the {@link
OutgoingDelivery} than
+ * cannot be conveyed due to having already locally settled the {@link
OutgoingDelivery} then
* an {@link IllegalStateException} is thrown to indicate that request is
not valid.
*
* @param state
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/PerformativeEnvelope.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/PerformativeEnvelope.java
index 79b8d469..3faf932f 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/PerformativeEnvelope.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/PerformativeEnvelope.java
@@ -44,7 +44,7 @@ public abstract class PerformativeEnvelope<V> {
}
/**
- * @return the decoded body of the performative that this envelope
carries..
+ * @return the decoded body of the performative that this envelope carries.
*/
public V getBody() {
return body;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Receiver.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Receiver.java
index cb49e66b..a801359b 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Receiver.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Receiver.java
@@ -49,9 +49,9 @@ public interface Receiver extends Link<Receiver> {
boolean drain();
/**
- * Initiate a drain of the given credit from this this {@link Receiver}
link. If the credit
+ * Initiate a drain of the given credit from this {@link Receiver} link.
If the credit
* given is greater than the current link credit the current credit is
increased, however if
- * the amount of credit given is less that the current amount of link
credit an exception is
+ * the amount of credit given is less than the current amount of link
credit an exception is
* thrown.
*
* @param credit
@@ -80,13 +80,13 @@ public interface Receiver extends Link<Receiver> {
DeliveryState getDefaultDeliveryState();
/**
- * For each unsettled outgoing delivery that is pending in the {@link
Receiver} apply the given predicate
+ * For each unsettled incoming delivery that is pending in the {@link
Receiver} apply the given predicate
* and if it matches then apply the given delivery state and settled value
to it.
*
* @param filter
* The predicate to apply to each unsettled delivery to test for a
match.
* @param state
- * The new {@link DeliveryState} to apply to any matching outgoing
deliveries.
+ * The new {@link DeliveryState} to apply to any matching incoming
deliveries.
* @param settle
* Boolean indicating if the matching unsettled deliveries should be
settled.
*
@@ -95,7 +95,7 @@ public interface Receiver extends Link<Receiver> {
Receiver disposition(Predicate<IncomingDelivery> filter, DeliveryState
state, boolean settle);
/**
- * For each unsettled outgoing delivery that is pending in the {@link
Receiver} apply the given predicate
+ * For each unsettled incoming delivery that is pending in the {@link
Receiver} apply the given predicate
* and if it matches then settle the delivery.
*
* @param filter
@@ -141,8 +141,8 @@ public interface Receiver extends Link<Receiver> {
* Handler for aborted deliveries that is called for each aborted
in-progress delivery.
* <p>
* This handler is an optional convenience handler that supplements the
standard
- * {@link #deliveryReadHandler(EventHandler)} in cases where the users
wishes to break out the
- * processing of inbound delivery data from abort processing. If this
handler is not set the
+ * {@link #deliveryReadHandler(EventHandler)} in cases where the user
wishes to break out of the
+ * processing of inbound delivery data due to abort processing. If this
handler is not set the
* {@link Receiver} will call the registered {@link
#deliveryAbortedHandler(EventHandler)}
* if one is set.
*
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Scheduler.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Scheduler.java
index 1041c177..67b07f87 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Scheduler.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Scheduler.java
@@ -37,7 +37,7 @@ public interface Scheduler {
/**
* Runs the given {@link Runnable} command at some point in the future on
- * a the same thread of execution as all other API interactions with the
+ * the same thread of execution as all other API interactions with the
* proton {@link Engine}. The execution can be queued or it could be run
* immediately so long as the execution occurs on the thread that has
exclusive
* access to the engine.
@@ -57,7 +57,7 @@ public interface Scheduler {
* @param delay
* The time value to wait before running the command.
* @param unit
- * The time unit that define the units of the delay value.
+ * The time unit that defines the units of the delay value.
*
* @return a {@link Future} instance that can be awaited for completion of
the task.
*
@@ -72,11 +72,11 @@ public interface Scheduler {
* @param <V> The return type of the task
*
* @param task
- * The callable action action to schedule
+ * The callable action to schedule
* @param delay
* The time value to wait before running the command.
* @param unit
- * The time unit that define the units of the delay value.
+ * The time unit that defines the units of the delay value.
*
* @return a {@link Future} instance that can be awaited for completion of
the task.
*/
diff --git a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Sender.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Sender.java
index ac2036a4..7f11a2d9 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Sender.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Sender.java
@@ -49,7 +49,7 @@ public interface Sender extends Link<Sender> {
/**
* Gets the current {@link OutgoingDelivery} for this {@link Sender} if
one is available.
* <p>
- * The sender only tracks a current delivery in the case that the next
method has bee called
+ * The sender only tracks a current delivery in the case that the next
method has been called
* and if any bytes are written to the delivery using the streaming based
API
* {@link OutgoingDelivery#streamBytes(ProtonBuffer)} which allows for
later writing of additional
* bytes to the delivery. Once the method {@link
OutgoingDelivery#writeBytes(ProtonBuffer)} is
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Session.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Session.java
index 2b115e35..156f2f94 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Session.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/Session.java
@@ -181,8 +181,8 @@ public interface Session extends Endpoint<Session> {
/**
* Sets a {@link EventHandler} for when an AMQP Attach frame is received
from the remote peer for a sending link.
*
- * Used to process remotely initiated sending link. Locally initiated
links have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote Receiver creation.
+ * Used to process remotely initiated sending link. Locally initiated
links have their own EventHandler
+ * invoked instead. This method is typically used by servers to listen for
remote receiver creation.
* If an event handler for remote sender open is registered on this
Session for a link scoped to it then
* this handler will be invoked instead of the variant in the Connection
API.
*
@@ -197,8 +197,8 @@ public interface Session extends Endpoint<Session> {
* Sets a {@link EventHandler} for when an AMQP Attach frame is received
from the remote peer for a receiving link.
*
* Used to process remotely initiated receiving link. Locally initiated
links have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote Sender creation.
- * If an event handler for remote sender open is registered on this
Session for a link scoped to it then
+ * invoked instead. This method is typically used by servers to listen
for remote sender creation.
+ * If an event handler for remote receiver open is registered on this
Session for a link scoped to it then
* this handler will be invoked instead of the variant in the Connection
API.
*
* @param remoteReceiverOpenEventHandler
@@ -213,7 +213,7 @@ public interface Session extends Endpoint<Session> {
* coordination link.
*
* Used to process remotely initiated transaction manager link. Locally
initiated links have their own EventHandler
- * invoked instead. This method is Typically used by servers to listen
for remote {@link TransactionController}
+ * invoked instead. This method is typically used by servers to listen
for remote {@link TransactionController}
* creation. If an event handler for remote {@link TransactionController}
open is registered on this Session for a
* {@link TransactionController} scoped to it then this handler will be
invoked instead of the variant in the
* {@link Connection} API.
@@ -221,7 +221,7 @@ public interface Session extends Endpoint<Session> {
* @param remoteTxnManagerOpenEventHandler
* the EventHandler that will be signaled when a {@link
TransactionController} link is remotely opened.
*
- * @return this {@linkplain Session} for chaining
+ * @return this {@link Session} for chaining
*/
Session transactionManagerOpenHandler(EventHandler<TransactionManager>
remoteTxnManagerOpenEventHandler);
@@ -236,9 +236,9 @@ public interface Session extends Endpoint<Session> {
* performed by the service managing this session.
*
* @param delivery
- * The delivery that was read which contains
+ * The delivery that was read which contains newly read
bytes
*
- * @return this {@linkplain Session} for chaining
+ * @return this {@link Session} for chaining
*/
Session deliveryReadHandler(EventHandler<IncomingDelivery> delivery);
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 bef8b563..2ebd0d6d 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
@@ -74,7 +74,7 @@ public interface Transaction<E extends Endpoint<?>> {
boolean isDischarged();
/**
- * The parent resource will mark the {@link Transaction} as failed is any
of the operations performed on
+ * The parent resource will mark the {@link Transaction} as failed if any
of the operations performed on
* it cannot be successfully completed such as a {@link Declare} operation
failing to write due to an IO
* error.
*
@@ -92,8 +92,8 @@ public interface Transaction<E extends Endpoint<?>> {
/**
* Returns a reference to the parent of this {@link Transaction} which
will be either a
- * {@link TransactionController} or a {@link TransactionManager} manager
depending on the
- * end of the {@link Link} that is operating on the {@link Transaction}.
+ * {@link TransactionController} or a {@link TransactionManager} depending
on the end of
+ * the {@link Link} that is operating on the {@link Transaction}.
*
* @return a reference to the parent of this {@link Transaction}.
*/
@@ -133,7 +133,7 @@ public interface Transaction<E extends Endpoint<?>> {
* @param <T> The type to cast the linked resource to if one is set.
* @param typeClass the type's Class which is used for casting the
returned value.
*
- * @return the user set linked resource for this Context instance.
+ * @return the user set linked resource for this Transaction instance.
*
* @throws ClassCastException if the linked resource cannot be cast to the
type requested.
*/
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionController.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionController.java
index 9ee5435a..4307f3e5 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionController.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionController.java
@@ -110,7 +110,7 @@ public interface TransactionController extends
Endpoint<TransactionController> {
/**
* Creates a new {@link Transaction} instances that is returned in the
{@link TransactionState#IDLE} state
* which can be populated with application specific attachments or
assigned a linked resource prior to calling
- * the
+ * the {@link #declare()} API
*
* @return a new {@link Transaction} instance that can be correlated with
later declared events.
*/
@@ -136,22 +136,22 @@ public interface TransactionController extends
Endpoint<TransactionController> {
* event handler will be signaled.
*
* @param transaction
- * The {@link Transaction} that is will be associated with the
eventual declared transaction.
+ * The {@link Transaction} that will be associated with the eventual
declared transaction.
*
* @return this {@link TransactionController}
*/
TransactionController declare(Transaction<TransactionController>
transaction);
/**
- * Request that the remote {@link TransactionManager} discharge the given
transaction and
- * with the specified failure state (true for failed). Upon successful
declaration of
- * a new transaction the remote will respond and the {@link
TransactionController#declaredHandler(EventHandler)}
+ * Request that the remote {@link TransactionManager} discharge the given
transaction
+ * with the specified failure state (true for failed). Upon successful
discharge of the given
+ * transaction the remote will respond and the {@link
TransactionController#dischargedHandler(EventHandler)}
* event handler will be signaled.
*
* @param transaction
* The {@link Transaction} that is being discharged.
* @param failed
- * boolean value indicating the the discharge indicates the
transaction failed (rolled back).
+ * boolean value indicating the discharge indicates the transaction
failed (rolled back).
*
* @return this {@link TransactionController}
*/
@@ -214,8 +214,8 @@ public interface TransactionController extends
Endpoint<TransactionController> {
* it will be stored until credit becomes available. Once a handler is
signaled it is no longer retained
* for future updates and the caller will need to register it again once
more transactional work is to be
* completed. Because more than one handler can be added at a time the
caller should check again before
- * attempting to perform a transaction {@link Declared} or {@link
Discharge} is performed as other tasks
- * might have already consumed credit if work is done via some
asynchronous mechanism.
+ * attempting to perform a transaction {@link Declared} or {@link
Discharge} as other tasks might have
+ * already consumed credit if work is done via some asynchronous mechanism.
*
* @param handler
* The {@link EventHandler} that will be signaled once credit is
available for transaction work.
@@ -235,7 +235,7 @@ public interface TransactionController extends
Endpoint<TransactionController> {
* @param handler
* The {@link EventHandler} to notify when this transaction
controller's parent endpoint is locally closed.
*
- * @return the link for chaining.
+ * @return the controller for chaining.
*/
TransactionController
parentEndpointClosedHandler(EventHandler<TransactionController> handler);
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionManager.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionManager.java
index 29626ff5..e844386b 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionManager.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionManager.java
@@ -28,8 +28,8 @@ import
org.apache.qpid.protonj2.types.transport.ErrorCondition;
* Transaction Manager endpoint that implements the mechanics of handling the
declaration
* of and the requested discharge of AMQP transactions. Typically an AMQP
server instance
* will host the transaction management services that are used by client
resources to declare
- * and discharge transaction and handle the associated of deliveries that are
enlisted in
- * active transactions.
+ * and discharge transaction and handle the associated deliveries that are
enlisted in active
+ * transactions.
*/
public interface TransactionManager extends Endpoint<TransactionManager> {
@@ -62,16 +62,16 @@ public interface TransactionManager extends
Endpoint<TransactionManager> {
* Must be called during setup, i.e. before calling the {@link #open()}
method.
*
* @param source
- * The {@link Source} that will be set on the local end of this
transaction controller.
+ * The {@link Source} that will be set on the local end of this
transaction manager.
*
- * @return this transaction controller instance.
+ * @return this transaction manager instance.
*
* @throws IllegalStateException if the {@link TransactionManager} has
already been opened.
*/
TransactionManager setSource(Source source) throws IllegalStateException;
/**
- * @return the {@link Source} for the local end of this {@link
TransactionController}.
+ * @return the {@link Source} for the local end of this {@link
TransactionManager}.
*/
Source getSource();
@@ -81,9 +81,9 @@ public interface TransactionManager extends
Endpoint<TransactionManager> {
* Must be called during setup, i.e. before calling the {@link #open()}
method.
*
* @param coordinator
- * The {@link Coordinator} target that will be set on the local end
of this transaction controller.
+ * The {@link Coordinator} target that will be set on the local end
of this transaction manager.
*
- * @return this transaction controller instance.
+ * @return this transaction manager instance.
*
* @throws IllegalStateException if the {@link TransactionManager} has
already been opened.
*/
@@ -110,7 +110,7 @@ public interface TransactionManager extends
Endpoint<TransactionManager> {
Coordinator getRemoteCoordinator();
/**
- * Respond to a previous {@link Declare} request from the remote {@link
TransactionController}
+ * Respond to a previous {@link Declare} request from the remote {@link
TransactionManager}
* indicating that the requested transaction has been successfully
declared and that deliveries
* can now be enlisted in that transaction.
*
@@ -209,9 +209,9 @@ public interface TransactionManager extends
Endpoint<TransactionManager> {
* doing so is undefined.
*
* @param handler
- * The {@link EventHandler} to notify when this transaction manger's
parent endpoint is locally closed.
+ * The {@link EventHandler} to notify when this transaction manager's
parent endpoint is locally closed.
*
- * @return the link for chaining.
+ * @return the manager for chaining.
*/
TransactionManager
parentEndpointClosedHandler(EventHandler<TransactionManager> handler);
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionState.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionState.java
index 9100f455..37767b22 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionState.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/TransactionState.java
@@ -26,7 +26,7 @@ public enum TransactionState {
/**
* A {@link Transaction} is considered IDLE until the {@link
TransactionManager} responds that
- * it has been declared successfully and an transaction Id has been
assigned.
+ * it has been declared successfully and a transaction Id has been
assigned.
*/
IDLE,
@@ -43,7 +43,7 @@ public enum TransactionState {
DECLARED,
/**
- * A {@link Transaction} is considered to b discharging once a Discharge
command has been sent to the remote
+ * A {@link Transaction} is considered to be discharging once a Discharge
command has been sent to the remote
* but before any response has been received indicating the outcome of the
attempted discharge.
*/
DISCHARGING,
@@ -55,13 +55,13 @@ public enum TransactionState {
DISCHARGED,
/**
- * A {@link Transaction} is considered failed in the {@link
TransactionManager} responds with an error
+ * A {@link Transaction} is considered failed if the {@link
TransactionManager} responds with an error
* to the {@link Declare} action.
*/
DECLARE_FAILED,
/**
- * A {@link Transaction} is considered failed in the {@link
TransactionManager} responds with an error
+ * A {@link Transaction} is considered failed if the {@link
TransactionManager} responds with an error
* to the {@link Discharge} action.
*/
DISCHARGE_FAILED;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineFailedException.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineFailedException.java
index 5c75bb50..32549050 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineFailedException.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineFailedException.java
@@ -17,9 +17,9 @@
package org.apache.qpid.protonj2.engine.exceptions;
/**
- * Thrown from Engine API methods that attempted an operation what would have
+ * Thrown from Engine API methods that attempted an operation that would have
* resulted in a write of data or other state modification after the engine has
- * entered the the failed state.
+ * entered the failed state.
*/
public final class EngineFailedException extends EngineStateException {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineShutdownException.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineShutdownException.java
index fc6a45a0..8ef7e3da 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineShutdownException.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/EngineShutdownException.java
@@ -17,7 +17,7 @@
package org.apache.qpid.protonj2.engine.exceptions;
/**
- * Exception thrown when an option is performed on a closed engine.
+ * Exception thrown when an operation is performed on a closed engine.
*/
public final class EngineShutdownException extends EngineStateException {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/ProtonExceptionSupport.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/ProtonExceptionSupport.java
index 9b08e39b..86352570 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/ProtonExceptionSupport.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/exceptions/ProtonExceptionSupport.java
@@ -19,13 +19,13 @@ package org.apache.qpid.protonj2.engine.exceptions;
public class ProtonExceptionSupport {
/**
- * Checks the given cause to determine if it's already an ProtonException
type and
+ * Checks the given cause to determine if it's already a ProtonException
type and
* if not creates a new ProtonException to wrap it.
*
* @param cause
* The initiating exception that should be cast or wrapped.
*
- * @return an ProtonException instance.
+ * @return a ProtonException instance.
*/
public static EngineFailedException createFailedException(Throwable cause)
{
return createFailedException(null, cause);
@@ -42,7 +42,7 @@ public class ProtonExceptionSupport {
* @param cause
* The initiating exception that should be cast or wrapped.
*
- * @return an ProtonException instance.
+ * @return a ProtonException instance.
*/
public static EngineFailedException createFailedException(String message,
Throwable cause) {
if (cause instanceof EngineFailedException) {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonDeliveryTagGenerator.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonDeliveryTagGenerator.java
index 13aede5d..45a06baa 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonDeliveryTagGenerator.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonDeliveryTagGenerator.java
@@ -32,7 +32,7 @@ public abstract class ProtonDeliveryTagGenerator implements
DeliveryTagGenerator
public enum BUILTIN {
/**
* Provides a {@link DeliveryTagGenerator} that creates tags based on
an incrementing
- * numeric value starting from zero and moving upwards until the value
wraps and continue
+ * numeric value starting from zero and moving upwards until the value
wraps and continues
* back towards zero.
*/
SEQUENTIAL {
@@ -44,7 +44,7 @@ public abstract class ProtonDeliveryTagGenerator implements
DeliveryTagGenerator
},
/**
* Provides a {@link DeliveryTagGenerator} that creates tags based on
a UUID value that
- * will be written as two long value encoded into the delivery tag
bytes.
+ * will be written as two long values encoded into the delivery tag
bytes.
*/
UUID {
@@ -79,9 +79,9 @@ public abstract class ProtonDeliveryTagGenerator implements
DeliveryTagGenerator
}
};
- /**
- * @return a new {@link DeliveryTagGenerator} instance as requested
from the built in types.
- */
+ /**
+ * @return a new {@link DeliveryTagGenerator} instance as requested
from the built in types.
+ */
public abstract DeliveryTagGenerator createGenerator();
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngine.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngine.java
index a4c8a93e..4da1be5d 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngine.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngine.java
@@ -399,7 +399,7 @@ public class ProtonEngine implements Engine {
}
/**
- * Called from the {@link Connection} that is linked to this engine after
is has received a remote
+ * Called from the {@link Connection} that is linked to this engine after
it has received a remote
* Close performative and the connection has configured and updated its
state accordingly.
*
* @param connection
@@ -493,7 +493,7 @@ public class ProtonEngine implements Engine {
Symbol.getSymbol("amqp:resource-limit-exceeded"),
"local-idle-timeout expired");
connection.setCondition(condition);
connection.close();
- engineFailed(new IdleTimeoutException("Remote idle timeout
detected"));
+ engineFailed(new IdleTimeoutException("Local idle timeout
violation detected"));
} else {
localIdleDeadline = computeDeadline(currentTime,
localIdleTimeout);
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngineHandlerContext.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngineHandlerContext.java
index b629a52f..e128615b 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngineHandlerContext.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonEngineHandlerContext.java
@@ -87,7 +87,7 @@ public class ProtonEngineHandlerContext implements
EngineHandlerContext {
}
/**
- * Allows a handler to indicate if it wants to be notified of a Engine
Handler events for
+ * Allows a handler to indicate if it wants to be notified of Engine
Handler events for
* specific operations or opt into all engine handler events. By opting
out of the events
* that the handler does not process the call chain can be reduced when
processing engine
* events.
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameDecodingHandler.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameDecodingHandler.java
index cc1b558c..15b654a5 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameDecodingHandler.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameDecodingHandler.java
@@ -63,7 +63,7 @@ public class ProtonFrameDecodingHandler implements
EngineHandler, SaslPerformati
public static final int FRAME_SIZE_BYTES = 4;
/**
- * Size of the initial portion of an encoded from before any extended
header portion.
+ * Size of the initial portion of an encoded frame before any extended
header portion.
*/
private static final int FRAME_PREAMBLE_BYTES = 8;
@@ -163,11 +163,11 @@ public class ProtonFrameDecodingHandler implements
EngineHandler, SaslPerformati
private interface FrameParserStage {
/**
- * Parse the incoming data and provide events to the parent Transport
+ * Parse the incoming data and provide events to the parent Engine
* based on the contents of that data.
*
* @param context
- * The TransportHandlerContext that applies to the current event
+ * The EngineHandlerContext that applies to the current event
* @param input
* The ProtonBuffer containing new data to be parsed.
*/
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameLoggingHandler.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameLoggingHandler.java
index 6c0ad516..a14bba41 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameLoggingHandler.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonFrameLoggingHandler.java
@@ -72,7 +72,9 @@ public class ProtonFrameLoggingHandler implements
EngineHandler {
trace(envelope.isSaslHeader() ? SASL_IN_PREFIX : AMQP_IN_PREFIX,
uniqueIdentifier, 0, envelope.getBody(), null);
}
- log(envelope.isSaslHeader() ? SASL_IN_PREFIX : AMQP_IN_PREFIX,
uniqueIdentifier, 0, envelope.getBody(), null);
+ if (LOG.isTraceEnabled()) {
+ log(envelope.isSaslHeader() ? SASL_IN_PREFIX : AMQP_IN_PREFIX,
uniqueIdentifier, 0, envelope.getBody(), null);
+ }
context.fireRead(envelope);
}
@@ -83,7 +85,9 @@ public class ProtonFrameLoggingHandler implements
EngineHandler {
trace(SASL_IN_PREFIX, uniqueIdentifier, 0, envelope.getBody(),
null);
}
- log(SASL_IN_PREFIX, uniqueIdentifier, 0, envelope.getBody(),
envelope.getPayload());
+ if (LOG.isTraceEnabled()) {
+ log(SASL_IN_PREFIX, uniqueIdentifier, 0, envelope.getBody(),
envelope.getPayload());
+ }
context.fireRead(envelope);
}
@@ -107,7 +111,9 @@ public class ProtonFrameLoggingHandler implements
EngineHandler {
trace(envelope.isSaslHeader() ? SASL_OUT_PREFIX : AMQP_OUT_PREFIX,
uniqueIdentifier, 0, envelope.getBody(), null);
}
- log(envelope.isSaslHeader() ? SASL_OUT_PREFIX : AMQP_OUT_PREFIX,
uniqueIdentifier, 0, envelope.getBody(), null);
+ if (LOG.isTraceEnabled()) {
+ log(envelope.isSaslHeader() ? SASL_OUT_PREFIX : AMQP_OUT_PREFIX,
uniqueIdentifier, 0, envelope.getBody(), null);
+ }
context.fireWrite(envelope);
}
@@ -131,7 +137,9 @@ public class ProtonFrameLoggingHandler implements
EngineHandler {
trace(SASL_OUT_PREFIX, uniqueIdentifier, 0, envelope.getBody(),
null);
}
- log(SASL_OUT_PREFIX, uniqueIdentifier, 0, envelope.getBody(), null);
+ if (LOG.isTraceEnabled()) {
+ log(SASL_OUT_PREFIX, uniqueIdentifier, 0, envelope.getBody(),
null);
+ }
context.fireWrite(envelope);
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonPooledTagGenerator.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonPooledTagGenerator.java
index f2c245ec..f3b6a63a 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonPooledTagGenerator.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonPooledTagGenerator.java
@@ -26,7 +26,7 @@ import org.apache.qpid.protonj2.types.DeliveryTag;
* pool to reduce GC overhead by reusing tags that have been released from
settled
* messages. When not using cached tags the generator creates new tags using a
* running tag counter of type {@link Long} that assumes that when it wraps
the user
- * has already release all tags within the lower range of the tag counter.
+ * has already released all tags within the lower range of the tag counter.
*/
public class ProtonPooledTagGenerator extends ProtonSequentialTagGenerator {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionIncomingWindow.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionIncomingWindow.java
index c45fc1f2..c21dd082 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionIncomingWindow.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionIncomingWindow.java
@@ -127,6 +127,8 @@ public class ProtonSessionIncomingWindow {
/**
* Update the session window state based on an incoming {@link Transfer}
performative
*
+ * @param link
+ * the link that is handling the passed {@link Transfer}.
* @param transfer
* the incoming {@link Transfer} performative to process.
* @param payload
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionOutgoingWindow.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionOutgoingWindow.java
index 50a6388e..e9d2d329 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionOutgoingWindow.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/ProtonSessionOutgoingWindow.java
@@ -199,10 +199,16 @@ public class ProtonSessionOutgoingWindow {
}
/**
- * Update the session window state based on an incoming {@link Transfer}
performative
+ * Update the session window state based on an outgoing {@link Transfer}
performative.
+ * By default there is no work needed here however a subclass can override
this to add
+ * updates as needed.
*
* @param transfer
- * the incoming {@link Transfer} performative to process.
+ * the outgoing {@link Transfer} performative to process.
+ * @param payload
+ * the payload that will be transmitted in the outgoing
{@link Transfer}
+ *
+ * @return the {@link Transfer} that was passed to this method
*/
Transfer handleTransfer(Transfer transfer, ProtonBuffer payload) {
return transfer;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/sasl/ProtonSaslHandler.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/sasl/ProtonSaslHandler.java
index 0f50d04f..70c4a1ae 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/sasl/ProtonSaslHandler.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/impl/sasl/ProtonSaslHandler.java
@@ -38,7 +38,7 @@ public final class ProtonSaslHandler implements EngineHandler
{
private ProtonSaslContext saslContext;
/**
- * @return true if the SASL exchange has finished (succeed or failed).
+ * @return true if the SASL exchange has finished (succeeded or failed).
*/
public boolean isDone() {
return saslContext != null ? saslContext.isDone() : false;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientContext.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientContext.java
index b5f0b9f6..ef560cfb 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientContext.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslClientContext.java
@@ -26,13 +26,13 @@ import org.apache.qpid.protonj2.types.Symbol;
/**
* SASL Client operating context used by an {@link Engine} that has been
- * configured as a SASL client or that has initialed the SASL exchange by
+ * configured as a SASL client or that has initiated the SASL exchange by
* being the first to initiate the AMQP header exchange.
*/
public interface SaslClientContext extends SaslContext {
/**
- * Sets the {@link SaslClientListener} that will be used to driver the
client side SASL
+ * Sets the {@link SaslClientListener} that will be used to drive the
client side SASL
* negotiations with a connected "server". As the server initiates or
responds to the
* various phases of the SASL negotiation the {@link SaslClientListener}
will be notified
* and allowed to respond.
@@ -53,8 +53,8 @@ public interface SaslClientContext extends SaslContext {
/**
* Sends the AMQP Header indicating the desire for SASL negotiations to be
commenced on
- * this connection. The hosting application my wish to start SASL
negotiations prior to
- * opening a {@link Connection} in order to validation authentication
state out of band
+ * this connection. The hosting application may wish to start SASL
negotiations prior to
+ * opening a {@link Connection} in order to validate authentication state
out of band
* of the normal open process.
*
* @return this client context.
@@ -101,7 +101,7 @@ public interface SaslClientContext extends SaslContext {
/**
* Sends a response to a server side challenge that comprises the
challenge / response
- * exchange for the chosen SASL mechanism. The server may response with
another challenge
+ * exchange for the chosen SASL mechanism. The server may respond with
another challenge
* or complete the SASL exchange by sending an outcome.
*
* @param response
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 5c939365..42b46ced 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
@@ -68,10 +68,9 @@ public interface SaslClientListener {
/**
* Called when a SASL challenge frame has arrived and its effect applied,
indicating the
- * challenge sent by the 'server' peer. The client should respond to the
mechanisms event
- * by selecting one from the offered list and calling the
- * {@link SaslClientContext#sendResponse(ProtonBuffer)} method immediately
or later using the same
- * thread that triggered this event.
+ * challenge sent by the 'server' peer. The client should respond to the
challenge event
+ * by calling {@link SaslClientContext#sendResponse(ProtonBuffer)} method
immediately 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(javax.security.sasl.SaslException)} to fail
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerContext.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerContext.java
index d7022b99..d06c24de 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerContext.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/SaslServerContext.java
@@ -26,13 +26,13 @@ import org.apache.qpid.protonj2.types.Symbols;
/**
* SASL Server operating context used by an {@link Engine} that has been
- * configured as a SASL server or that has receiver an AMQP header thereby
+ * configured as a SASL server or that has received an AMQP header thereby
* forcing it into becoming the server side of the SASL exchange.
*/
public interface SaslServerContext extends SaslContext {
/**
- * Sets the {@link SaslServerListener} that will be used to driver the
server side SASL
+ * Sets the {@link SaslServerListener} that will be used to drive the
server side SASL
* negotiations with a connected "client". As the client initiates or
responds to the
* various phases of the SASL negotiation the {@link SaslServerListener}
will be notified
* and allowed to respond.
@@ -97,12 +97,12 @@ public interface SaslServerContext extends SaslContext {
SaslServerContext sendChallenge(ProtonBuffer challenge) throws
EngineStateException;
/**
- * Sends a response to a server side challenge that comprises the
challenge / response
+ * Sends a response to a server side challenge that comprises the outcome
of the current SASL
* exchange for the chosen SASL mechanism.
* <p>
- * Sending an outcome that indicates SASL does not trigger a failure of
the engine or
- * cause a shutdown, the caller must ensure that after failing the SASL
exchange the
- * engine is shutdown or failed so that event handlers are triggered or
should pro-actively
+ * Sending an outcome that indicates SASL failure does not trigger a
failure of the engine
+ * or cause a shutdown, the caller must ensure that after failing the SASL
exchange the
+ * engine is shut down or failed so that event handlers are triggered or
should pro-actively
* close any I/O channel that was opened. The {@link
#saslFailure(SaslException)} method
* has no effect once this method has been called as SASL negotiations are
considered done
* once an outcome is sent.
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 2e2b29a5..691e3fc5 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(javax.security.sasl.SaslException)} signal
+ * {@link
SaslServerContext#saslFailure(javax.security.sasl.SaslException)} to signal
* the {@link Engine} that it should transition to a failed state.
*
* @param context
@@ -48,7 +48,7 @@ public interface SaslServerListener {
/**
* Called when the SASL header has been received and the server is now
ready to send the configured SASL
- * mechanisms. The handler should respond be calling the {@link
SaslServerContext#sendMechanisms(Symbol[])}
+ * mechanisms. The handler should respond by calling the {@link
SaslServerContext#sendMechanisms(Symbol[])}
* 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
@@ -69,7 +69,7 @@ public interface SaslServerListener {
* Called when a SASL init frame has arrived from the client indicating
the chosen SASL mechanism
* and the initial response data if any. Based on the chosen mechanism
the server handler should provide
* additional challenges or complete the SASL negotiation by sending an
outcome to the client. The handler
- * can either respond immediately or it should response using the same
thread that invoked this handler.
+ * can either respond immediately or it should respond 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(javax.security.sasl.SaslException)} to fail
@@ -89,10 +89,10 @@ public interface SaslServerListener {
void handleSaslInit(SaslServerContext context, Symbol mechanism,
ProtonBuffer initResponse);
/**
- * Called when a SASL response frame has arrived from the client. The
server should process the response
+ * Called when a SASL response frame has arrived from the client. The
server should process the response
* and either offer additional challenges or complete the SASL
negotiations based on the mechanics of the
- * chosen SASL mechanism. The server handler should either respond
immediately or should respond from the
- * same thread that the response handler was invoked from.
+ * chosen SASL mechanism. The server handler should either respond
immediately or respond from the 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(javax.security.sasl.SaslException)} to fail the
SASL negotiation
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/Mechanism.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/Mechanism.java
index 00f0740f..084aeac7 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/Mechanism.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/Mechanism.java
@@ -51,7 +51,7 @@ public interface Mechanism {
* @param credentials
* The credentials that are supplied for this SASL negotiation.
* @param challenge
- * The challenge that this Mechanism should response to.
+ * The challenge that this Mechanism should respond to.
*
* @return the response that answers the given challenge.
*
@@ -61,9 +61,9 @@ public interface Mechanism {
/**
* Verifies that the SASL exchange has completed successfully. This is
- * an opportunity for the mechanism to ensure that all mandatory
- * steps have been completed successfully and to cleanup and resources
- * that are held by this Mechanism.
+ * an opportunity for the mechanism to ensure that all mandatory steps
+ * have been completed successfully and to cleanup any resources that
+ * are held by this Mechanism.
*
* @throws SaslException if the outcome of the SASL exchange is not valid
for this Mechanism
*/
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/OauthBearerMechanism.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/OauthBearerMechanism.java
index 3fefb25f..7e105abe 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/OauthBearerMechanism.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/OauthBearerMechanism.java
@@ -26,9 +26,7 @@ import org.apache.qpid.protonj2.buffer.ProtonBufferAllocator;
import org.apache.qpid.protonj2.types.Symbol;
/**
- * Implements the SASL OAUTHBEARER authentication Mechanism .
- *
- * User name and Password values are sent without being encrypted.
+ * Implements the SASL OAUTHBEARER authentication Mechanism.
*/
public class OauthBearerMechanism extends AbstractMechanism {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/SaslMechanismSelector.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/SaslMechanismSelector.java
index 2a824d7c..be86ea15 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/SaslMechanismSelector.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/SaslMechanismSelector.java
@@ -83,9 +83,9 @@ public class SaslMechanismSelector {
* @param serverMechs
* The list of mechanisms the server indicates it supports.
* @param credentials
- * A {@link SaslCredentialsProvider} used to choose an matching
applicable SASL {@link Mechanism}.
+ * A {@link SaslCredentialsProvider} used to choose a matching
applicable SASL {@link Mechanism}.
*
- * @return a selected SASL {@link Mechanism} instance or null of no match
is possible.
+ * @return a selected SASL {@link Mechanism} instance or null if no match
is possible.
*/
public Mechanism select(Symbol[] serverMechs, SaslCredentialsProvider
credentials) {
Set<Symbol> candidates = new LinkedHashSet<>(serverMechs.length);
@@ -140,11 +140,11 @@ public class SaslMechanismSelector {
* configuration and the provided credentials.
*
* @param candidate
- * The SASL mechanism that matches both the allowed and the server
offered lists.
+ * The candidate SASL mechanism to test for applicability.
* @param credentials
* The provided SASL credentials which will be used when
authenticating with the remote.
*
- * @return true if the candidate {@link Mechanism} is applicable given the
provide credentials.
+ * @return true if the candidate {@link Mechanism} is applicable given the
provided credentials.
*/
protected boolean isApplicable(Mechanism candidate,
SaslCredentialsProvider credentials) {
Objects.requireNonNull(candidate, "Candidate Mechanism to validate
must not be null");
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA1Mechanism.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA1Mechanism.java
index dd2e1e5b..b932c8f9 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA1Mechanism.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA1Mechanism.java
@@ -40,7 +40,6 @@ public class ScramSHA1Mechanism extends
AbstractScramSHAMechanism {
this(UUID.randomUUID().toString());
}
- /** For unit testing */
ScramSHA1Mechanism(String clientNonce) {
super(SHA_1, HMAC_SHA_1, clientNonce);
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA256Mechanism.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA256Mechanism.java
index 20cf995c..d08b4279 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA256Mechanism.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA256Mechanism.java
@@ -40,7 +40,6 @@ public class ScramSHA256Mechanism extends
AbstractScramSHAMechanism {
this(UUID.randomUUID().toString());
}
- /** For unit testing */
ScramSHA256Mechanism(String clientNonce) {
super(SHA_256, HMAC_SHA_256, clientNonce);
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA512Mechanism.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA512Mechanism.java
index e033e66c..33501155 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA512Mechanism.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/ScramSHA512Mechanism.java
@@ -21,7 +21,7 @@ import java.util.UUID;
import org.apache.qpid.protonj2.types.Symbol;
/**
- * Implements the SASL Scram SHA 256 authentication Mechanism.
+ * Implements the SASL Scram SHA 512 authentication Mechanism.
*/
public class ScramSHA512Mechanism extends AbstractScramSHAMechanism {
@@ -40,7 +40,6 @@ public class ScramSHA512Mechanism extends
AbstractScramSHAMechanism {
this(UUID.randomUUID().toString());
}
- /** For unit testing */
ScramSHA512Mechanism(String clientNonce) {
super(SHA_512, HMAC_SHA_512, clientNonce);
}
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/XOauth2Mechanism.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/XOauth2Mechanism.java
index 8cf48cc5..078ca8db 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/XOauth2Mechanism.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/sasl/client/XOauth2Mechanism.java
@@ -26,9 +26,7 @@ import org.apache.qpid.protonj2.buffer.ProtonBufferAllocator;
import org.apache.qpid.protonj2.types.Symbol;
/**
- * Implements the SASL XOAUTH2 authentication Mechanism .
- *
- * User name and Password values are sent without being encrypted.
+ * Implements the SASL XOAUTH2 authentication Mechanism.
*/
public class XOauth2Mechanism extends AbstractMechanism {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/DeliveryIdTracker.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/DeliveryIdTracker.java
index 53ab7709..84b72bcd 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/DeliveryIdTracker.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/DeliveryIdTracker.java
@@ -20,7 +20,7 @@ import org.apache.qpid.protonj2.types.UnsignedInteger;
/**
* Tracker of Delivery ID values, implements a sequence number and provides
ability to
- * keep an not set state for use when allowing for set / not set tracking.
+ * keep a not set state for use when allowing for set / not set tracking.
*/
public class DeliveryIdTracker extends Number implements
Comparable<DeliveryIdTracker> {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/LinkedSplayMap.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/LinkedSplayMap.java
index 69f8dfff..5a76ab35 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/LinkedSplayMap.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/LinkedSplayMap.java
@@ -39,8 +39,8 @@ public class LinkedSplayMap<E> extends SplayMap<E> {
/**
* A dummy entry in the circular linked list of entries in the map.
- * The first real entry is root.next, and the last is header.previous.
- * If the map is empty, root.next == root && root.previous == root.
+ * The first real entry is entries.next, and the last is entries.previous.
+ * If the map is empty, entries.next == entries && entries.previous ==
entries.
*/
private final transient SplayedEntry<E> entries = new SplayedEntry<>();
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/RingQueue.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/RingQueue.java
index efd15cbf..801aeb42 100644
--- a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/RingQueue.java
+++ b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/RingQueue.java
@@ -54,7 +54,7 @@ public class RingQueue<E> extends AbstractQueue<E> {
* given {@link Collection} and filled with the values from that {@link
Collection}.
*
* @param collection
- * the {@link Collection} whose values populates this
{@link RingQueue} instance.
+ * the {@link Collection} whose values populate this
{@link RingQueue} instance.
*/
public RingQueue(Collection<E> collection) {
this.backingArray = new Object[collection.size()];
@@ -98,7 +98,7 @@ public class RingQueue<E> extends AbstractQueue<E> {
* @param createOnEmpty
* a {@link Supplier} which will return default values if the {@link
RingQueue} is empty.
*
- * @return the head element of this queue or a default instance created
from the provided {@link Supplier}/
+ * @return the head element of this queue or a default instance created
from the provided {@link Supplier}
*/
public E poll(Supplier<E> createOnEmpty) {
if (isEmpty()) {
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SequenceNumber.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SequenceNumber.java
index 164334b8..1b17b78a 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SequenceNumber.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/SequenceNumber.java
@@ -46,7 +46,7 @@ public class SequenceNumber extends Number implements
Comparable<SequenceNumber>
}
/**
- * Subtract one to the sequence value.
+ * Subtract one from the sequence value.
*
* @return this sequence.
*/
@@ -65,7 +65,7 @@ public class SequenceNumber extends Number implements
Comparable<SequenceNumber>
}
/**
- * Subtract one to the sequence value.
+ * Subtract one from the sequence value.
*
* @return this sequence value prior to the decrement.
*/
@@ -100,8 +100,8 @@ public class SequenceNumber extends Number implements
Comparable<SequenceNumber>
/**
* Compares the sequence number value to the {@link Number} given. This
method returns 0 if
- * the tracked id is equal to the value provided, value less than 0 if the
tracked id is less
- * than the provided value; and a value greater than 0 if the tracked id
is larger than the value
+ * the sequence number is equal to the value provided, value less than 0
if the tracked value is less
+ * than the provided value; and a value greater than 0 if the tracked
value is larger than the value
* provided.
*
* @param other
@@ -115,12 +115,12 @@ public class SequenceNumber extends Number implements
Comparable<SequenceNumber>
/**
* Compares the sequence number value to the primitive {@link Integer}
given. This method returns
- * 0 if the tracked id is equal to the value provided, value less than 0
if the tracked id is less
- * than the provided value; and a value greater than 0 if the tracked id
is larger than the value
+ * 0 if the tracked value is equal to the value provided, value less than
0 if the tracked value is less
+ * than the provided value; and a value greater than 0 if the tracked
value is larger than the value
* provided.
*
* @param other
- * The {@link Number} to compare the current sequence
number with.
+ * The integer to compare the current sequence number with.
*
* @return the result of comparing the current sequence number to the
provided number.
*/
@@ -142,9 +142,9 @@ public class SequenceNumber extends Number implements
Comparable<SequenceNumber>
* passed.
*
* @param other
- * The value to compare to the currently sequence number.
+ * The value to compare to the current sequence number.
*
- * @return true if the currently sequence value matches the integer value
provided.
+ * @return true if the current sequence value matches the integer value
provided.
*/
public boolean equals(int other) {
return Integer.compareUnsigned(sequence, other) == 0;
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 c9d6ca9b..63c0e43b 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
@@ -44,8 +44,8 @@ import org.apache.qpid.protonj2.types.UnsignedInteger;
*
* The splay tree is a specialized form of a binary search tree that is self
balancing and
* provides faster access in general to frequently used items. The splay tree
serves well
- * as an LRU cache of sorts where 80 percent of the accessed elements comes
from 20 percent
- * of the overall load in the {@link Map}. The best case access time is
generally O(long n)
+ * as an LRU cache of sorts where 80 percent of the accessed elements come
from 20 percent
+ * of the overall load in the {@link Map}. The best case access time is
generally O(log n)
* however it can be Theta(n) in a very worst case scenario.
*
* @param <E> The type stored in the map entries
@@ -84,8 +84,8 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
}
/**
- * Gets the value of the element stored in the {@link Map} with the key
(treated as an
- * unsigned integer for comparison.
+ * Gets the value of the element stored in the {@link Map} using the
passed integer which is
+ * treated as an unsigned integer value.
*
* As a side effect of calling this method the tree that comprises the Map
can be modified
* to bring up the found key or the last accessed key if the key given is
not in the {@link Map}.
@@ -115,7 +115,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
/**
* Gets the value of the element stored in the {@link Map} with the key
(treated as an
- * unsigned integer for comparison.
+ * unsigned integer for comparison).
*
* As a side effect of calling this method the tree that comprises the Map
can be modified
* to bring up the found key or the last accessed key if the key given is
not in the {@link Map}.
@@ -127,7 +127,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
* @param defaultValue
* the default value to return if the key is not stored in this
{@link Map}.
*
- * @return the value stored for the given key if found the default value
if not in the {@link Map}.
+ * @return the value stored for the given key if found, or the default
value if not in the {@link Map}.
*/
public E getOrDefault(int key, E defaultValue) {
E result = get(key);
@@ -139,8 +139,8 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
}
/**
- * Puts the value into the in the {@link Map} at the entry specified by
the given key (treated as an
- * unsigned integer for comparison.
+ * Puts the value into the {@link Map} at the entry specified by the given
key (treated as an
+ * unsigned integer for comparison).
*
* As a side effect of calling this method the tree that comprises the Map
can be modified
* to bring up the found key or the last accessed key if the key given is
not in the {@link Map}.
@@ -148,7 +148,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
* immediately without modifying the {@link Map}.
*
* @param key
- * the integer key value to search for and or insert in the {@link
SplayMap}.
+ * the integer key value to search for and insert in the {@link
SplayMap}.
* @param value
* the value to assign to the entry accessed via the given key.
*
@@ -194,7 +194,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
* immediately without modifying the {@link Map}.
*
* @param key
- * the integer key value to search for and or insert in the {@link
SplayMap}.
+ * the integer key value to search for and possibly insert in the
{@link SplayMap}.
* @param value
* the value to assign to the entry accessed via the given key.
*
@@ -264,11 +264,11 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
/**
* Removes the mapping for the primitive <code>int</code> key from this
map if it is present
* and returns the value to which this map previously associated the key,
or null if the
- * map contained no mapping for the key. The integer value is treated as
an unsigned int
+ * map contained no mapping for the key. The integer value is treated as
an unsigned integer
* internally.
*
* @param key
- * The {@link UnsignedInteger} key whose value will be
removed from the {@link SplayMap}.
+ * The integer key whose value will be removed from the
{@link SplayMap}.
*
* @return the value that was removed if one was present in the {@link
Map}.
*/
@@ -524,11 +524,11 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
* currently mapped to the specified value in the {@link Map} with the new
value provided.
*
* @param key
- * The key whose value will be removed if matched.
+ * The key whose value will be replaced if matched.
* @param oldValue
* The old value that must be contained in the mapping for
the replace to be performed.
* @param newValue
- * The value that will replace the old value mapped to the
given key if one existed..
+ * The value that will replace the old value mapped to the
given key if one existed.
*
* @return <code>true</code> if an entry was replaced in the {@link Map}
*/
@@ -548,13 +548,13 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
}
/**
- * Replaces the entry for the specified primitive int (treated as
unsigned) key only if it is
- * currently mapped to the a value in the {@link Map} with the new value
provided.
+ * Replaces the entry for the specified primitive integer (treated as
unsigned) key only if it is
+ * currently mapped to a value in the {@link Map} with the new value
provided.
*
* @param key
- * The key whose value will be removed if matched.
+ * The key whose value will be replaced if matched.
* @param value
- * The value that will replace the old value mapped to the
given key if one existed..
+ * The value that will replace the old value mapped to the
given key if one existed.
*
* @return <code>true</code> if an entry was replaced in the {@link Map}
*/
@@ -1513,7 +1513,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
* @param key
* The key whose floor entry match is being queried.
*
- * @return the entry or next lowest entry or null if no keys less then or
equal to the given value.
+ * @return the entry or next lowest entry or null if no keys less than or
equal to the given value.
*/
private SplayedEntry<E> splayToFloorEntry(int key) {
root = splay(root, key);
@@ -2174,7 +2174,7 @@ public class SplayMap<E> implements
NavigableMap<UnsignedInteger, E> {
//----- Sub Map collection types
/**
- * Specialized iterator for the sub-map type that iterators on a
generic type
+ * Specialized iterator for the sub-map type that iterates on a
generic type
* but internally contains splayed entries from the splay map tree.
*
* @param <T> The value type that is returned from this iterator.
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/StringUtils.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/StringUtils.java
index e2b58b7e..9c352821 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/StringUtils.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/StringUtils.java
@@ -86,7 +86,7 @@ public class StringUtils {
* @param symbolArray
* The given Symbol[] to convert.
*
- * @return a new String array that contains String versions of the input
Symbol.
+ * @return a new String array that contains String versions of the input
Symbols.
*/
public static String[] toStringArray(Symbol[] symbolArray) {
String[] result = null;
@@ -152,7 +152,7 @@ public class StringUtils {
* Converts the given Symbol keyed {@link Map} into a matching String
keyed {@link Map}.
*
* @param symbolMap
- * The given String keyed {@link Map} to convert.
+ * The given Symbol keyed {@link Map} to convert.
*
* @return a new String keyed {@link Map} that contains String versions of
the input Symbol keys.
*/
@@ -177,7 +177,7 @@ public class StringUtils {
* @param stringsSet
* The given String {@link Collection} to convert.
*
- * @return a new Symbol array that contains String versions of the input
Symbols.
+ * @return a new Symbol array that contains Symbol versions of the input
strings.
*/
public static Symbol[] toSymbolArray(Collection<String> stringsSet) {
final Symbol[] result;
@@ -201,7 +201,7 @@ public class StringUtils {
* @param stringsSet
* The given String {@link Collection} to convert.
*
- * @return a new Symbol array that contains String versions of the input
Symbols.
+ * @return a new Symbol array that contains Symbol versions of the input
strings.
*/
public static Symbol[] toSASLSymbolArray(Collection<String> stringsSet) {
final Symbol[] result;
@@ -225,7 +225,7 @@ public class StringUtils {
* @param stringsSet
* The given String {@link Collection} to convert.
*
- * @return a new Symbol {@link Set} that contains String versions of the
input Symbols.
+ * @return a new Symbol {@link Set} that contains Symbol versions of the
input strings.
*/
public static Set<Symbol> toSymbolSet(Collection<String> stringsSet) {
final Set<Symbol> result;
@@ -248,7 +248,7 @@ public class StringUtils {
* @param stringsSet
* The given String {@link Collection} to convert.
*
- * @return a new Symbol {@link Set} that contains String versions of the
input Symbols.
+ * @return a new Symbol {@link Set} that contains Symbol versions of the
input strings.
*/
public static Set<Symbol> toSASLSymbolSet(Collection<String> stringsSet) {
final Set<Symbol> result;
diff --git
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/UnsettledMap.java
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/UnsettledMap.java
index 12492096..533c09b6 100644
---
a/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/UnsettledMap.java
+++
b/protonj2/src/main/java/org/apache/qpid/protonj2/engine/util/UnsettledMap.java
@@ -39,12 +39,12 @@ import org.apache.qpid.protonj2.types.UnsignedInteger;
* <p>
* While this class implements the {@link Map} interface it does not fully
behave
* as a standard map as it solves the issue of tracking delivery IDs which
always
- * increase until such time as the unsigned integer value used to represents
them
+ * increase until such time as the unsigned integer value used to represent
them
* overflows. It is possible (although unlikely) for the same ID to exist for
multiple
* deliveries if an older delivery exists in the Map and the delivery IDs
overflow and
* the same value is produced once again.
*
- * @param <Delivery> The delivery type being tracker (incoming or outgoing)
+ * @param <Delivery> The delivery type being tracked (incoming or outgoing)
*/
public class UnsettledMap<Delivery> implements Map<UnsignedInteger, Delivery> {
@@ -278,7 +278,7 @@ public class UnsettledMap<Delivery> implements
Map<UnsignedInteger, Delivery> {
/**
* Visits each entry within the given range and invokes the provided
action on
* each delivery in the tracker. The lower and upper bounds are limits
which are
- * not exclusive meaning entries within this range are visited regards of
there
+ * not exclusive meaning entries within this range are visited regardless
of their
* being an exact match on the lower and upper boundaries.
*
* @param first
@@ -971,7 +971,7 @@ public class UnsettledMap<Delivery> implements
Map<UnsignedInteger, Delivery> {
/**
* Checks if the given range of delivery IDs potentially captures any
entries in
- * this bucket by checking if the the opposing ends of the ranges
overlap.
+ * this bucket by checking if the opposing ends of the ranges overlap.
*
* @param lowest
* The lowest value that is being searched for.
@@ -1088,7 +1088,7 @@ public class UnsettledMap<Delivery> implements
Map<UnsignedInteger, Delivery> {
* The target delivery ID to find in the set of tracked
deliveries.
*
* @return the index in the deliveries array where the found delivery
lives, or the insertion point as
- * a negative value (e.g. -(index - 1).
+ * a negative value e.g. -(index - 1).
*/
public int search(int deliveryId) {
if (deliveryIds[readOffset] == deliveryId) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
