You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tn...@apache.org on 2012/07/03 22:27:03 UTC
svn commit: r1356916 - in /commons/proper/collections/trunk: ./
src/main/java/org/apache/commons/collections/buffer/
Author: tn
Date: Tue Jul 3 20:27:01 2012
New Revision: 1356916
URL: http://svn.apache.org/viewvc?rev=1356916&view=rev
Log:
Cleanup of buffer package.
Added:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package-info.java
- copied, changed from r1356878, commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package.html
Removed:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package.html
Modified:
commons/proper/collections/trunk/pom.xml
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PriorityBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
Modified: commons/proper/collections/trunk/pom.xml
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/pom.xml?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/pom.xml (original)
+++ commons/proper/collections/trunk/pom.xml Tue Jul 3 20:27:01 2012
@@ -45,10 +45,22 @@
<developers>
<developer>
+ <name>Matt Benson</name>
+ <id>mbenson</id>
+ </developer>
+ <developer>
+ <name>James Carman</name>
+ <id>jcarman</id>
+ </developer>
+ <developer>
<name>Stephen Colebourne</name>
<id>scolebourne</id>
</developer>
<developer>
+ <name>Robert Burrell Donkin</name>
+ <id>rdonkin</id>
+ </developer>
+ <developer>
<name>Morgan Delagrange</name>
<id>morgand</id>
</developer>
@@ -65,6 +77,10 @@
<id>craigmcc</id>
</developer>
<developer>
+ <name>Phil Steitz</name>
+ <id>psteitz</id>
+ </developer>
+ <developer>
<name>Arun M. Thomas</name>
<id>amamment</id>
</developer>
@@ -76,18 +92,6 @@
<name>Henri Yandell</name>
<id>bayard</id>
</developer>
- <developer>
- <name>James Carman</name>
- <id>jcarman</id>
- </developer>
- <developer>
- <name>Robert Burrell Donkin</name>
- <id>rdonkin</id>
- </developer>
- <developer>
- <name>Matt Benson</name>
- <id>mbenson</id>
- </developer>
</developers>
<contributors>
@@ -431,7 +435,7 @@
</configuration>
</plugin>
</plugins>
- </build>
+ </build>
<reporting>
<plugins>
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/AbstractBufferDecorator.java Tue Jul 3 20:27:01 2012
@@ -20,18 +20,16 @@ import org.apache.commons.collections.Bu
import org.apache.commons.collections.collection.AbstractCollectionDecorator;
/**
- * Decorates another <code>Buffer</code> to provide additional behaviour.
+ * Decorates another {@link Buffer} to provide additional behaviour.
* <p>
* Methods are forwarded directly to the decorated buffer.
*
* @param <E> the type of the elements in the buffer
* @since Commons Collections 3.0
- * @version $Revision$
- *
- * @author Stephen Colebourne
+ * @version $Id$
*/
-public abstract class AbstractBufferDecorator<E> extends AbstractCollectionDecorator<E> implements
- Buffer<E> {
+public abstract class AbstractBufferDecorator<E> extends AbstractCollectionDecorator<E>
+ implements Buffer<E> {
/** Serialization version */
private static final long serialVersionUID = -2629815475789577029L;
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BlockingBuffer.java Tue Jul 3 20:27:01 2012
@@ -24,14 +24,14 @@ import org.apache.commons.collections.Bu
import org.apache.commons.collections.BufferUnderflowException;
/**
- * Decorates another <code>Buffer</code> to make {@link #get()} and
+ * Decorates another {@link Buffer} to make {@link #get()} and
* {@link #remove()} block when the <code>Buffer</code> is empty.
* <p>
* If either <code>get</code> or <code>remove</code> is called on an empty
- * <code>Buffer</code>, the calling thread waits for notification that
+ * {@link Buffer}, the calling thread waits for notification that
* an <code>add</code> or <code>addAll</code> operation has completed.
* <p>
- * When one or more entries are added to an empty <code>Buffer</code>,
+ * When one or more entries are added to an empty {@link Buffer},
* all threads blocked in <code>get</code> or <code>remove</code> are notified.
* There is no guarantee that concurrent blocked <code>get</code> or
* <code>remove</code> requests will be "unblocked" and receive data in the
@@ -41,10 +41,6 @@ import org.apache.commons.collections.Bu
* This class contains an extra field in 3.2, however the serialization
* specification will handle this gracefully.
*
- * @author Stephen Colebourne
- * @author Janek Bogucki
- * @author Phil Steitz
- * @author James Carman
* @param <E> the type of the elements in the buffer
* @version $Revision$
* @since Commons Collections 3.0
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedBuffer.java Tue Jul 3 20:27:01 2012
@@ -28,7 +28,7 @@ import org.apache.commons.collections.Bu
import org.apache.commons.collections.iterators.AbstractIteratorDecorator;
/**
- * Decorates another <code>Buffer</code> to ensure a fixed maximum size.
+ * Decorates another {@link Buffer} to ensure a fixed maximum size.
* <p>
* Note: This class should only be used if you need to add bounded
* behaviour to another buffer. If you just want a bounded buffer then
@@ -40,10 +40,8 @@ import org.apache.commons.collections.it
* With a timeout, the add methods will wait for up to the timeout period
* to try and add the elements.
*
- * @author James Carman
- * @author Stephen Colebourne
- * @version $Revision$
* @since Commons Collections 3.2
+ * @version $Id$
*/
public class BoundedBuffer<E> extends SynchronizedBuffer<E> implements BoundedCollection<E> {
@@ -59,7 +57,7 @@ public class BoundedBuffer<E> extends Sy
* Factory method to create a bounded buffer.
* <p>
* When the buffer is full, it will immediately throw a
- * <code>BufferOverflowException</code> on calling <code>add()</code>.
+ * <code>BufferOverflowException</code> on calling {@link #add(Object)}.
*
* @param <E> the type of the elements in the buffer
* @param buffer the buffer to decorate, must not be null
@@ -139,6 +137,14 @@ public class BoundedBuffer<E> extends Sy
return new NotifyingIterator(collection.iterator());
}
+ /**
+ * Waits up to the specified timeout period that the given number of additions
+ * can be made to the buffer.
+ *
+ * @param nAdditions the number of additions
+ * @throws BufferOverflowException if the number of additions would overflow the buffer,
+ * or the timeout has expired
+ */
private void timeoutWait(final int nAdditions) {
// method synchronized by callers
if (nAdditions > maximumSize) {
@@ -192,6 +198,11 @@ public class BoundedBuffer<E> extends Sy
*/
private class NotifyingIterator extends AbstractIteratorDecorator<E> {
+ /**
+ * Create a new {@link NotifyingIterator}.
+ *
+ * @param it the decorated {@link Iterator}
+ */
public NotifyingIterator(Iterator<E> it) {
super(it);
}
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java Tue Jul 3 20:27:01 2012
@@ -32,10 +32,10 @@ import org.apache.commons.collections.Bu
import org.apache.commons.collections.BufferUnderflowException;
/**
- * The BoundedFifoBuffer is a very efficient implementation of
- * <code>Buffer</code> that is of a fixed size.
+ * The {@link BoundedFifoBuffer} is a very efficient implementation of a
+ * {@link Buffer} with a fixed size.
* <p>
- * The removal order of a <code>BoundedFifoBuffer</code> is based on the
+ * The removal order of a {@link BoundedFifoBuffer} is based on the
* insertion order; elements are removed in the same order in which they
* were added. The iteration order is the same as the removal order.
* <p>
@@ -54,13 +54,7 @@ import org.apache.commons.collections.Bu
* This class is Serializable from Commons Collections 3.1.
*
* @since Commons Collections 3.0 (previously in main package v2.1)
- * @version $Revision$
- *
- * @author Avalon
- * @author Berin Loritsch
- * @author Paul Jack
- * @author Stephen Colebourne
- * @author Herve Quiroz
+ * @version $Id$
*/
public class BoundedFifoBuffer<E> extends AbstractCollection<E>
implements Buffer<E>, BoundedCollection<E>, Serializable {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java Tue Jul 3 20:27:01 2012
@@ -22,7 +22,7 @@ import java.util.Collection;
* CircularFifoBuffer is a first in first out buffer with a fixed size that
* replaces its oldest element if full.
* <p>
- * The removal order of a <code>CircularFifoBuffer</code> is based on the
+ * The removal order of a {@link CircularFifoBuffer} is based on the
* insertion order; elements are removed in the same order in which they
* were added. The iteration order is the same as the removal order.
* <p>
@@ -41,10 +41,7 @@ import java.util.Collection;
* This class is Serializable from Commons Collections 3.1.
*
* @since Commons Collections 3.0
- * @version $Revision$
- *
- * @author Stefano Fornari
- * @author Stephen Colebourne
+ * @version $Id$
*/
public class CircularFifoBuffer<E> extends BoundedFifoBuffer<E> {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PredicatedBuffer.java Tue Jul 3 20:27:01 2012
@@ -21,7 +21,7 @@ import org.apache.commons.collections.Pr
import org.apache.commons.collections.collection.PredicatedCollection;
/**
- * Decorates another <code>Buffer</code> to validate that additions
+ * Decorates another {@link Buffer} to validate that additions
* match a specified predicate.
* <p>
* This buffer exists to provide validation for the decorated buffer.
@@ -34,10 +34,7 @@ import org.apache.commons.collections.co
* This class is Serializable from Commons Collections 3.1.
*
* @since Commons Collections 3.0
- * @version $Revision$
- *
- * @author Stephen Colebourne
- * @author Paul Jack
+ * @version $Id$
*/
public class PredicatedBuffer<E> extends PredicatedCollection<E> implements Buffer<E> {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PriorityBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PriorityBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PriorityBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/PriorityBuffer.java Tue Jul 3 20:27:01 2012
@@ -27,7 +27,7 @@ import org.apache.commons.collections.Bu
import org.apache.commons.collections.comparators.ComparableComparator;
/**
- * Binary heap implementation of <code>Buffer</code> that provides for
+ * Binary heap implementation of {@link Buffer} that provides for
* removal based on <code>Comparator</code> ordering.
* <p>
* The removal order of a binary heap is based on either the natural sort
@@ -54,14 +54,7 @@ import org.apache.commons.collections.co
* This class is Serializable from Commons Collections 3.2.
*
* @since Commons Collections 3.0 (previously BinaryHeap v1.0)
- * @version $Revision$
- *
- * @author Peter Donald
- * @author Ram Chidambaram
- * @author Michael A. Smith
- * @author Paul Jack
- * @author Stephen Colebourne
- * @author Steve Phelps
+ * @version $Id$
*/
public class PriorityBuffer<E> extends AbstractCollection<E> implements Buffer<E>, Serializable {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/SynchronizedBuffer.java Tue Jul 3 20:27:01 2012
@@ -20,7 +20,7 @@ import org.apache.commons.collections.Bu
import org.apache.commons.collections.collection.SynchronizedCollection;
/**
- * Decorates another <code>Buffer</code> to synchronize its behaviour
+ * Decorates another {@link Buffer} to synchronize its behaviour
* for a multi-threaded environment.
* <p>
* Methods are synchronized, then forwarded to the decorated buffer.
@@ -29,9 +29,7 @@ import org.apache.commons.collections.co
*
* @param <E> the type of the elements in the buffer
* @since Commons Collections 3.0
- * @version $Revision$
- *
- * @author Stephen Colebourne
+ * @version $Id$
*/
public class SynchronizedBuffer<E>
extends SynchronizedCollection<E>
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/TransformedBuffer.java Tue Jul 3 20:27:01 2012
@@ -21,7 +21,7 @@ import org.apache.commons.collections.Tr
import org.apache.commons.collections.collection.TransformedCollection;
/**
- * Decorates another <code>Buffer</code> to transform objects that are added.
+ * Decorates another {@link Buffer} to transform objects that are added.
* <p>
* The add methods are affected by this class.
* Thus objects must be removed or searched for using their transformed form.
@@ -31,9 +31,7 @@ import org.apache.commons.collections.co
* This class is Serializable from Commons Collections 3.1.
*
* @since Commons Collections 3.0
- * @version $Revision$
- *
- * @author Stephen Colebourne
+ * @version $Id$
*/
public class TransformedBuffer<E> extends TransformedCollection<E> implements Buffer<E> {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java Tue Jul 3 20:27:01 2012
@@ -29,11 +29,11 @@ import org.apache.commons.collections.Bu
/**
* UnboundedFifoBuffer is a very efficient implementation of
- * <code>Buffer</code> that can grow to any size.
+ * {@link Buffer} that can grow to any size.
* According to performance testing, it exhibits a constant access time, but it
* also outperforms ArrayList when used for the same purpose.
* <p>
- * The removal order of an <code>UnboundedFifoBuffer</code> is based on the insertion
+ * The removal order of an {@link UnboundedFifoBuffer} is based on the insertion
* order; elements are removed in the same order in which they were added.
* The iteration order is the same as the removal order.
* <p>
@@ -52,16 +52,7 @@ import org.apache.commons.collections.Bu
* This class is Serializable from Commons Collections 3.1.
*
* @since Commons Collections 3.0 (previously in main package v2.1)
- * @version $Revision$
- *
- * @author Avalon
- * @author Federico Barbieri
- * @author Berin Loritsch
- * @author Paul Jack
- * @author Stephen Colebourne
- * @author Andreas Schlosser
- * @author Thomas Knych
- * @author Jordan Krey
+ * @version $Id$
*/
public class UnboundedFifoBuffer<E> extends AbstractCollection<E> implements Buffer<E>, Serializable {
// invariant: buffer.length > size()
@@ -113,7 +104,7 @@ public class UnboundedFifoBuffer<E> exte
* Write the buffer out using a custom routine.
*
* @param out the output stream
- * @throws IOException
+ * @throws IOException if an I/O error occurs while writing to the output stream
*/
private void writeObject(ObjectOutputStream out) throws IOException {
out.defaultWriteObject();
@@ -128,8 +119,8 @@ public class UnboundedFifoBuffer<E> exte
* Read the buffer in using a custom routine.
*
* @param in the input stream
- * @throws IOException
- * @throws ClassNotFoundException
+ * @throws IOException if an I/O error occurs while reading from the input stream
+ * @throws ClassNotFoundException if the class of a serialized object can not be found
*/
@SuppressWarnings("unchecked")
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java?rev=1356916&r1=1356915&r2=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/UnmodifiableBuffer.java Tue Jul 3 20:27:01 2012
@@ -28,16 +28,14 @@ import org.apache.commons.collections.Un
import org.apache.commons.collections.iterators.UnmodifiableIterator;
/**
- * Decorates another <code>Buffer</code> to ensure it can't be altered.
+ * Decorates another {@link Buffer} to ensure it can't be altered.
* <p>
* This class is Serializable from Commons Collections 3.1.
* <p>
* Attempts to modify it will result in an UnsupportedOperationException.
*
* @since Commons Collections 3.0
- * @version $Revision$
- *
- * @author Stephen Colebourne
+ * @version $Id$
*/
public final class UnmodifiableBuffer<E>
extends AbstractBufferDecorator<E>
@@ -79,7 +77,7 @@ public final class UnmodifiableBuffer<E>
* Write the collection out using a custom routine.
*
* @param out the output stream
- * @throws IOException
+ * @throws IOException if an I/O error occurs while writing to the output stream
*/
private void writeObject(ObjectOutputStream out) throws IOException {
out.defaultWriteObject();
@@ -90,8 +88,8 @@ public final class UnmodifiableBuffer<E>
* Read the collection in using a custom routine.
*
* @param in the input stream
- * @throws IOException
- * @throws ClassNotFoundException
+ * @throws IOException if an I/O error occurs while reading from the input stream
+ * @throws ClassNotFoundException if the class of a serialized object can not be found
*/
@SuppressWarnings("unchecked")
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
Copied: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package-info.java (from r1356878, commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package.html)
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package-info.java?p2=commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package-info.java&p1=commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package.html&r1=1356878&r2=1356916&rev=1356916&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package.html (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/buffer/package-info.java Tue Jul 3 20:27:01 2012
@@ -1,41 +1,41 @@
-<!-- $Id$ -->
- <!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-<BODY>
-<p>
-This package contains implementations of the
-{@link org.apache.commons.collections.Buffer Buffer} interface.
-<p>
-The following implementations are provided in the package:
-<ul>
-<li>PriorityBuffer - provides for removal based on a comparator ordering
-<li>BoundedFifoBuffer - implements a buffer with a fixed size that throws exceptions when full
-<li>CircularFifoBuffer - implements a buffer with a fixed size that discards oldest when full
-<li>UnboundedFifoBuffer - implements a buffer that grows in size if necessary
-</ul>
-<p>
-The following decorators are provided in the package:
-<ul>
-<li>Synchronized - synchronizes method access for multi-threaded environments
-<li>Unmodifiable - ensures the collection cannot be altered
-<li>Predicated - ensures that only elements that are valid according to a predicate can be added
-<li>Typed - ensures that only elements that are of a specific type can be added
-<li>Transformed - transforms elements added to the buffer
-<li>Blocking - blocks on get and remove until an element is available
-</ul>
-</pre>
-</BODY>
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * This package contains implementations of the
+ * {@link org.apache.commons.collections.Buffer Buffer} interface.
+ * <p>
+ * The following implementations are provided in the package:
+ * <ul>
+ * <li>PriorityBuffer - provides for removal based on a comparator ordering
+ * <li>BoundedFifoBuffer - implements a buffer with a fixed size that throws exceptions when full
+ * <li>CircularFifoBuffer - implements a buffer with a fixed size that discards oldest when full
+ * <li>UnboundedFifoBuffer - implements a buffer that grows in size if necessary
+ * </ul>
+ * <p>
+ * The following decorators are provided in the package:
+ * <ul>
+ * <li>Synchronized - synchronizes method access for multi-threaded environments
+ * <li>Unmodifiable - ensures the collection cannot be altered
+ * <li>Predicated - ensures that only elements that are valid according to a predicate can be added
+ * <li>Typed - ensures that only elements that are of a specific type can be added
+ * <li>Transformed - transforms elements added to the buffer
+ * <li>Blocking - blocks on get and remove until an element is available
+ * </ul>
+ *
+ * @version $Id$
+ */
+package org.apache.commons.collections.buffer;
\ No newline at end of file