scolebourne 2003/09/06 13:41:12
Modified: collections/src/java/org/apache/commons/collections
Buffer.java
Log:
Javadoc
Revision Changes Path
1.6 +13 -13
jakarta-commons/collections/src/java/org/apache/commons/collections/Buffer.java
Index: Buffer.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/Buffer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Buffer.java 31 Aug 2003 17:26:44 -0000 1.5
+++ Buffer.java 6 Sep 2003 20:41:12 -0000 1.6
@@ -64,15 +64,15 @@
* well-defined order. The removal order can be based on insertion order
* (eg, a FIFO queue or a LIFO stack), on access order (eg, an LRU cache),
* on some arbitrary comparator (eg, a priority queue) or on any other
- * well-defined ordering.<P>
- *
+ * well-defined ordering.
+ * <p>
* Note that the removal order is not necessarily the same as the iteration
- * order. A <Code>Buffer</Code> implementation may have equivalent removal
- * and iteration orders, but this is not required.<P>
- *
+ * order. A <code>Buffer</code> implementation may have equivalent removal
+ * and iteration orders, but this is not required.
+ * <p>
* This interface does not specify any behavior for
* [EMAIL PROTECTED] Object#equals(Object)} and [EMAIL PROTECTED] Object#hashCode}
methods. It
- * is therefore possible for a <Code>Buffer</Code> implementation to also
+ * is therefore possible for a <code>Buffer</code> implementation to also
* also implement [EMAIL PROTECTED] java.util.List}, [EMAIL PROTECTED]
java.util.Set} or
* [EMAIL PROTECTED] Bag}.
*
@@ -80,24 +80,24 @@
* @version $Revision$ $Date$
*
* @author Avalon
- * @author <a href="[EMAIL PROTECTED]">Berin Loritsch</a>
+ * @author Berin Loritsch
* @author Paul Jack
* @author Stephen Colebourne
*/
public interface Buffer extends Collection {
/**
- * Removes the next object from the buffer.
+ * Gets and removes the next object from the buffer.
*
- * @return the removed object
+ * @return the next object in the buffer, which is also removed
* @throws BufferUnderflowException if the buffer is already empty
*/
Object remove();
/**
- * Returns the next object in the buffer without removing it.
+ * Gets the next object from the buffer without removing it.
*
- * @return the next object in the buffer
+ * @return the next object in the buffer, which is not removed
* @throws BufferUnderflowException if the buffer is empty
*/
Object get();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
