bloritsch 2002/09/30 10:49:14
Modified: event/src/java/org/apache/excalibur/event Sink.java
Source.java
Log:
add back in the inadvertantly removed size() method, and correct the javadocs
Revision Changes Path
1.15 +10 -3
jakarta-avalon-excalibur/event/src/java/org/apache/excalibur/event/Sink.java
Index: Sink.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/event/src/java/org/apache/excalibur/event/Sink.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Sink.java 30 Sep 2002 16:17:01 -0000 1.14
+++ Sink.java 30 Sep 2002 17:49:13 -0000 1.15
@@ -67,7 +67,7 @@
public interface Sink
{
/**
- * Enqueues the given element onto the queue.
+ * Enqueues the given element onto the Sink.
*
* @param element The elements to enqueue
* @throws SinkFullException Indicates that the sink is temporarily full.
@@ -114,7 +114,7 @@
* set of elements on the queue and then performs some work to "fill in"
* those elements before performing a commit. This can also be used
* to perform multi-queue transactional enqueue operations, with an
- * "all-or-nothing" strategy for enqueueing events on multiple queues.
+ * "all-or-nothing" strategy for enqueueing events on multiple Sinks.
* </p>
*
* <p>This method would generally be used in the following manner:</p>
@@ -163,7 +163,7 @@
* Like maxSize(), this is also informational, and isFull() returning
* false does not guarantee that future enqueue operations will succeed.
* Clearly, isFull() returning true does not guarantee that they will
- * fail, since the queue may be serviced in the meantime.
+ * fail, since the Sink may be serviced in the meantime.
*
* @return true if the Sink is full
*/
@@ -177,4 +177,11 @@
* @return the number of elements the Sink can accept
*/
int canAccept();
+
+ /**
+ * Returns the number of elements waiting in this Sink.
+ *
+ * @return the number of elements in the Sink
+ */
+ int size();
}
1.15 +2 -3
jakarta-avalon-excalibur/event/src/java/org/apache/excalibur/event/Source.java
Index: Source.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/event/src/java/org/apache/excalibur/event/Source.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Source.java 30 Sep 2002 16:17:01 -0000 1.14
+++ Source.java 30 Sep 2002 17:49:13 -0000 1.15
@@ -106,10 +106,9 @@
Object[] dequeue( int num );
/**
- * Returns the number of elements waiting in this queue.
+ * Returns the number of elements waiting in this Source.
*
- * @return the number of elements in the queue
+ * @return the number of elements in the Source
*/
int size();
-
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
