diff --git a/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java b/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java index 8863c14ef..79b9d5491 100644 --- a/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java +++ b/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java @@ -65,10 +65,17 @@ public abstract class AbstractBufferDecorator extends AbstractCollectionDecor } //----------------------------------------------------------------------- + + /** + * {@inheritDoc} + */ public E get() { return decorated().get(); } + /** + * {@inheritDoc} + */ public E remove() { return decorated().remove(); } diff --git a/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java b/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java index 276bbb1a8..3e186e063 100644 --- a/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java @@ -59,26 +59,27 @@ public class BlockingBuffer extends SynchronizedBuffer { /** * Factory method to create a blocking buffer. * - * @param the type of the elements in the buffer + * @param the type of the elements in the 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 blockingBuffer(Buffer buffer) { - return new BlockingBuffer(buffer); + public static BlockingBuffer blockingBuffer(Buffer buffer) { + return new BlockingBuffer(buffer); } /** * Factory method to create a blocking buffer with a timeout value. * + * @param the type of the elements in the buffer * @param buffer the buffer to decorate, must not be null * @param timeoutMillis the timeout value in milliseconds, zero or less for no timeout * @return a new blocking buffer * @throws IllegalArgumentException if the buffer is null * @since Commons Collections 3.2 */ - public static Buffer blockingBuffer(Buffer buffer, long timeoutMillis) { - return new BlockingBuffer(buffer, timeoutMillis); + public static BlockingBuffer blockingBuffer(Buffer buffer, long timeoutMillis) { + return new BlockingBuffer(buffer, timeoutMillis); } //----------------------------------------------------------------------- @@ -131,6 +132,7 @@ public class BlockingBuffer extends SynchronizedBuffer { * set in the constructor. * * @throws BufferUnderflowException if an interrupt is received + * {@inheritDoc} */ @Override public E get() { @@ -157,6 +159,7 @@ public class BlockingBuffer extends SynchronizedBuffer { * added for up to the specified timeout value if the buffer is empty. * * @param timeout the timeout value in milliseconds + * @return the next object in the buffer * @throws BufferUnderflowException if an interrupt is received * @throws BufferUnderflowException if the timeout expires * @since Commons Collections 3.2 @@ -188,6 +191,7 @@ public class BlockingBuffer extends SynchronizedBuffer { * set in the constructor. * * @throws BufferUnderflowException if an interrupt is received + * {@inheritDoc} */ @Override public E remove() { @@ -214,6 +218,7 @@ public class BlockingBuffer extends SynchronizedBuffer { * added for up to the specified timeout value if the buffer is empty. * * @param timeout the timeout value in milliseconds + * @return the next object in the buffer, which is also removed * @throws BufferUnderflowException if an interrupt is received * @throws BufferUnderflowException if the timeout expires * @since Commons Collections 3.2 diff --git a/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java b/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java index 49cbcb661..1ff85eb77 100644 --- a/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java @@ -61,6 +61,7 @@ public class BoundedBuffer extends SynchronizedBuffer implements BoundedCo * When the buffer is full, it will immediately throw a * BufferOverflowException on calling add(). * + * @param the type of the elements in the buffer * @param buffer the buffer to decorate, must not be null * @param maximumSize the maximum size, must be size one or greater * @return a new bounded buffer @@ -75,6 +76,7 @@ public class BoundedBuffer extends SynchronizedBuffer implements BoundedCo * Factory method to create a bounded buffer that blocks for a maximum * amount of time. * + * @param the type of the elements in the buffer * @param buffer the buffer to decorate, must not be null * @param maximumSize the maximum size, must be size one or greater * @param timeout the maximum amount of time to wait in milliseconds @@ -169,11 +171,17 @@ public class BoundedBuffer extends SynchronizedBuffer implements BoundedCo } } + /** + * {@inheritDoc} + */ public boolean isFull() { // size() is synchronized return (size() == maxSize()); } + /** + * {@inheritDoc} + */ public int maxSize() { return maximumSize; } diff --git a/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java b/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java index a85122607..d8517c1b8 100644 --- a/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java @@ -50,14 +50,15 @@ public class PredicatedBuffer extends PredicatedCollection implements Buff * If there are any elements already in the buffer being decorated, they * are validated. * + * @param the type of the elements in the buffer * @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 */ - public static Buffer predicatedBuffer(Buffer buffer, Predicate predicate) { - return new PredicatedBuffer(buffer, predicate); + public static PredicatedBuffer predicatedBuffer(Buffer buffer, Predicate predicate) { + return new PredicatedBuffer(buffer, predicate); } //----------------------------------------------------------------------- @@ -87,10 +88,17 @@ public class PredicatedBuffer extends PredicatedCollection implements Buff } //----------------------------------------------------------------------- + + /** + * {@inheritDoc} + */ public E get() { return decorated().get(); } + /** + * {@inheritDoc} + */ public E remove() { return decorated().remove(); } diff --git a/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java b/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java index ca9b2b581..2ae6a145a 100644 --- a/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java @@ -43,13 +43,13 @@ public class SynchronizedBuffer /** * Factory method to create a synchronized buffer. * - * @param the type of the elements in the buffer + * @param the type of the elements in the 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 synchronizedBuffer(Buffer buffer) { - return new SynchronizedBuffer(buffer); + public static SynchronizedBuffer synchronizedBuffer(Buffer buffer) { + return new SynchronizedBuffer(buffer); } //----------------------------------------------------------------------- @@ -85,12 +85,19 @@ public class SynchronizedBuffer } //----------------------------------------------------------------------- + + /** + * {@inheritDoc} + */ public E get() { synchronized (lock) { return decorated().get(); } } + /** + * {@inheritDoc} + */ public E remove() { synchronized (lock) { return decorated().remove(); diff --git a/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java b/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java index 6d5e02b74..11c5de4c7 100644 --- a/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java @@ -47,12 +47,14 @@ public class TransformedBuffer extends TransformedCollection implements Bu * are NOT transformed. * Contrast this with {@link #transformedBuffer(Buffer, Transformer)}. * + * @param the type of the elements in the buffer * @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 transformingBuffer(Buffer buffer, Transformer transformer) { + public static TransformedBuffer transformingBuffer(Buffer buffer, + Transformer transformer) { return new TransformedBuffer(buffer, transformer); } @@ -64,14 +66,17 @@ public class TransformedBuffer extends TransformedCollection implements Bu * will be transformed by this method. * Contrast this with {@link #transformingBuffer(Buffer, Transformer)}. * + * @param the type of the elements in the buffer * @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 * @since Commons Collections 3.3 */ - public static Buffer transformedBuffer(Buffer buffer, Transformer transformer) { - TransformedBuffer decorated = new TransformedBuffer(buffer, transformer); // throws IAE if buffer or transformer is null + public static TransformedBuffer transformedBuffer(Buffer buffer, + Transformer transformer) { + // throws IAE if buffer or transformer is null + final TransformedBuffer decorated = new TransformedBuffer(buffer, transformer); if (buffer.size() > 0) { @SuppressWarnings("unchecked") // buffer is type E[] values = (E[]) buffer.toArray(); @@ -108,10 +113,17 @@ public class TransformedBuffer extends TransformedCollection implements Bu } //----------------------------------------------------------------------- + + /** + * {@inheritDoc} + */ public E get() { return getBuffer().get(); } + /** + * {@inheritDoc} + */ public E remove() { return getBuffer().remove(); } diff --git a/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java b/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java index cd14d4661..836dbb95e 100644 --- a/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java @@ -67,7 +67,7 @@ public class UnboundedFifoBuffer extends AbstractCollection implements Buf // invariant: buffer.length > size() // ie.buffer always has at least one empty entry - /** Serialization vesrion */ + /** Serialization version */ private static final long serialVersionUID = -3482960336579541419L; /** The array of objects in the buffer. */ diff --git a/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java b/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java index bb89f5a5c..63b752993 100644 --- a/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java +++ b/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java @@ -51,6 +51,7 @@ public final class UnmodifiableBuffer *

* If the buffer passed in is already unmodifiable, it is returned. * + * @param the type of the elements in the buffer * @param buffer the buffer to decorate, must not be null * @return an unmodifiable Buffer * @throws IllegalArgumentException if buffer is null