You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2004/05/15 14:33:23 UTC
cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/buffer UnmodifiableBuffer.java TransformedBuffer.java BlockingBuffer.java TypedBuffer.java UnboundedFifoBuffer.java PredicatedBuffer.java SynchronizedBuffer.java PriorityBuffer.java
scolebourne 2004/05/15 05:33:23
Modified: collections/src/java/org/apache/commons/collections/buffer
UnmodifiableBuffer.java TransformedBuffer.java
BlockingBuffer.java TypedBuffer.java
UnboundedFifoBuffer.java PredicatedBuffer.java
SynchronizedBuffer.java PriorityBuffer.java
Log:
Javadoc
Revision Changes Path
1.6 +4 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
Index: UnmodifiableBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- UnmodifiableBuffer.java 18 Feb 2004 00:58:18 -0000 1.5
+++ UnmodifiableBuffer.java 15 May 2004 12:33:23 -0000 1.6
@@ -34,8 +34,11 @@
/**
* Factory method to create an unmodifiable buffer.
+ * <p>
+ * If the buffer passed in is already unmodifiable, it is returned.
*
* @param buffer the buffer to decorate, must not be null
+ * @return an unmodifiable Buffer
* @throws IllegalArgumentException if buffer is null
*/
public static Buffer decorate(Buffer buffer) {
1.4 +2 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/TransformedBuffer.java
Index: TransformedBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/TransformedBuffer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TransformedBuffer.java 18 Feb 2004 00:58:18 -0000 1.3
+++ TransformedBuffer.java 15 May 2004 12:33:23 -0000 1.4
@@ -42,6 +42,7 @@
*
* @param buffer the buffer to decorate, must not be null
* @param transformer the transformer to use for conversion, must not be null
+ * @return a new transformed Buffer
* @throws IllegalArgumentException if buffer or transformer is null
*/
public static Buffer decorate(Buffer buffer, Transformer transformer) {
1.4 +2 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java
Index: BlockingBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- BlockingBuffer.java 18 Feb 2004 00:58:18 -0000 1.3
+++ BlockingBuffer.java 15 May 2004 12:33:23 -0000 1.4
@@ -47,6 +47,7 @@
* Factory method to create a blocking buffer.
*
* @param buffer the buffer to decorate, must not be null
+ * @return a new blocking Buffer
* @throws IllegalArgumentException if buffer is null
*/
public static Buffer decorate(Buffer buffer) {
1.5 +3 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/TypedBuffer.java
Index: TypedBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/TypedBuffer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TypedBuffer.java 7 May 2004 23:28:38 -0000 1.4
+++ TypedBuffer.java 15 May 2004 12:33:23 -0000 1.5
@@ -42,6 +42,7 @@
*
* @param buffer the buffer to decorate, must not be null
* @param type the type to allow into the buffer, must not be null
+ * @return a new typed Buffer
* @throws IllegalArgumentException if buffer or type is null
* @throws IllegalArgumentException if the buffer contains invalid elements
*/
@@ -53,6 +54,7 @@
* Restrictive constructor.
*/
protected TypedBuffer() {
+ super();
}
}
1.8 +4 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java
Index: UnboundedFifoBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- UnboundedFifoBuffer.java 18 Feb 2004 00:58:18 -0000 1.7
+++ UnboundedFifoBuffer.java 15 May 2004 12:33:23 -0000 1.8
@@ -54,8 +54,11 @@
*/
public class UnboundedFifoBuffer extends AbstractCollection implements Buffer {
+ /** The array of objects in the buffer. */
protected Object[] buffer;
+ /** The current head index. */
protected int head;
+ /** The current tail index. */
protected int tail;
/**
1.4 +2 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/PredicatedBuffer.java
Index: PredicatedBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/PredicatedBuffer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PredicatedBuffer.java 18 Feb 2004 00:58:18 -0000 1.3
+++ PredicatedBuffer.java 15 May 2004 12:33:23 -0000 1.4
@@ -42,6 +42,7 @@
*
* @param buffer the buffer to decorate, must not be null
* @param predicate the predicate to use for validation, must not be null
+ * @return a new predicated Buffer
* @throws IllegalArgumentException if buffer or predicate is null
* @throws IllegalArgumentException if the buffer contains invalid elements
*/
1.4 +2 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java
Index: SynchronizedBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SynchronizedBuffer.java 18 Feb 2004 00:58:18 -0000 1.3
+++ SynchronizedBuffer.java 15 May 2004 12:33:23 -0000 1.4
@@ -35,6 +35,7 @@
* Factory method to create a synchronized buffer.
*
* @param buffer the buffer to decorate, must not be null
+ * @return a new synchronized Buffer
* @throws IllegalArgumentException if buffer is null
*/
public static Buffer decorate(Buffer buffer) {
1.5 +2 -1 jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/PriorityBuffer.java
Index: PriorityBuffer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/PriorityBuffer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PriorityBuffer.java 18 Feb 2004 00:58:18 -0000 1.4
+++ PriorityBuffer.java 15 May 2004 12:33:23 -0000 1.5
@@ -230,6 +230,7 @@
* The element added will be sorted according to the comparator in use.
*
* @param element the element to be added
+ * @return true always
*/
public boolean add(Object element) {
if (isAtCapacity()) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org