diff options
Diffstat (limited to 'qpid/tools/src/java/qpid-qmf2/src')
29 files changed, 52 insertions, 50 deletions
diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Agent.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Agent.java index f0a8f67cae..a5e1a46710 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Agent.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Agent.java @@ -89,7 +89,7 @@ import org.apache.qpid.qmf2.common.WorkQueue; * <p> * The diagram below shows the relationship between the Agent, the Subscription and SubscribableAgent interface. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * <p> * <h3>Receiving Asynchronous Notifications</h3> * This implementation of the QMF2 Agent actually supports two independent APIs to enable clients to receive @@ -110,7 +110,7 @@ import org.apache.qpid.qmf2.common.WorkQueue; * and asynchronous calls are processed on different JMS Sessions to facilitate this</li> * </ol> * <p> - * <img src="doc-files/QmfEventListenerModel.png"/> + * <img alt="" src="doc-files/QmfEventListenerModel.png"> * <p> * The QMF2 API has a work-queue Callback approach. All asynchronous events are represented by a WorkItem object. * When a QMF event occurs it is translated into a WorkItem object and placed in a FIFO queue. It is left to the @@ -140,7 +140,7 @@ import org.apache.qpid.qmf2.common.WorkQueue; * <li>It's generally not necessary to use a Notifier as the Console provides a blocking getNextWorkitem() method.</li> * </ol> * <p> - * <img src="doc-files/WorkQueueEventModel.png"/> + * <img alt="" src="doc-files/WorkQueueEventModel.png"> * <h3>Potential Issues with Qpid versions earlier than 0.12</h3> * Note 1: This uses QMF2 so requires that the "--mgmt-qmf2 yes" option is applied to the broker (this is the default * from Qpid 0.10). diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/QmfAgentData.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/QmfAgentData.java index 560ed9e975..974c5746e2 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/QmfAgentData.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/QmfAgentData.java @@ -51,7 +51,7 @@ import org.apache.qpid.qmf2.common.SchemaObjectClass; * <p> * The diagram below shows the relationship between the Subscription and QmfAgentData. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * <p> * In particular the QmfAgentData maintains references to active subscriptions to allow agents to asynchronously * push data to subscribing Consoles immediately that data becomes available. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/SubscribableAgent.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/SubscribableAgent.java index df9c92abca..619d00df7b 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/SubscribableAgent.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/SubscribableAgent.java @@ -38,7 +38,7 @@ import org.apache.qpid.qmf2.common.QmfQuery; * <p> * The following diagram illustrates the interactions between the Agent, Subscription and SubscribableAgent. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Subscription.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Subscription.java index e6800a9a41..2f49702c7c 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Subscription.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/agent/Subscription.java @@ -45,7 +45,7 @@ import org.apache.qpid.qmf2.common.QmfQueryTarget; * <p> * The following diagram illustrates the Subscription relationships with the Agent and QmfAgentData. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * @author Fraser Adams */ public final class Subscription extends TimerTask @@ -241,7 +241,7 @@ public final class Subscription extends TimerTask /** * Set the Subscription refresh interval in seconds. If the value passed to this method is zero the interval gets - * set to the Agent's DEFAULT_INTERVAL otherwise the interval passed gets restricted to be >= the Agent's + * set to the Agent's DEFAULT_INTERVAL otherwise the interval passed gets restricted to be {@literal >= } the Agent's * MIN_INTERVAL. * * @param interval the time (in milliseconds) between periodic updates of data in this Subscription. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanEquals.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanEquals.java index 2ab3e5c099..4eba04cc03 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanEquals.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanEquals.java @@ -59,7 +59,7 @@ public final class BooleanEquals extends BooleanExpression /** * Evaluate "equal to" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanExists.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanExists.java index a9c355c7fb..522748ebb6 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanExists.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanExists.java @@ -59,7 +59,7 @@ public final class BooleanExists extends BooleanExpression /** * Evaluate "exists" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterEqual.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterEqual.java index c9593ffa33..7aaeb8e687 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterEqual.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterEqual.java @@ -59,7 +59,7 @@ public final class BooleanGreaterEqual extends BooleanExpression /** * Evaluate "greater than or equal to" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterThan.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterThan.java index 65b7d82735..2ac44f35ec 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterThan.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanGreaterThan.java @@ -59,7 +59,7 @@ public final class BooleanGreaterThan extends BooleanExpression /** * Evaluate "greater than" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessEqual.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessEqual.java index 729495ffc2..2461f116d9 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessEqual.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessEqual.java @@ -59,7 +59,7 @@ public final class BooleanLessEqual extends BooleanExpression /** * Evaluate "less than or equal to" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessThan.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessThan.java index 540a292c4e..1a65119e59 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessThan.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanLessThan.java @@ -59,7 +59,7 @@ public final class BooleanLessThan extends BooleanExpression /** * Evaluate "less than" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanNotEquals.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanNotEquals.java index 50c5863e61..a72a467c1f 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanNotEquals.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanNotEquals.java @@ -59,7 +59,7 @@ public final class BooleanNotEquals extends BooleanExpression /** * Evaluate "not equal to" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanRegexMatch.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanRegexMatch.java index 9fe3f9733a..30311ba712 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanRegexMatch.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/BooleanRegexMatch.java @@ -74,7 +74,7 @@ public final class BooleanRegexMatch extends BooleanExpression /** * Evaluate "regex match" expression against a QmfData instance. * N.B. to avoid complexities with types this class treats operands as Strings performing an appropriate evaluation - * of the String that makes sense for a given expression e.g. parsing as a double for >, >=, <, <= + * of the String that makes sense for a given expression e.g. parsing as a double for {@literal >, >=, <, <= } * * @param data the object to evaluate the expression against * @return true if query matches the QmfData instance, else false. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Expression.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Expression.java index 1d82b7857b..4e92af911b 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Expression.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Expression.java @@ -31,7 +31,7 @@ import java.util.List; * a mixture of LogicalExpressions and BooleanExpressions. * <p> * The Expression structure is illustrated below in the context of its relationship with QmfQuery. - * <img src="doc-files/QmfQuery.png"/> + * <img alt="" src="doc-files/QmfQuery.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Notifier.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Notifier.java index 61b048832f..ecdce269b4 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Notifier.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/Notifier.java @@ -48,7 +48,7 @@ package org.apache.qpid.qmf2.common; * <li>It's generally not necessary to use a Notifier as the Console provides a blocking getNextWorkitem() method.</li> * </ol> * <p> - * <img src="doc-files/WorkQueueEventModel.png"/> + * <img alt="" src="doc-files/WorkQueueEventModel.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfData.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfData.java index 571db16064..c634564ba4 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfData.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfData.java @@ -43,7 +43,7 @@ import java.util.Map; * <p> * The following diagram represents the QmfData class hierarchy. * <p> - * <img src="doc-files/QmfData.png"/> + * <img alt="" src="doc-files/QmfData.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfEventListener.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfEventListener.java index 2e5b98852b..c6b1c14350 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfEventListener.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfEventListener.java @@ -36,7 +36,7 @@ package org.apache.qpid.qmf2.common; * and asynchronous calls are processed on different JMS Sessions to facilitate this</li> * </ol> * <p> - * <img src="doc-files/QmfEventListenerModel.png"/> + * <img alt="" src="doc-files/QmfEventListenerModel.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfQuery.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfQuery.java index c0555cc91f..e9b8e13deb 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfQuery.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/QmfQuery.java @@ -83,7 +83,7 @@ import org.apache.qpid.messaging.util.AddressParser; * </pre> * <p> * The Expression structure is illustrated below in the context of its relationship with QmfQuery. - * <img src="doc-files/QmfQuery.png"/> + * <img alt="" src="doc-files/QmfQuery.png"> * * * @author Fraser Adams @@ -212,7 +212,7 @@ public final class QmfQuery extends QmfData * Undefined by QMF2 API. * <p> * According to <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API Specification</a> - * "The value of the <target name string> map entry is ignored for now, its use is TBD." + * "The value of the <target name string> map entry is ignored for now, its use is TBD." * so this method returns a null Map. */ public Map getTargetParam() diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaClass.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaClass.java index b15a1a5c96..045628dc1a 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaClass.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaClass.java @@ -34,7 +34,7 @@ import java.util.UUID; * <p> * The following diagram illustrates the QMF2 Schema class hierarchy. * <p> - * <img src="doc-files/Schema.png"/> + * <img alt="" src="doc-files/Schema.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaEventClass.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaEventClass.java index 336a540565..c563c63362 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaEventClass.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaEventClass.java @@ -40,7 +40,7 @@ import java.util.Map; * these are actually represented in the QMF2 protocol as a "List of SCHEMA_PROPERTY elements that describe the * schema event's properties. * <p> - * In this implementation getProperties() returns a List<SchemaProperty> reflecting the reality of the protocol + * In this implementation getProperties() returns a {@code List<SchemaProperty>} reflecting the reality of the protocol * rather than what is suggested by the API documentation. * * @author Fraser Adams @@ -144,7 +144,7 @@ public final class SchemaEventClass extends SchemaClass * Note that <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API</a> suggests that * the properties are represented by an unordered map of SchemaProperty indexed by property name however it * is actually represented in the QMF2 protocol as a "List of SCHEMA_PROPERTY elements that describe the - * schema objects's properties. In this implementation getProperties() returns a List<SchemaProperty> + * schema objects's properties. In this implementation getProperties() returns a {@code List<SchemaProperty>} * reflecting the reality of the protocol rather than what is suggested by the API documentation. * * @return Schema Object's properties. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaMethod.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaMethod.java index a9f8080fca..c1db746851 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaMethod.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaMethod.java @@ -35,7 +35,7 @@ import java.util.Map; * however is is actually represented in the QMF2 protocol as a "List of SCHEMA_PROPERTY elements that describe * the method's arguments". * <p> - * In this implementation getArguments() returns a List<SchemaProperty> reflecting the reality of the protocol + * In this implementation getArguments() returns a {@code List<SchemaProperty>} reflecting the reality of the protocol * rather than what is suggested by the API documentation. * * @author Fraser Adams @@ -92,13 +92,13 @@ public final class SchemaMethod extends QmfData } /** - * Construct a SchemaMethod from a map of "name":<SchemaProperty> entries and description. + * Construct a SchemaMethod from a map of "name":{@code <SchemaProperty>} entries and description. * * Note this Constructor is the one given in the QMF2 API specification at * <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API</a>Note too that this method does not * set a name so setName() needs to be called explicitly by clients after construction. * - * @param args a Map of "name":<SchemaProperty> entries. + * @param args a Map of "name":{@code <SchemaProperty>} entries. * @param description a description of the SchemaMethod. */ public SchemaMethod(final Map<String, SchemaProperty> args, final String description) @@ -156,7 +156,7 @@ public final class SchemaMethod extends QmfData * <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API</a> suggests that * the parameter list is represented by an unordered map of SchemaProperty entries indexed by parameter name, * however is is actually represented in the QMF2 protocol as a "List of SCHEMA_PROPERTY elements that describe - * the method's arguments". In this implementation getArguments() returns a List<SchemaProperty> reflecting the + * the method's arguments". In this implementation getArguments() returns a {@code List<SchemaProperty>} reflecting the * reality of the protocol rather than what is suggested by the API documentation. * * @return the Method's arguments. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaObjectClass.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaObjectClass.java index 42c5fbda9a..734d040be6 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaObjectClass.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/SchemaObjectClass.java @@ -41,7 +41,7 @@ import java.util.Map; * the properties and methods are represented by an unordered map of SchemaProperty or SchemaMethod entries indexed by * property or method name, however these are actually represented in the QMF2 protocol as a "List of SCHEMA_PROPERTY * and "List of SCHEMA_METHOD" elements that describe the schema objects's properties and methods". In this - * implementation getProperties() returns a List<SchemaProperty> and getMethods() returns a List<SchemaMethod> + * implementation getProperties() returns a {@code List<SchemaProperty>} and getMethods() returns a {@code List<SchemaMethod>} * reflecting the reality of the protocol rather than what is suggested by the API documentation. * * @author Fraser Adams @@ -151,7 +151,7 @@ public final class SchemaObjectClass extends SchemaClass * Note that <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API</a> suggests that * the properties are represented by an unordered map of SchemaProperty indexed by property name, however it * is actually represented in the QMF2 protocol as a "List of SCHEMA_PROPERTY elements that describe the - * schema objects's properties. In this implementation getProperties() returns a List<SchemaProperty> + * schema objects's properties. In this implementation getProperties() returns a {@code List<SchemaProperty>} * reflecting the reality of the protocol rather than what is suggested by the API documentation. * * @return Schema Object's properties. @@ -203,7 +203,7 @@ public final class SchemaObjectClass extends SchemaClass * Note that <a href=https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal>QMF2 API</a> suggests that * the methods are represented by an unordered map of SchemaMethod indexed by method name, however it * is actually represented in the QMF2 protocol as a "List of SCHEMA_METHOD elements that describe the - * schema objects's methods. In this implementation getMethods() returns a List<SchemaMethod> + * schema objects's methods. In this implementation getMethods() returns a {@code List<SchemaMethod>} * reflecting the reality of the protocol rather than what is suggested by the API documentation. * * @return Schema Object's methods. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/WorkItem.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/WorkItem.java index 570d464f22..90afc70f31 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/WorkItem.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/common/WorkItem.java @@ -36,7 +36,7 @@ import org.apache.qpid.qmf2.console.Agent; * The type of the Object returned by getParams is determined by the WorkItemType and described below. * <p> * - * <table width="100%" border="1"><thead><tr><th>WorkItem Type</th><th>Description</th></tr></thead><tbody> + * <table width="100%" border="1" summary=""><thead><tr><th>WorkItem Type</th><th>Description</th></tr></thead><tbody> * * * <tr> @@ -292,11 +292,12 @@ import org.apache.qpid.qmf2.console.Agent; * Use UnsubscribeRequestWorkItem to enable neater access. * </td> * </tr> + * </tbody> * </table> * <p> * The following diagram illustrates the QMF2 WorkItem class hierarchy. * <p> - * <img src="doc-files/WorkItem.png"/> + * <img alt="" src="doc-files/WorkItem.png"> * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Agent.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Agent.java index 8fa2ae8f1f..26c80df809 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Agent.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Agent.java @@ -50,7 +50,7 @@ import org.apache.qpid.qmf2.common.SchemaClassId; * The following diagram illustrates the interactions between the Console, AgentProxy and the client side Agent * representation. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * @author Fraser Adams */ public final class Agent extends QmfData diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentProxy.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentProxy.java index e43a242f51..55eb0df7b6 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentProxy.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/AgentProxy.java @@ -41,7 +41,7 @@ import org.apache.qpid.qmf2.common.QmfException; * The following diagram illustrates the interactions between the Console, AgentProxy and the client side Agent * representation. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * @author Fraser Adams */ public interface AgentProxy diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Console.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Console.java index d15e4ad58d..9a5c2e560d 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Console.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/Console.java @@ -78,7 +78,7 @@ import org.apache.qpid.messaging.util.AddressParser; * is made available by this object. A console application must instatiate one of these objects. * <p> * If a name is supplied, it must be unique across all Consoles attached to the AMQP bus under the given - * domain. If no name is supplied, a unique name will be synthesized in the format: "qmfc-<hostname>.<pid>" + * domain. If no name is supplied, a unique name will be synthesized in the format: {@literal "qmfc-<hostname>.<pid>"} * <p> * <h3>Interactions with remote Agent</h3> * As noted below, some Console methods require contacting a remote Agent. For these methods, the caller @@ -89,7 +89,7 @@ import org.apache.qpid.messaging.util.AddressParser; * <p> * The following diagram illustrates the interactions between the Console, Agent and client side Agent proxy. * <p> - * <img src="doc-files/Console.png"/> + * <img alt="" src="doc-files/Console.png"> * <p> * All blocking calls are considered thread safe - it is possible to have a multi-threaded implementation * have multiple blocking calls in flight simultaneously. @@ -108,7 +108,7 @@ import org.apache.qpid.messaging.util.AddressParser; * The SubscriptionManager is also used to maintain the Subscription query to enable ManagementAgent _data indications * to be tested in order to emulate Subscriptions to the broker ManagementAgent on the client side. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * <p> * <h3>Receiving Asynchronous Notifications</h3> * This implementation of the QMF2 Console actually supports two independent APIs to enable clients to receive @@ -129,7 +129,7 @@ import org.apache.qpid.messaging.util.AddressParser; * and asynchronous calls are processed on different JMS Sessions to facilitate this</li> * </ol> * <p> - * <img src="doc-files/QmfEventListenerModel.png"/> + * <img alt="" src="doc-files/QmfEventListenerModel.png"> * <p> * The QMF2 API has a work-queue Callback approach. All asynchronous events are represented by a WorkItem object. * When a QMF event occurs it is translated into a WorkItem object and placed in a FIFO queue. It is left to the @@ -160,7 +160,7 @@ import org.apache.qpid.messaging.util.AddressParser; * <li>It's generally not necessary to use a Notifier as the Console provides a blocking getNextWorkitem() method.</li> * </ol> * <p> - * <img src="doc-files/WorkQueueEventModel.png"/> + * <img alt="" src="doc-files/WorkQueueEventModel.png"> * <h3>Potential Issues with Qpid versions earlier than 0.12</h3> diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/MethodResult.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/MethodResult.java index 9f8df918fa..8822e02752 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/MethodResult.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/MethodResult.java @@ -34,7 +34,7 @@ import org.apache.qpid.qmf2.common.QmfException; * <p> * Returned data is provided in QmfData map indexed by the name of the parameter. The QmfData map contains only those * parameters that are classified as "output" by the SchemaMethod. - * <p? + * <p> * Should a method call result in a failure, this failure is indicated by the presence of an error object in * the MethodResult. This object is represented by a QmfException object, which contains a description of the * reason for the failure. There are no returned parameters when a method call fails. diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionManager.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionManager.java index 6e3e9e91b5..69889d85de 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionManager.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/console/SubscriptionManager.java @@ -52,7 +52,7 @@ import org.apache.qpid.qmf2.common.QmfQuery; * <p> * The following diagram illustrates the Subscription relationships with the Console and local Agent proxy. * <p> - * <img src="doc-files/Subscriptions.png"/> + * <img alt="" src="doc-files/Subscriptions.png"> * * @author Fraser Adams */ diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/ConnectionHelper.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/ConnectionHelper.java index 193d863823..b5655dda29 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/ConnectionHelper.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/ConnectionHelper.java @@ -79,17 +79,17 @@ import org.apache.qpid.messaging.util.AddressParser; * <p> * Java ConnectionURLs look like this: * <pre> - * amqp://[<user>:<pass>@][<clientid>]/<virtualhost>[?<option>='<value>'[&<option>='<value>']] + * amqp://[<user>:<pass>@][<clientid>]/<virtualhost>[?<option>='<value>'[&<option>='<value>']] * </pre> * This syntax is very powerful, but it can also be fairly complex to work with, especially when one realises * that one of the options in the above syntax is brokerlist='<broker url>' where broker url is itself a URL * of the format: * <pre> - * <transport>://<host>[:<port>][?<option>='<value>'[&<option>='<value>']] + * <transport>://<host>[:<port>][?<option>='<value>'[&<option>='<value>']] * </pre> * so one may see ConnectionURLs that look like: * <pre> - * amqp://guest:guest@clientid/test?brokerlist='tcp://localhost:5672?retries='10'&connectdelay='1000'' + * {@literal amqp://guest:guest@clientid/test?brokerlist='tcp://localhost:5672?retries='10'&connectdelay='1000''} * </pre> * * <p> @@ -134,8 +134,8 @@ import org.apache.qpid.messaging.util.AddressParser; * <h3>Differences from Qpid M4 Java Connection URL format</h3> * Addresses are at the start of the URL rather than in the "brokerlist" option. * <p> - * Option format is ?foo=bar;x=y rather than ?foo='bar'&x='y'. The use of "'" quotes is not common for URI query - * strings. The use of "&" as a separator creates problems + * Option format is {@literal ?foo=bar;x=y } rather than {@literal ?foo='bar'&x='y'}. The use of "'" quotes is not common for URI query + * strings. The use of "&" as a separator creates problems * <p> * user, pass and clientid are options rather than having a special place at the front of the URL. clientid is * a Qpid proprietary property and user/pass are not relevant in all authentication schemes. @@ -151,7 +151,7 @@ import org.apache.qpid.messaging.util.AddressParser; * The option format is the same as that of the C++ qpid::messaging Connection class. for example: "{reconnect: true, * tcp-nodelay: true}": * <p> - * <table summary="Connection Options" width="100%" border="1"><colgroup><col><col><col></colgroup><thead> + * <table summary="Connection Options" width="100%" border="1"><thead> * <tr><th>option name</th><th>value type</th><th>semantics</th></tr></thead><tbody> * <tr> * <td><code class="literal">maxprefetch</code></td> @@ -295,7 +295,7 @@ import org.apache.qpid.messaging.util.AddressParser; * <td>Kerberos trust store password</td> * </tr> * <tr> - * <td><code class="key_store</code></td> + * <td><code class="literal">key_store</code></td> * <td>string</td> * <td>path to Kerberos key store </td> * </tr> diff --git a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/GetOpt.java b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/GetOpt.java index a4436b0105..aaf1d1afce 100644 --- a/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/GetOpt.java +++ b/qpid/tools/src/java/qpid-qmf2/src/main/java/org/apache/qpid/qmf2/util/GetOpt.java @@ -33,7 +33,7 @@ import java.util.ArrayList; * * <p> * Example usage (paraphrased from QpidConfig): - * <pre> + * <pre>{@code * String[] longOpts = {"help", "durable", "bindings", "broker-addr=", "file-count=", * "file-size=", "max-queue-size=", "max-queue-count=", "limit-policy=", * "order=", "sequence", "ive", "generate-queue-events=", "force", "force-if-not-empty", @@ -91,6 +91,7 @@ import java.util.ArrayList; * System.err.println(e.toString()); * usage(); * } + * } * </pre> * * @author Fraser Adams |