gpclient: Javadoc update

Author: gcarcassi

gpclient/gpclient-core/src/main/java/org/epics/gpclient/PVEventRecorder.java

@@ -56,6 +56,14 @@ public List<PVEvent> getEvents() {
         }
     }
 
+    /**
+     * Waits until the condition is met. If the conditions is already met, it
+     * returns right away. If the condition is not met after the time specified,
+     * an {@link AssertionError} is thrown.
+     * 
+     * @param ms the timeout in millis
+     * @param condition the condition
+     */
     public void wait(int ms, Function<List<PVEvent>, Boolean> condition) {
         CountDownLatch latch = new CountDownLatch(1);
         Runnable newTest = new Runnable() {
@@ -83,6 +91,15 @@ public void run() {
         }
     }
 
+    /**
+     * Checks that the condition is not met. The method returns successfully
+     * only if the condition is not met within the timeout. If the conditions is
+     * already met, or if it is met within the time specified, an
+     * {@link AssertionError} is thrown.
+     * 
+     * @param ms the timeout in millis
+     * @param condition the condition
+     */
     public void dontExpect(int ms, Function<List<PVEvent>, Boolean> condition) {
         CountDownLatch latch = new CountDownLatch(1);
         Runnable newTest = new Runnable() {
@@ -109,17 +126,34 @@ public void run() {
             throw new AssertionError("Received " + condition + " against expectation");
         }
     }
-    
+
+    /**
+     * Returns an {@link AssertionError} if the condition is not already met.
+     * 
+     * @param condition the condition
+     */    
     public void hasReceived(Function<List<PVEvent>, Boolean> condition) {
         if (!condition.apply(events)) {
             throw new AssertionError("Didn't receive " + condition);
         }
     }
 
-    public boolean hasNotReceived(Function<List<PVEvent>, Boolean> condition) {
-        return !condition.apply(events);
+    /**
+     * Returns an {@link AssertionError} if the condition is already met.
+     * 
+     * @param condition the condition
+     */    
+    public void hasNotReceived(Function<List<PVEvent>, Boolean> condition) {
+        if (condition.apply(events)) {
+            throw new AssertionError("Received " + condition);
+        }
     }
 
+    /**
+     * Checks that any event was received.
+     * 
+     * @return any event condition
+     */
     public static Function<List<PVEvent>, Boolean> forAnEvent() {
         return new Function<List<PVEvent>, Boolean>() {
             @Override
@@ -134,10 +168,21 @@ public String toString() {
         };
     }
 
+    /**
+     * Checks that a connection event was received.
+     * 
+     * @return connection event condition
+     */
     public static Function<List<PVEvent>, Boolean> forAConnectionEvent() {
         return anEventOfType(PVEvent.Type.READ_CONNECTION);
     }
 
+    /**
+     * Checks that an event of the given type was received.
+     * 
+     * @param type the event type
+     * @return type of event condition
+     */
     public static Function<List<PVEvent>, Boolean> anEventOfType(PVEvent.Type type) {
         return new Function<List<PVEvent>, Boolean>() {
             @Override
@@ -151,7 +196,13 @@ public String toString() {
             }
         };
     }
-    
+
+    /**
+     * Checks the given number of events were received.
+     * 
+     * @param count the number of events
+     * @return event count condition
+     */    
     public static Function<List<PVEvent>, Boolean> forEventCount(final int count) {
         return new Function<List<PVEvent>, Boolean>() {
             @Override

gpclient/gpclient-core/src/main/java/org/epics/gpclient/ProbeCollector.java

@@ -7,6 +7,8 @@
 import java.io.PrintStream;
 
 /**
+ * Utility class used to test the communication between the collectors and the 
+ * data providers.
  *
  * @author carcassi
  */
@@ -16,6 +18,13 @@ public class ProbeCollector<T> {
     private final ReadCollector<T, T> readCollector;
     private final WriteCollector<T> writeCollector;
 
+    /**
+     * Creates a probe collector that reads/writes the given type and that
+     * streams events to the given output.
+     * 
+     * @param type the type of objects to read/write
+     * @param out where to stream the log
+     */
     public ProbeCollector(Class<T> type, PrintStream out) {
         this.readCollector = new LatestValueCollector<>(type);
         this.writeCollector = new WriteCollector<>();
@@ -39,33 +48,68 @@ protected void onEvent(PVEvent event) {
         this.readCollector.setUpdateListener(this.recorder);
         this.writeCollector.setUpdateListener(this.recorder);
     }
-    
+
+    /**
+     * The current connection value in the collector.
+     * 
+     * @return the connection value
+     */
     public boolean getConnection() {
         return readCollector.getConnection();
     }
-    
+
+    /**
+     * The current value in the collector.
+     * 
+     * @return the value
+     */
     public T getValue() {
         return readCollector.getValue();
     }
 
+    /**
+     * The read collector to send events to.
+     * 
+     * @return the read collector
+     */
     public ReadCollector<T, T> getReadCollector() {
         return readCollector;
     }
 
+    /**
+     * The write collector to send events to.
+     * 
+     * @return the write collector
+     */
     public WriteCollector<T> getWriteCollector() {
         return writeCollector;
     }
-    
+
+    /**
+     * Write a value to the collector.
+     * 
+     * @param value the value to be written
+     */
     public void writeValue(T value) {
         writeCollector.prepareWrite(1);
         writeCollector.queueValue(value);
         writeCollector.sendWriteRequest(0, recorder);
     }
-
+    
+    /**
+     * The recorder that gives access to all the accumulated events.
+     * 
+     * @return the event log
+     */
     public PVEventRecorder getRecorder() {
         return recorder;
     }
-    
+
+    /**
+     * Creates a simple probe collector that does not write a log.
+     * 
+     * @return a probe collector
+     */
     public static ProbeCollector<?> create() {
         return new ProbeCollector<>(Object.class, null);
     }