You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2021/04/23 21:31:42 UTC
[qpid-protonj2] 01/02: Adds more javadocs to the client APIs and
hides some constructors
This is an automated email from the ASF dual-hosted git repository.
tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git
commit 08f9c871acdcd1844f31509ea1518d4367b71635
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Fri Apr 23 17:24:15 2021 -0400
Adds more javadocs to the client APIs and hides some constructors
Further document client level APIs and internal public methods to aid in
use. Hides some constructors as package level scoped to protect them
from outsiders using them in breaking ways.
---
.../apache/qpid/protonj2/client/ClientOptions.java | 9 ++++
.../qpid/protonj2/client/ConnectionOptions.java | 3 ++
.../apache/qpid/protonj2/client/DeliveryState.java | 53 ++++++++++++++++++++++
.../qpid/protonj2/client/ReceiverOptions.java | 9 ++++
.../qpid/protonj2/client/ReconnectOptions.java | 2 +-
.../apache/qpid/protonj2/client/SaslOptions.java | 6 +++
.../apache/qpid/protonj2/client/SenderOptions.java | 9 ++++
.../qpid/protonj2/client/SessionOptions.java | 9 ++++
.../apache/qpid/protonj2/client/SourceOptions.java | 9 ++++
.../apache/qpid/protonj2/client/SslOptions.java | 11 +++++
.../qpid/protonj2/client/TransportOptions.java | 52 +++++++++++++++++++--
.../client/futures/BalancedClientFuture.java | 9 ++++
.../qpid/protonj2/client/futures/ClientFuture.java | 6 +++
.../client/futures/ClientFutureFactory.java | 22 +++++++++
.../client/futures/ClientSynchronization.java | 12 +++++
.../client/futures/ConservativeClientFuture.java | 9 ++++
.../protonj2/client/futures/NoOpAsyncResult.java | 3 ++
.../client/futures/ProgressiveClientFuture.java | 9 ++++
.../client/impl/ClientConnectionCapabilities.java | 5 +-
.../protonj2/client/impl/ClientErrorCondition.java | 16 +++++++
.../client/impl/ClientExceptionSupport.java | 2 +-
.../qpid/protonj2/client/impl/ClientInstance.java | 9 ++++
.../client/impl/ClientLocalTransactionContext.java | 2 +-
.../qpid/protonj2/client/impl/ClientMessage.java | 7 +++
.../client/impl/ClientNoOpStreamTracker.java | 2 +-
.../protonj2/client/impl/ClientNoOpTracker.java | 2 +-
.../client/impl/ClientOutgoingEnvelope.java | 4 +-
.../qpid/protonj2/client/impl/ClientReceiver.java | 5 +-
.../client/impl/ClientReceiverBuilder.java | 2 +-
.../qpid/protonj2/client/impl/ClientRedirect.java | 2 +-
.../qpid/protonj2/client/impl/ClientSender.java | 2 +-
.../protonj2/client/impl/ClientSenderBuilder.java | 2 +-
.../qpid/protonj2/client/impl/ClientSession.java | 2 +-
.../protonj2/client/impl/ClientSessionBuilder.java | 2 +-
.../protonj2/client/impl/ClientStreamDelivery.java | 6 ++-
.../protonj2/client/impl/ClientStreamReceiver.java | 5 +-
.../protonj2/client/impl/ClientStreamSender.java | 5 +-
.../protonj2/client/impl/ClientStreamSession.java | 2 +-
.../protonj2/client/impl/ClientStreamTracker.java | 2 +-
.../client/impl/ClientTransportListener.java | 2 +-
.../protonj2/client/util/FifoDeliveryQueue.java | 6 +++
.../qpid/protonj2/client/util/IdGenerator.java | 3 ++
.../qpid/protonj2/client/util/ThreadPoolUtils.java | 3 ++
43 files changed, 317 insertions(+), 25 deletions(-)
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ClientOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ClientOptions.java
index d9a2435..6c612c2 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ClientOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ClientOptions.java
@@ -24,8 +24,17 @@ public class ClientOptions {
private String id;
private String futureType;
+ /**
+ * Create a new ClientOptions instance with defaults set for all options.
+ */
public ClientOptions() {}
+ /**
+ * Create a new ClientOptions instance that copies the configuration from the specified source options.
+ *
+ * @param options
+ * The ClientOptions instance whose settings are to be copied into this one.
+ */
public ClientOptions(ClientOptions options) {
if (options != null) {
options.copyInto(this);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
index d444894..7f1750e 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ConnectionOptions.java
@@ -30,6 +30,9 @@ import org.apache.qpid.protonj2.types.transport.Open;
*/
public class ConnectionOptions {
+ /**
+ * Default value for the AMQP desired capabilities set in the Open frame.
+ */
public static final String[] DEFAULT_DESIRED_CAPABILITIES = new String[] { "ANONYMOUS-RELAY" };
public static final long INFINITE = -1;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/DeliveryState.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/DeliveryState.java
index d7e86b1..c7fe276 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/DeliveryState.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/DeliveryState.java
@@ -36,6 +36,9 @@ public interface DeliveryState {
TRANSACTIONAL
}
+ /**
+ * @return the type that the given {@link DeliveryState} represents.
+ */
Type getType();
/**
@@ -47,26 +50,76 @@ public interface DeliveryState {
//----- Factory methods for default DeliveryState types
+ /**
+ * @return an instance of an AMQP Accepted delivery outcome.
+ */
static DeliveryState accepted() {
return ClientAccepted.getInstance();
}
+ /**
+ * @return an instance of an AMQP Released delivery outcome.
+ */
static DeliveryState released() {
return ClientReleased.getInstance();
}
+ /**
+ * Create a new Rejected outcome with the given condition and description.
+ *
+ * @param condition
+ * the condition that lead to the rejected outcome.
+ * @param description
+ * a meaningful description of the reason for the rejection.
+ *
+ * @return an instance of an AMQP Rejected delivery outcome.
+ */
static DeliveryState rejected(String condition, String description) {
return new ClientRejected(condition, description);
}
+ /**
+ * Create a new Rejected outcome with the given condition and description.
+ *
+ * @param condition
+ * the condition that lead to the rejected outcome.
+ * @param description
+ * a meaningful description of the reason for the rejection.
+ * @param info
+ * a {@link Map} containing additional information about the rejection.
+ *
+ * @return an instance of an AMQP Rejected delivery outcome.
+ */
static DeliveryState rejected(String condition, String description, Map<String, Object> info) {
return new ClientRejected(condition, description, info);
}
+ /**
+ * Create a new Modified outcome with the given failure state.
+ *
+ * @param failed
+ * boolean indicating if delivery failed or not.
+ * @param undeliverable
+ * boolean indicating if the delivery cannot be sent to this receiver again.
+ *
+ * @return an instance of an AMQP Modified delivery outcome.
+ */
static DeliveryState modified(boolean failed, boolean undeliverable) {
return new ClientModified(failed, undeliverable);
}
+ /**
+ * Create a new Modified outcome with the given failure state.
+ *
+ * @param failed
+ * boolean indicating if delivery failed or not.
+ * @param undeliverable
+ * boolean indicating if the delivery cannot be sent to this receiver again.
+ * @param annotations
+ * updated annotation for the delivery that this outcome applies to.
+ *
+ * @return an instance of an AMQP Modified delivery outcome.
+ */
static DeliveryState modified(boolean failed, boolean undeliverable, Map<String, Object> annotations) {
return new ClientModified(failed, undeliverable, annotations);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReceiverOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReceiverOptions.java
index 71cfdcd..d284f45 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReceiverOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReceiverOptions.java
@@ -45,9 +45,18 @@ public class ReceiverOptions {
private String[] desiredCapabilities;
private Map<String, Object> properties;
+ /**
+ * Create a new ReceiverOptions instance with defaults set for all options.
+ */
public ReceiverOptions() {
}
+ /**
+ * Create a new ReceiverOptions instance that copies the configuration from the specified source options.
+ *
+ * @param options
+ * The ReceiverOptions instance whose settings are to be copied into this one.
+ */
public ReceiverOptions(ReceiverOptions options) {
if (options != null) {
options.copyInto(this);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java
index fcb0af2..af8e9a7 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java
@@ -47,7 +47,7 @@ public class ReconnectOptions {
private double reconnectBackOffMultiplier = DEFAULT_RECONNECT_BACKOFF_MULTIPLIER;
/**
- * Create a new {@link ConnectionOptions} instance configured with default configuration settings.
+ * Create a new {@link ReconnectOptions} instance configured with default configuration settings.
*/
public ReconnectOptions() {
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SaslOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SaslOptions.java
index 3dfb55c..95b9fc6 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SaslOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SaslOptions.java
@@ -26,11 +26,17 @@ import java.util.Set;
*/
public class SaslOptions {
+ /**
+ * The client default configuration value for SASL enabled state (default is true)
+ */
public static final boolean DEFAULT_SASL_ENABLED = true;
private boolean saslEnabled = DEFAULT_SASL_ENABLED;
private final Set<String> saslAllowedMechs = new LinkedHashSet<>();
+ /**
+ * Create a new {@link SaslOptions} instance configured with default configuration settings.
+ */
public SaslOptions() {
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SenderOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SenderOptions.java
index d862a37..19e2d1d 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SenderOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SenderOptions.java
@@ -44,9 +44,18 @@ public class SenderOptions {
private String[] desiredCapabilities;
private Map<String, Object> properties;
+ /**
+ * Create a new {@link SenderOptions} instance configured with default configuration settings.
+ */
public SenderOptions() {
}
+ /**
+ * Create a new SenderOptions instance that copies the configuration from the specified source options.
+ *
+ * @param options
+ * The SenderOptions instance whose settings are to be copied into this one.
+ */
public SenderOptions(SenderOptions options) {
if (options != null) {
options.copyInto(this);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java
index 47c1798..bab793f 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java
@@ -44,9 +44,18 @@ public class SessionOptions {
private String[] desiredCapabilities;
private Map<String, Object> properties;
+ /**
+ * Create a new {@link SessionOptions} instance configured with default configuration settings.
+ */
public SessionOptions() {
}
+ /**
+ * Create a new SessionOptions instance that copies the configuration from the specified source options.
+ *
+ * @param options
+ * The SessionOptions instance whose settings are to be copied into this one.
+ */
public SessionOptions(SessionOptions options) {
if (options != null) {
options.copyInto(this);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SourceOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SourceOptions.java
index ddd81fd..e96a337 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SourceOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SourceOptions.java
@@ -43,6 +43,15 @@ public final class SourceOptions extends TerminusOptions<SourceOptions> {
return copyInto(new SourceOptions());
}
+ /**
+ * Copy all options from this {@link SourceOptions} instance into the instance
+ * provided.
+ *
+ * @param other
+ * the target of this copy operation.
+ *
+ * @return this {@link SourceOptions} instance.
+ */
public SourceOptions copyInto(SourceOptions other) {
super.copyInto(other);
other.distributionMode(distributionMode);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SslOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SslOptions.java
index 4391d1c..dedef84 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SslOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SslOptions.java
@@ -76,10 +76,21 @@ public class SslOptions implements Cloneable {
return copyInto(new SslOptions());
}
+ /**
+ * @return true if the client transport will attempt to connect with SSL
+ */
public boolean sslEnabled() {
return sslEnabled;
}
+ /**
+ * Enable or disable the transport level SSL encryption layer.
+ *
+ * @param enable
+ * boolean that controls if SSL is enabled or disabled.
+ *
+ * @return this {@link SslOptions} instance.
+ */
public SslOptions sslEnabled(boolean enable) {
this.sslEnabled = enable;
return this;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TransportOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TransportOptions.java
index e3f515b..c911f87 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TransportOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/TransportOptions.java
@@ -146,15 +146,29 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level soTimeout option.
+ */
public int soTimeout() {
return soTimeout;
}
+ /**
+ * Sets the value to use when configuring the socket level soTimeout option.
+ *
+ * @param soTimeout
+ * the soTimeout value to configure on the newly create socket.
+ *
+ * @return this {@link TransportOptions} instance.
+ */
public TransportOptions soTimeout(int soTimeout) {
this.soTimeout = soTimeout;
return this;
}
+ /**
+ * @return the configured value for the socket level tcpNoDelay option.
+ */
public boolean tcpNoDelay() {
return tcpNoDelay;
}
@@ -164,6 +178,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level soLinger option.
+ */
public int soLinger() {
return soLinger;
}
@@ -173,6 +190,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level tcpKeepAlive option.
+ */
public boolean tcpKeepAlive() {
return tcpKeepAlive;
}
@@ -182,6 +202,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level connection timeout option.
+ */
public int connectTimeout() {
return connectTimeout;
}
@@ -191,6 +214,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level default port to use for connection if none is provided.
+ */
public int defaultTcpPort() {
return defaultTcpPort;
}
@@ -200,6 +226,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level localAddress option.
+ */
public String localAddress() {
return localAddress;
}
@@ -209,6 +238,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level localPort option.
+ */
public int localPort() {
return localPort;
}
@@ -276,6 +308,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured state of WebSockets for client connections.
+ */
public boolean useWebSockets() {
return useWebSockets;
}
@@ -285,6 +320,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level WebSocket path option.
+ */
public String webSocketPath() {
return webSocketPath;
}
@@ -294,6 +332,9 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level WebSocket Headers option.
+ */
public Map<String, String> webSocketHeaders() {
return webSocketHeaders;
}
@@ -303,15 +344,18 @@ public class TransportOptions implements Cloneable {
return this;
}
+ /**
+ * @return the configured value for the socket level WebSocket max frame size option.
+ */
+ public int webSocketMaxFrameSize() {
+ return webSocketMaxFrameSize;
+ }
+
public TransportOptions webSocketMaxFrameSize(int maxFrameSize) {
this.webSocketMaxFrameSize = maxFrameSize;
return this;
}
- public int webSocketMaxFrameSize() {
- return webSocketMaxFrameSize;
- }
-
/**
* Copy all configuration into the given {@link TransportOptions} from this instance.
*
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/BalancedClientFuture.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/BalancedClientFuture.java
index b35632b..c6f8185 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/BalancedClientFuture.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/BalancedClientFuture.java
@@ -34,10 +34,19 @@ public class BalancedClientFuture<V> extends ClientFuture<V> {
private static final int SPIN_COUNT = 10;
private static final int YIELD_COUNT = 100;
+ /**
+ * Create a new {@link BalancedClientFuture} instance with no assigned {@link ClientSynchronization}.
+ */
public BalancedClientFuture() {
this(null);
}
+ /**
+ * Create a new {@link BalancedClientFuture} instance with the assigned {@link ClientSynchronization}.
+ *
+ * @param synchronization
+ * the {@link ClientSynchronization} that should be notified upon completion of this future.
+ */
public BalancedClientFuture(ClientSynchronization<V> synchronization) {
super(synchronization);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFuture.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFuture.java
index 8a9eef9..4a0127a 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFuture.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFuture.java
@@ -71,10 +71,16 @@ public abstract class ClientFuture<V> implements Future<V>, AsyncResult<V> {
}
}
+ /**
+ * @return true if the {@link Future} operation failed.
+ */
public boolean isFailed() {
return error != null;
}
+ /**
+ * @return the resulting value of the operation upon successful compeletion.
+ */
public V getResult() {
return result;
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFutureFactory.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFutureFactory.java
index 5709ccd..4ef8eb0 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFutureFactory.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientFutureFactory.java
@@ -30,8 +30,19 @@ public abstract class ClientFutureFactory {
private static final String WINDOWS_OS_PREFIX = "Windows";
private static final boolean IS_WINDOWS = isOsNameMatch(OS_NAME, WINDOWS_OS_PREFIX);
+ /**
+ * Names a future type that uses a conservative wait for the operation outcome.
+ */
public static final String CONSERVATIVE = "conservative";
+
+ /**
+ * Names a future type that uses a balanced spin then wait for the operation outcome.
+ */
public static final String BALANCED = "balanced";
+
+ /**
+ * Names a future type that uses a progressive spin then wait for the operation outcome.
+ */
public static final String PROGRESSIVE = "progressive";
/**
@@ -66,6 +77,17 @@ public abstract class ClientFutureFactory {
}
}
+ /**
+ * Creates and returns a {@link Future} type that is already marked completed and will
+ * return the provided result to any caller that requests the future's outcome.
+ *
+ * @param <T> The type that will result from the {@link Future}.
+ *
+ * @param result
+ * The value to return as the result of this completed {@link Future}.
+ *
+ * @return the newly created completed {@link Future} instance.
+ */
public static <T> Future<T> completedFuture(T result) {
BalancedClientFuture<T> future = new BalancedClientFuture<>();
future.complete(result);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientSynchronization.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientSynchronization.java
index d458946..0bbe74b 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientSynchronization.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ClientSynchronization.java
@@ -25,8 +25,20 @@ package org.apache.qpid.protonj2.client.futures;
*/
public interface ClientSynchronization<V> {
+ /**
+ * Event point used to signal that this future will complete successfully.
+ *
+ * @param result
+ * The result that will be returned on completion of this future.
+ */
void onPendingSuccess(V result);
+ /**
+ * Event point used to signal that this future will complete with a failure outcome.
+ *
+ * @param cause
+ * The error that triggered the failure of this future.
+ */
void onPendingFailure(Throwable cause);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ConservativeClientFuture.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ConservativeClientFuture.java
index 4384f85..8c9def8 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ConservativeClientFuture.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ConservativeClientFuture.java
@@ -30,10 +30,19 @@ import java.util.concurrent.TimeoutException;
*/
public class ConservativeClientFuture<V> extends ClientFuture<V> {
+ /**
+ * Create a new {@link ConservativeClientFuture} instance with no assigned {@link ClientSynchronization}.
+ */
public ConservativeClientFuture() {
this(null);
}
+ /**
+ * Create a new {@link ConservativeClientFuture} instance with the assigned {@link ClientSynchronization}.
+ *
+ * @param synchronization
+ * the {@link ClientSynchronization} that should be notified upon completion of this future.
+ */
public ConservativeClientFuture(ClientSynchronization<V> synchronization) {
super(synchronization);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/NoOpAsyncResult.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/NoOpAsyncResult.java
index 642c357..1a1aa51 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/NoOpAsyncResult.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/NoOpAsyncResult.java
@@ -23,6 +23,9 @@ import org.apache.qpid.protonj2.client.exceptions.ClientException;
*/
public class NoOpAsyncResult implements AsyncResult<Void> {
+ /**
+ * A singleton instance of the NoOpAsyncResult for use in client operation.
+ */
public final static NoOpAsyncResult INSTANCE = new NoOpAsyncResult();
@Override
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ProgressiveClientFuture.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ProgressiveClientFuture.java
index e11c763..df33ca8 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ProgressiveClientFuture.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/futures/ProgressiveClientFuture.java
@@ -38,10 +38,19 @@ public class ProgressiveClientFuture<V> extends ClientFuture<V> {
private static final int SMALL_PARK_COUNT = 101_000;
private static final int SMALL_PARK_NANOS = 10_000;
+ /**
+ * Create a new {@link ProgressiveClientFuture} instance with no assigned {@link ClientSynchronization}.
+ */
public ProgressiveClientFuture() {
this(null);
}
+ /**
+ * Create a new {@link ProgressiveClientFuture} instance with the assigned {@link ClientSynchronization}.
+ *
+ * @param synchronization
+ * the {@link ClientSynchronization} that should be notified upon completion of this future.
+ */
public ProgressiveClientFuture(ClientSynchronization<V> synchronization) {
super(synchronization);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientConnectionCapabilities.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientConnectionCapabilities.java
index e3bb624..3570edb 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientConnectionCapabilities.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientConnectionCapabilities.java
@@ -33,12 +33,15 @@ public class ClientConnectionCapabilities {
private boolean delayedDeliverySupported;
/**
- * @return true this the client requested and the remote answered that anonymous relay is supported.
+ * @return true if the remote indicated that it supports anonymous relay links.
*/
public boolean anonymousRelaySupported() {
return this.anonymousRelaySupported;
}
+ /**
+ * @return true if the remote indicated that it supports delivery delay annotations from client messages.
+ */
public boolean deliveryDelaySupported() {
return this.delayedDeliverySupported;
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
index 24ad8d9..285494b 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientErrorCondition.java
@@ -31,6 +31,12 @@ public final class ClientErrorCondition implements ErrorCondition {
private final org.apache.qpid.protonj2.types.transport.ErrorCondition error;
+ /**
+ * Create a new {@link ClientErrorCondition} that is a copy of the provided instance.
+ *
+ * @param condition
+ * The {@link ErrorCondition} whose information should be copied to the new value.
+ */
public ClientErrorCondition(ErrorCondition condition) {
Objects.requireNonNull(condition, "The error condition value cannot be null");
@@ -38,6 +44,16 @@ public final class ClientErrorCondition implements ErrorCondition {
Symbol.valueOf(condition.condition()), condition.description(), ClientConversionSupport.toSymbolKeyedMap(condition.info()));
}
+ /**
+ * Create a new {@link ClientErrorCondition} instance with the given error information
+ *
+ * @param condition
+ * The condition value that defines the error type.
+ * @param description
+ * A meaningful description of the error.
+ * @param info
+ * Any additional information that must accompany the error.
+ */
public ClientErrorCondition(String condition, String description, Map<String, Object> info) {
Objects.requireNonNull(condition, "The error condition value cannot be null");
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientExceptionSupport.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientExceptionSupport.java
index aa48e11..9608e8a 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientExceptionSupport.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientExceptionSupport.java
@@ -42,7 +42,7 @@ import org.apache.qpid.protonj2.types.transport.ConnectionError;
import org.apache.qpid.protonj2.types.transport.ErrorCondition;
import org.apache.qpid.protonj2.types.transport.LinkError;
-public class ClientExceptionSupport {
+class ClientExceptionSupport {
/**
* Checks the given cause to determine if it's already an ProviderIOException type and
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientInstance.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientInstance.java
index 3688d82..3597296 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientInstance.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientInstance.java
@@ -57,10 +57,19 @@ public final class ClientInstance implements Client {
private volatile boolean closed;
+ /**
+ * @return a newly create {@link ClientInstance} that uses default configuration.
+ */
public static ClientInstance create() {
return new ClientInstance(new ClientOptions());
}
+ /**
+ * @param options
+ * The configuration options to apply to the newly create {@link ClientInstance}.
+ *
+ * @return a newly create {@link ClientInstance} that uses the configuration provided.
+ */
public static ClientInstance create(ClientOptions options) {
Objects.requireNonNull(options, "Client options must be non-null");
Objects.requireNonNull(options.id(), "User supplied container Id must be non-null");
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientLocalTransactionContext.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientLocalTransactionContext.java
index 3b2a8de..a68d253 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientLocalTransactionContext.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientLocalTransactionContext.java
@@ -73,7 +73,7 @@ final class ClientLocalTransactionContext implements ClientTransactionContext {
private TransactionalState cachedSenderOutcome;
private TransactionalState cachedReceiverOutcome;
- public ClientLocalTransactionContext(ClientSession session) {
+ ClientLocalTransactionContext(ClientSession session) {
this.session = session;
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientMessage.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientMessage.java
index c3dafcb..cd51185 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientMessage.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientMessage.java
@@ -42,6 +42,13 @@ import org.apache.qpid.protonj2.types.messaging.Properties;
import org.apache.qpid.protonj2.types.messaging.Section;
import org.apache.qpid.protonj2.types.messaging.Section.SectionType;
+/**
+ * Client provided {@link AdvancedMessage} implementation that is used when sending messages
+ * from a {@link ClientSender} or when decoding an AMQP Transfer for which all frames have
+ * arrived.
+ *
+ * @param <E> the body type that the {@link Message} carries
+ */
public class ClientMessage<E> implements AdvancedMessage<E> {
private Header header;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpStreamTracker.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpStreamTracker.java
index 29975ca..28151f5 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpStreamTracker.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpStreamTracker.java
@@ -29,7 +29,7 @@ import org.apache.qpid.protonj2.client.exceptions.ClientException;
*/
public class ClientNoOpStreamTracker extends ClientNoOpTracker implements StreamTracker {
- public ClientNoOpStreamTracker(ClientStreamSender sender) {
+ ClientNoOpStreamTracker(ClientStreamSender sender) {
super(sender);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpTracker.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpTracker.java
index b35060e..0d942ed 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpTracker.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientNoOpTracker.java
@@ -36,7 +36,7 @@ public class ClientNoOpTracker implements Tracker {
private DeliveryState state;
private boolean settled;
- public ClientNoOpTracker(ClientSender sender) {
+ ClientNoOpTracker(ClientSender sender) {
this.sender = sender;
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientOutgoingEnvelope.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientOutgoingEnvelope.java
index 5d4a95c..a66e528 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientOutgoingEnvelope.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientOutgoingEnvelope.java
@@ -57,7 +57,7 @@ public class ClientOutgoingEnvelope {
* @param request
* The requesting operation that initiated this send.
*/
- public ClientOutgoingEnvelope(ClientSender sender, int messageFormat, ProtonBuffer payload, ClientFuture<Tracker> request) {
+ ClientOutgoingEnvelope(ClientSender sender, int messageFormat, ProtonBuffer payload, ClientFuture<Tracker> request) {
this.messageFormat = messageFormat;
this.payload = payload;
this.request = request;
@@ -79,7 +79,7 @@ public class ClientOutgoingEnvelope {
* @param request
* The requesting operation that initiated this send.
*/
- public ClientOutgoingEnvelope(ClientSender sender, int messageFormat, ProtonBuffer payload, boolean complete, ClientFuture<Tracker> request) {
+ ClientOutgoingEnvelope(ClientSender sender, int messageFormat, ProtonBuffer payload, boolean complete, ClientFuture<Tracker> request) {
this.payload = payload;
this.request = request;
this.sender = sender;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiver.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiver.java
index 0c3dfc0..f3d2d08 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiver.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiver.java
@@ -46,6 +46,9 @@ import org.apache.qpid.protonj2.types.transport.DeliveryState;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Client {@link Receiver} implementation.
+ */
public final class ClientReceiver implements Receiver {
private static final Logger LOG = LoggerFactory.getLogger(ClientReceiver.class);
@@ -71,7 +74,7 @@ public final class ClientReceiver implements Receiver {
private volatile Source remoteSource;
private volatile Target remoteTarget;
- public ClientReceiver(ClientSession session, ReceiverOptions options, String receiverId, org.apache.qpid.protonj2.engine.Receiver receiver) {
+ ClientReceiver(ClientSession session, ReceiverOptions options, String receiverId, org.apache.qpid.protonj2.engine.Receiver receiver) {
this.options = options;
this.session = session;
this.receiverId = receiverId;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiverBuilder.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiverBuilder.java
index bdd7402..86d8702 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiverBuilder.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientReceiverBuilder.java
@@ -49,7 +49,7 @@ final class ClientReceiverBuilder {
private ReceiverOptions defaultReceivernOptions;
private StreamReceiverOptions defaultStreamReceiverOptions;
- public ClientReceiverBuilder(ClientSession session) {
+ ClientReceiverBuilder(ClientSession session) {
this.session = session;
this.sessionOptions = session.options();
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientRedirect.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientRedirect.java
index d6c9c22..3a41dcc 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientRedirect.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientRedirect.java
@@ -42,7 +42,7 @@ public final class ClientRedirect {
private URI cachedURI;
- public ClientRedirect(Map<Symbol, Object> redirect) {
+ ClientRedirect(Map<Symbol, Object> redirect) {
this.redirect = redirect;
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSender.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSender.java
index 0f711b4..bfc2b2a 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSender.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSender.java
@@ -80,7 +80,7 @@ class ClientSender implements Sender {
protected volatile Source remoteSource;
protected volatile Target remoteTarget;
- public ClientSender(ClientSession session, SenderOptions options, String senderId, org.apache.qpid.protonj2.engine.Sender protonSender) {
+ ClientSender(ClientSession session, SenderOptions options, String senderId, org.apache.qpid.protonj2.engine.Sender protonSender) {
this.options = new SenderOptions(options);
this.session = session;
this.senderId = senderId;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSenderBuilder.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSenderBuilder.java
index b1550af..494c0b6 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSenderBuilder.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSenderBuilder.java
@@ -49,7 +49,7 @@ final class ClientSenderBuilder {
private SenderOptions defaultSenderOptions;
private StreamSenderOptions defaultStreamSenderOptions;
- public ClientSenderBuilder(ClientSession session) {
+ ClientSenderBuilder(ClientSession session) {
this.session = session;
this.sessionOptions = session.options();
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSession.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSession.java
index 5f86def..0723e4f 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSession.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSession.java
@@ -76,7 +76,7 @@ public class ClientSession implements Session {
private org.apache.qpid.protonj2.engine.Session protonSession;
- public ClientSession(ClientConnection connection, SessionOptions options, String sessionId, org.apache.qpid.protonj2.engine.Session session) {
+ ClientSession(ClientConnection connection, SessionOptions options, String sessionId, org.apache.qpid.protonj2.engine.Session session) {
this.options = new SessionOptions(options);
this.connection = connection;
this.protonSession = session.setLinkedResource(this);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSessionBuilder.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSessionBuilder.java
index 743f3d6..1660a2e 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSessionBuilder.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientSessionBuilder.java
@@ -32,7 +32,7 @@ final class ClientSessionBuilder {
private SessionOptions defaultSessionOptions;
- public ClientSessionBuilder(ClientConnection connection) {
+ ClientSessionBuilder(ClientConnection connection) {
this.connection = connection;
this.connectionOptions = connection.getOptions();
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamDelivery.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamDelivery.java
index d3fa6e7..26ae99c 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamDelivery.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamDelivery.java
@@ -43,6 +43,10 @@ import org.apache.qpid.protonj2.types.transport.ErrorCondition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * A {@link StreamDelivery} implementation that provides the mechanics of reading message
+ * types from an incoming split framed transfer.
+ */
public final class ClientStreamDelivery implements StreamDelivery {
private static final Logger LOG = LoggerFactory.getLogger(ClientStreamDelivery.class);
@@ -53,7 +57,7 @@ public final class ClientStreamDelivery implements StreamDelivery {
private ClientStreamReceiverMessage message;
private RawDeliveryInputStream rawInputStream;
- public ClientStreamDelivery(ClientStreamReceiver receiver, IncomingDelivery protonDelivery) {
+ ClientStreamDelivery(ClientStreamReceiver receiver, IncomingDelivery protonDelivery) {
this.receiver = receiver;
this.protonDelivery = protonDelivery.setLinkedResource(this);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamReceiver.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamReceiver.java
index 6de3f02..c2a4ecb 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamReceiver.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamReceiver.java
@@ -49,6 +49,9 @@ import org.apache.qpid.protonj2.types.transport.DeliveryState;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Client implementation of a {@link StreamReceiver}.
+ */
public final class ClientStreamReceiver implements StreamReceiver {
private static final Logger LOG = LoggerFactory.getLogger(ClientReceiver.class);
@@ -72,7 +75,7 @@ public final class ClientStreamReceiver implements StreamReceiver {
private volatile Source remoteSource;
private volatile Target remoteTarget;
- public ClientStreamReceiver(ClientSession session, StreamReceiverOptions options, String receiverId, org.apache.qpid.protonj2.engine.Receiver receiver) {
+ ClientStreamReceiver(ClientSession session, StreamReceiverOptions options, String receiverId, org.apache.qpid.protonj2.engine.Receiver receiver) {
this.options = options;
this.session = session;
this.receiverId = receiverId;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSender.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSender.java
index 92a9e38..100a903 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSender.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSender.java
@@ -32,11 +32,14 @@ import org.apache.qpid.protonj2.engine.OutgoingDelivery;
import org.apache.qpid.protonj2.engine.util.StringUtils;
import org.apache.qpid.protonj2.types.messaging.DeliveryAnnotations;
+/**
+ * Client implementation of a {@link StreamSender}.
+ */
public final class ClientStreamSender extends ClientSender implements StreamSender {
private final StreamSenderOptions options;
- public ClientStreamSender(ClientSession session, StreamSenderOptions options, String senderId, org.apache.qpid.protonj2.engine.Sender protonSender) {
+ ClientStreamSender(ClientSession session, StreamSenderOptions options, String senderId, org.apache.qpid.protonj2.engine.Sender protonSender) {
super(session, options, senderId, protonSender);
this.options = new StreamSenderOptions(options);
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSession.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSession.java
index 1ab77ae..3a58b1a 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSession.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamSession.java
@@ -36,7 +36,7 @@ import org.apache.qpid.protonj2.engine.Session;
*/
public final class ClientStreamSession extends ClientSession {
- public ClientStreamSession(ClientConnection connection, SessionOptions options, String sessionId, Session session) {
+ ClientStreamSession(ClientConnection connection, SessionOptions options, String sessionId, Session session) {
super(connection, options, sessionId, session);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamTracker.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamTracker.java
index b9b2399..c36cc36 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamTracker.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientStreamTracker.java
@@ -30,7 +30,7 @@ import org.apache.qpid.protonj2.engine.OutgoingDelivery;
*/
public final class ClientStreamTracker extends ClientTracker implements StreamTracker {
- public ClientStreamTracker(ClientStreamSender sender, OutgoingDelivery delivery) {
+ ClientStreamTracker(ClientStreamSender sender, OutgoingDelivery delivery) {
super(sender, delivery);
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransportListener.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransportListener.java
index 58b0a43..84049df 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransportListener.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/impl/ClientTransportListener.java
@@ -35,7 +35,7 @@ final class ClientTransportListener implements TransportListener {
private final Engine engine;
- public ClientTransportListener(Engine engine) {
+ ClientTransportListener(Engine engine) {
this.engine = engine;
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/FifoDeliveryQueue.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/FifoDeliveryQueue.java
index 947dfe8..0404b53 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/FifoDeliveryQueue.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/FifoDeliveryQueue.java
@@ -45,6 +45,12 @@ public final class FifoDeliveryQueue implements DeliveryQueue {
protected final Deque<ClientDelivery> queue;
+ /**
+ * Creates a new first in / first out message queue with the given queue depth
+ *
+ * @param queueDepth
+ * The Queue depth to configure for this FIFO Message Queue.
+ */
public FifoDeliveryQueue(int queueDepth) {
this.queue = new ArrayDeque<ClientDelivery>(Math.max(1, queueDepth));
}
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/IdGenerator.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/IdGenerator.java
index 539f9d1..9144571 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/IdGenerator.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/IdGenerator.java
@@ -27,6 +27,9 @@ public class IdGenerator {
private final String prefix;
private final AtomicLong sequence = new AtomicLong(1);
+ /**
+ * The default Id prefix applied to all new Id values rendered from an {@link IdGenerator}.
+ */
public static final String DEFAULT_PREFIX = "ID:";
/**
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/ThreadPoolUtils.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/ThreadPoolUtils.java
index c32657d..a47f4be 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/ThreadPoolUtils.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/util/ThreadPoolUtils.java
@@ -31,6 +31,9 @@ public final class ThreadPoolUtils {
private static final Logger LOG = LoggerFactory.getLogger(ThreadPoolUtils.class);
+ /**
+ * Default thread pool shutdown timeout used to await graceful shutdown.
+ */
public static final long DEFAULT_SHUTDOWN_AWAIT_TERMINATION = 10 * 1000L;
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org