Further example tidy up

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@480088 13f79535-47bb-0310-9956-ffa450edef68

4 files changed, 44 insertions, 39 deletions

diff --git a/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriber.java b/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriber.java
index d6e020bf43..9c195aef40 100644
--- a/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriber.java
+++ b/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriber.java
@@ -42,6 +42,9 @@ public class MonitoredSubscriber extends Subscriber
         _monitorDestinationName = _destinationName + Statics.MONITOR_QUEUE_SUFFIX;
     }
 
+    /**
+     * MessageListener implementation for this subscriber
+     */
     public static class MonitorMessageListener implements MessageListener
     {
         private String _name;
@@ -52,9 +55,10 @@ public class MonitoredSubscriber extends Subscriber
 
         }
 
-        /*
-        * Listens for heartbeat messages and acknowledges them
-        */
+        /**
+         * Listens for heartbeat messages and acknowledges them
+         * @param message
+         */
         public void onMessage(javax.jms.Message message)
         {
             _logger.info(_name + " monitor got message '" + message + "'");
@@ -79,9 +83,9 @@ public class MonitoredSubscriber extends Subscriber
         }
     }
 
-    /*
-    * Subscribes to Queue and attaches additional monitor listener
-    */
+    /**
+     * Subscribes to Queue and attaches additional monitor listener
+     */
     public void subscribeAndMonitor()
     {
         try
@@ -115,7 +119,9 @@ public class MonitoredSubscriber extends Subscriber
         }
     }
 
-    //stop consuming
+    /**
+     * Stop consuming
+     */
     public void stopMonitor()
     {
         try
diff --git a/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriptionWrapper.java b/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriptionWrapper.java
index d6ec8bd5de..d2f27da052 100644
--- a/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriptionWrapper.java
+++ b/java/client/src/test/java/org/apache/qpid/example/subscriber/MonitoredSubscriptionWrapper.java
@@ -19,9 +19,6 @@
 package org.apache.qpid.example.subscriber;
 
 import org.apache.log4j.BasicConfigurator;
-import org.apache.qpid.example.shared.Statics;
-
-import java.util.Properties;
 
 /**
  * Allows you to simply start a monitored subscriber
@@ -30,6 +27,10 @@ public class MonitoredSubscriptionWrapper {
 
     private static MonitoredSubscriber _subscriber;
 
+    /**
+     * Create a monitored subscriber and start it
+     * @param args - no params required
+     */
     public static void main(String args[])
     {
         //switch on logging
@@ -37,15 +38,12 @@ public class MonitoredSubscriptionWrapper {
 
         _subscriber = new MonitoredSubscriber();
 
-        //using system props but can replace with app appropriate config here
-        Properties props = System.getProperties();
-
-        //note that for failover should set -Dhost=host1:port1;host2:port2
-        //Client will then failover in order i.e. connect to first host and failover to second and so on
         _subscriber.subscribe();
     }
 
-    //Stop subscribing now ...
+    /**
+     * Stop subscribing now ...
+     */
     public static void stop()
     {
         _subscriber.stop();
diff --git a/java/client/src/test/java/org/apache/qpid/example/subscriber/Subscriber.java b/java/client/src/test/java/org/apache/qpid/example/subscriber/Subscriber.java
index 6b89567b83..34c7d6c7bb 100644
--- a/java/client/src/test/java/org/apache/qpid/example/subscriber/Subscriber.java
+++ b/java/client/src/test/java/org/apache/qpid/example/subscriber/Subscriber.java
@@ -69,9 +69,9 @@ public class Subscriber
         }
     }
 
-    /*
-    * Listener class that handles messages
-    */
+    /**
+     * Listener class that handles messages
+     */
     public static class ExampleMessageListener implements MessageListener
     {
         private String _name;
@@ -82,10 +82,10 @@ public class Subscriber
 
         }
 
-        /*
-        * Listens for message callbacks, handles and then acknowledges them
-        * @param message - the message received
-        */
+        /**
+         * Listens for message callbacks, handles and then acknowledges them
+         * @param message - the message received
+         */
         public void onMessage(javax.jms.Message message)
         {
             _log.info(_name + " got message '" + message + "'");
@@ -113,9 +113,9 @@ public class Subscriber
         }
     }
 
-    /*
-    * Subscribes to example Queue and attaches listener
-    */
+    /**
+     * Subscribes to example Queue and attaches listener
+     */
     public void subscribe()
     {
         _log.info("Starting subscription ...");
@@ -160,14 +160,18 @@ public class Subscriber
         }
     }
 
+    /**
+     * Set destination (queue or topic) name
+     * @param name
+     */
     public void setDestinationName(String name)
     {
         _destinationName = name;
     }
 
-    /*
-    * stop consuming and close connection
-    */
+    /**
+     * Stop consuming and close connection
+     */
     public void stop()
     {
         try
diff --git a/java/client/src/test/java/org/apache/qpid/example/subscriber/SubscriptionWrapper.java b/java/client/src/test/java/org/apache/qpid/example/subscriber/SubscriptionWrapper.java
index 4e755e858f..32a0ef685c 100644
--- a/java/client/src/test/java/org/apache/qpid/example/subscriber/SubscriptionWrapper.java
+++ b/java/client/src/test/java/org/apache/qpid/example/subscriber/SubscriptionWrapper.java
@@ -18,10 +18,6 @@
  */
 package org.apache.qpid.example.subscriber;
 
-import org.apache.qpid.example.shared.Statics;
-
-import java.util.Properties;
-
 import org.apache.log4j.BasicConfigurator;
 
 /**
@@ -31,6 +27,10 @@ public class SubscriptionWrapper {
 
     private static Subscriber _subscriber;
 
+    /**
+     * Create a subscriber and start it
+     * @param args
+     */
     public static void main(String args[])
     {
         //switch on logging
@@ -38,15 +38,12 @@ public class SubscriptionWrapper {
         
          _subscriber = new Subscriber();
 
-        //using system props but can replace with app appropriate config here
-        Properties props = System.getProperties();
-
-        //note that for failover should set -Dhost=host1:port1;host2:port2
-        //Client will then failover in order i.e. connect to first host and failover to second and so on
         _subscriber.subscribe();
     }
 
-    //Stop subscribing now ...
+    /**
+     * Stop subscribing now ...
+     */
     public static void stop()
     {
         _subscriber.stop();