* This buffer prevents null objects from being added. * + * @deprecated Moved to buffer subpackage. Due to be removed in v4.0. * @since 2.1 - * @version $Revision: 1.11 $ $Date: 2003/11/18 22:50:44 $ + * @version $Revision: 1.12 $ $Date: 2003/11/29 18:04:57 $ * * @author Avalon * @author Berin Loritsch @@ -94,7 +95,9 @@ import org.apache.commons.collections.collection.BoundedCollection; * @author Stephen Colebourne * @author Herve Quiroz */ -public class BoundedFifoBuffer extends AbstractCollection implements Buffer, BoundedCollection { +public class BoundedFifoBuffer extends AbstractCollection + implements Buffer, BoundedCollection { + private final Object[] m_elements; private int m_start = 0; private int m_end = 0; diff --git a/src/java/org/apache/commons/collections/CircularFifoBuffer.java b/src/java/org/apache/commons/collections/CircularFifoBuffer.java index 4ac278ab3..6014a7e16 100644 --- a/src/java/org/apache/commons/collections/CircularFifoBuffer.java +++ b/src/java/org/apache/commons/collections/CircularFifoBuffer.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/CircularFifoBuffer.java,v 1.4 2003/08/31 17:26:44 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/CircularFifoBuffer.java,v 1.5 2003/11/29 18:04:57 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -59,8 +59,6 @@ package org.apache.commons.collections; import java.util.Collection; -import org.apache.commons.collections.BoundedFifoBuffer; - /** * CircularFifoBuffer is a first in first out buffer with a fixed size that * replaces its oldest element if full. @@ -81,8 +79,9 @@ import org.apache.commons.collections.BoundedFifoBuffer; *
* This buffer prevents null objects from being added. * + * @deprecated WILL BE REMOVED BEFORE v3.0 * @since Commons Collections 3.0 - * @version $Revision: 1.4 $ $Date: 2003/08/31 17:26:44 $ + * @version $Revision: 1.5 $ $Date: 2003/11/29 18:04:57 $ * * @author Stefano Fornari * @author Stephen Colebourne diff --git a/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java b/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java index e2ff5e022..02f3dd1ba 100644 --- a/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java +++ b/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java,v 1.11 2003/10/14 18:06:41 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/UnboundedFifoBuffer.java,v 1.12 2003/11/29 18:04:57 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -82,8 +82,9 @@ import java.util.NoSuchElementException; *
* This buffer prevents null objects from being added.
*
+ * @deprecated Moved to buffer subpackage. Due to be removed in v4.0.
* @since Commons Collections 2.1
- * @version $Revision: 1.11 $ $Date: 2003/10/14 18:06:41 $
+ * @version $Revision: 1.12 $ $Date: 2003/11/29 18:04:57 $
*
* @author Avalon
* @author Federico Barbieri
diff --git a/src/java/org/apache/commons/collections/buffer/BinaryHeap.java b/src/java/org/apache/commons/collections/buffer/BinaryHeap.java
new file mode 100644
index 000000000..ac68573bb
--- /dev/null
+++ b/src/java/org/apache/commons/collections/buffer/BinaryHeap.java
@@ -0,0 +1,562 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/Attic/BinaryHeap.java,v 1.1 2003/11/29 18:04:57 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgement:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgement may appear in the software itself,
+ * if and wherever such third-party acknowledgements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ *
+ * The removal order of a binary heap is based on either the natural sort
+ * order of its elements or a specified {@link Comparator}. The
+ * {@link #remove()} method always returns the first element as determined
+ * by the sort order. (The isMinHeap flag in the constructors
+ * can be used to reverse the sort order, in which case {@link #remove()}
+ * will always remove the last element.) The removal order is
+ * not the same as the order of iteration; elements are
+ * returned by the iterator in no particular order.
+ *
+ * The {@link #add(Object)} and {@link #remove()} operations perform + * in logarithmic time. The {@link #get()} operation performs in constant + * time. All other operations perform in linear time or worse. + *
+ * Note that this implementation is not synchronized. Use
+ * {@link BufferUtils#synchronizedBuffer(Buffer)} to provide
+ * synchronized access to a BinaryHeap:
+ *
+ *
+ * Buffer heap = BufferUtils.synchronizedBuffer(new BinaryHeap()); + *+ * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/11/29 18:04:57 $ + * + * @author Peter Donald + * @author Ram Chidambaram + * @author Michael A. Smith + * @author Paul Jack + * @author Stephen Colebourne + */ +public final class BinaryHeap extends AbstractCollection + implements PriorityQueue, Buffer { + + /** + * The default capacity for a binary heap. + */ + private final static int DEFAULT_CAPACITY = 13; + /** + * The number of elements currently in this heap. + */ + int m_size; // package scoped for testing + /** + * The elements in this heap. + */ + Object[] m_elements; // package scoped for testing + /** + * If true, the first element as determined by the sort order will + * be returned. If false, the last element as determined by the + * sort order will be returned. + */ + boolean m_isMinHeap; // package scoped for testing + /** + * The comparator used to order the elements + */ + Comparator m_comparator; // package scoped for testing + + /** + * Constructs a new minimum binary heap. + */ + public BinaryHeap() { + this(DEFAULT_CAPACITY, true); + } + + /** + * Constructs a new
BinaryHeap that will use the given
+ * comparator to order its elements.
+ *
+ * @param comparator the comparator used to order the elements, null
+ * means use natural order
+ */
+ public BinaryHeap(Comparator comparator) {
+ this();
+ m_comparator = comparator;
+ }
+
+ /**
+ * Constructs a new minimum binary heap with the specified initial capacity.
+ *
+ * @param capacity The initial capacity for the heap. This value must
+ * be greater than zero.
+ * @throws IllegalArgumentException
+ * if capacity is <= 0
+ */
+ public BinaryHeap(int capacity) {
+ this(capacity, true);
+ }
+
+ /**
+ * Constructs a new BinaryHeap.
+ *
+ * @param capacity the initial capacity for the heap
+ * @param comparator the comparator used to order the elements, null
+ * means use natural order
+ * @throws IllegalArgumentException
+ * if capacity is <= 0
+ */
+ public BinaryHeap(int capacity, Comparator comparator) {
+ this(capacity);
+ m_comparator = comparator;
+ }
+
+ /**
+ * Constructs a new minimum or maximum binary heap
+ *
+ * @param isMinHeap if true the heap is created as a
+ * minimum heap; otherwise, the heap is created as a maximum heap
+ */
+ public BinaryHeap(boolean isMinHeap) {
+ this(DEFAULT_CAPACITY, isMinHeap);
+ }
+
+ /**
+ * Constructs a new BinaryHeap.
+ *
+ * @param isMinHeap true to use the order imposed by the given
+ * comparator; false to reverse that order
+ * @param comparator the comparator used to order the elements, null
+ * means use natural order
+ */
+ public BinaryHeap(boolean isMinHeap, Comparator comparator) {
+ this(isMinHeap);
+ m_comparator = comparator;
+ }
+
+ /**
+ * Constructs a new minimum or maximum binary heap with the specified
+ * initial capacity.
+ *
+ * @param capacity the initial capacity for the heap. This value must
+ * be greater than zero.
+ * @param isMinHeap if true the heap is created as a
+ * minimum heap; otherwise, the heap is created as a maximum heap.
+ * @throws IllegalArgumentException
+ * if capacity is <= 0
+ */
+ public BinaryHeap(int capacity, boolean isMinHeap) {
+ if (capacity <= 0) {
+ throw new IllegalArgumentException("invalid capacity");
+ }
+ m_isMinHeap = isMinHeap;
+
+ //+1 as 0 is noop
+ m_elements = new Object[capacity + 1];
+ }
+
+ /**
+ * Constructs a new BinaryHeap.
+ *
+ * @param capacity the initial capacity for the heap
+ * @param isMinHeap true to use the order imposed by the given
+ * comparator; false to reverse that order
+ * @param comparator the comparator used to order the elements, null
+ * means use natural order
+ * @throws IllegalArgumentException
+ * if capacity is <= 0
+ */
+ public BinaryHeap(int capacity, boolean isMinHeap, Comparator comparator) {
+ this(capacity, isMinHeap);
+ m_comparator = comparator;
+ }
+
+
+ /**
+ * Clears all elements from queue.
+ */
+ public void clear() {
+ m_elements = new Object[m_elements.length]; // for gc
+ m_size = 0;
+ }
+
+ /**
+ * Tests if queue is empty.
+ *
+ * @return true if queue is empty; false
+ * otherwise.
+ */
+ public boolean isEmpty() {
+ return m_size == 0;
+ }
+
+ /**
+ * Tests if queue is full.
+ *
+ * @return true if queue is full; false
+ * otherwise.
+ */
+ public boolean isFull() {
+ //+1 as element 0 is noop
+ return m_elements.length == m_size + 1;
+ }
+
+ /**
+ * Inserts an element into queue.
+ *
+ * @param element the element to be inserted
+ */
+ public void insert(Object element) {
+ if (isFull()) {
+ grow();
+ }
+ //percolate element to it's place in tree
+ if (m_isMinHeap) {
+ percolateUpMinHeap(element);
+ } else {
+ percolateUpMaxHeap(element);
+ }
+ }
+
+ /**
+ * Returns the element on top of heap but don't remove it.
+ *
+ * @return the element at top of heap
+ * @throws NoSuchElementException if isEmpty() == true
+ */
+ public Object peek() throws NoSuchElementException {
+ if (isEmpty()) {
+ throw new NoSuchElementException();
+ } else {
+ return m_elements[1];
+ }
+ }
+
+ /**
+ * Returns the element on top of heap and remove it.
+ *
+ * @return the element at top of heap
+ * @throws NoSuchElementException if isEmpty() == true
+ */
+ public Object pop() throws NoSuchElementException {
+ final Object result = peek();
+ m_elements[1] = m_elements[m_size--];
+
+ // set the unused element to 'null' so that the garbage collector
+ // can free the object if not used anywhere else.(remove reference)
+ m_elements[m_size + 1] = null;
+
+ if (m_size != 0) {
+ // percolate top element to it's place in tree
+ if (m_isMinHeap) {
+ percolateDownMinHeap(1);
+ } else {
+ percolateDownMaxHeap(1);
+ }
+ }
+
+ return result;
+ }
+
+ /**
+ * Percolates element down heap from top.
+ * Assume it is a maximum heap.
+ *
+ * @param index the index for the element
+ */
+ protected void percolateDownMinHeap(final int index) {
+ final Object element = m_elements[index];
+ int hole = index;
+
+ while ((hole * 2) <= m_size) {
+ int child = hole * 2;
+
+ // if we have a right child and that child can not be percolated
+ // up then move onto other child
+ if (child != m_size && compare(m_elements[child + 1], m_elements[child]) < 0) {
+ child++;
+ }
+
+ // if we found resting place of bubble then terminate search
+ if (compare(m_elements[child], element) >= 0) {
+ break;
+ }
+
+ m_elements[hole] = m_elements[child];
+ hole = child;
+ }
+
+ m_elements[hole] = element;
+ }
+
+ /**
+ * Percolates element down heap from top.
+ * Assume it is a maximum heap.
+ *
+ * @param index the index of the element
+ */
+ protected void percolateDownMaxHeap(final int index) {
+ final Object element = m_elements[index];
+ int hole = index;
+
+ while ((hole * 2) <= m_size) {
+ int child = hole * 2;
+
+ // if we have a right child and that child can not be percolated
+ // up then move onto other child
+ if (child != m_size && compare(m_elements[child + 1], m_elements[child]) > 0) {
+ child++;
+ }
+
+ // if we found resting place of bubble then terminate search
+ if (compare(m_elements[child], element) <= 0) {
+ break;
+ }
+
+ m_elements[hole] = m_elements[child];
+ hole = child;
+ }
+
+ m_elements[hole] = element;
+ }
+
+ /**
+ * Percolates element up heap from bottom.
+ * Assume it is a maximum heap.
+ *
+ * @param element the element
+ */
+ protected void percolateUpMinHeap(final Object element) {
+ int hole = ++m_size;
+
+ m_elements[hole] = element;
+
+ while (hole > 1 && compare(element, m_elements[hole / 2]) < 0) {
+ // save element that is being pushed down
+ // as the element "bubble" is percolated up
+ final int next = hole / 2;
+ m_elements[hole] = m_elements[next];
+ hole = next;
+ }
+
+ m_elements[hole] = element;
+ }
+
+ /**
+ * Percolates element up heap from bottom.
+ * Assume it is a maximum heap.
+ *
+ * @param element the element
+ */
+ protected void percolateUpMaxHeap(final Object element) {
+ int hole = ++m_size;
+
+ while (hole > 1 && compare(element, m_elements[hole / 2]) > 0) {
+ // save element that is being pushed down
+ // as the element "bubble" is percolated up
+ final int next = hole / 2;
+ m_elements[hole] = m_elements[next];
+ hole = next;
+ }
+
+ m_elements[hole] = element;
+ }
+
+ /**
+ * Compares two objects using the comparator if specified, or the
+ * natural order otherwise.
+ *
+ * @param a the first object
+ * @param b the second object
+ * @return -ve if a less than b, 0 if they are equal, +ve if a greater than b
+ */
+ private int compare(Object a, Object b) {
+ if (m_comparator != null) {
+ return m_comparator.compare(a, b);
+ } else {
+ return ((Comparable) a).compareTo(b);
+ }
+ }
+
+ /**
+ * Increases the size of the heap to support additional elements
+ */
+ protected void grow() {
+ final Object[] elements = new Object[m_elements.length * 2];
+ System.arraycopy(m_elements, 0, elements, 0, m_elements.length);
+ m_elements = elements;
+ }
+
+ /**
+ * Returns a string representation of this heap. The returned string
+ * is similar to those produced by standard JDK collections.
+ *
+ * @return a string representation of this heap
+ */
+ public String toString() {
+ final StringBuffer sb = new StringBuffer();
+
+ sb.append("[ ");
+
+ for (int i = 1; i < m_size + 1; i++) {
+ if (i != 1) {
+ sb.append(", ");
+ }
+ sb.append(m_elements[i]);
+ }
+
+ sb.append(" ]");
+
+ return sb.toString();
+ }
+
+
+ /**
+ * Returns an iterator over this heap's elements.
+ *
+ * @return an iterator over this heap's elements
+ */
+ public Iterator iterator() {
+ return new Iterator() {
+
+ private int index = 1;
+ private int lastReturnedIndex = -1;
+
+ public boolean hasNext() {
+ return index <= m_size;
+ }
+
+ public Object next() {
+ if (!hasNext()) throw new NoSuchElementException();
+ lastReturnedIndex = index;
+ index++;
+ return m_elements[lastReturnedIndex];
+ }
+
+ public void remove() {
+ if (lastReturnedIndex == -1) throw new IllegalStateException();
+ m_elements[ lastReturnedIndex ] = m_elements[ m_size ];
+ m_elements[ m_size ] = null;
+ m_size--;
+ if( m_size != 0 )
+ {
+ //percolate top element to it's place in tree
+ if( m_isMinHeap ) percolateDownMinHeap( lastReturnedIndex );
+ else percolateDownMaxHeap( lastReturnedIndex );
+ }
+ index--;
+ lastReturnedIndex = -1;
+ }
+
+ };
+ }
+
+
+ /**
+ * Adds an object to this heap. Same as {@link #insert(Object)}.
+ *
+ * @param object the object to add
+ * @return true, always
+ */
+ public boolean add(Object object) {
+ insert(object);
+ return true;
+ }
+
+ /**
+ * Returns the priority element. Same as {@link #peek()}.
+ *
+ * @return the priority element
+ * @throws BufferUnderflowException if this heap is empty
+ */
+ public Object get() {
+ try {
+ return peek();
+ } catch (NoSuchElementException e) {
+ throw new BufferUnderflowException();
+ }
+ }
+
+ /**
+ * Removes the priority element. Same as {@link #pop()}.
+ *
+ * @return the removed priority element
+ * @throws BufferUnderflowException if this heap is empty
+ */
+ public Object remove() {
+ try {
+ return pop();
+ } catch (NoSuchElementException e) {
+ throw new BufferUnderflowException();
+ }
+ }
+
+ /**
+ * Returns the number of elements in this heap.
+ *
+ * @return the number of elements in this heap
+ */
+ public int size() {
+ return m_size;
+ }
+
+}
diff --git a/src/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java b/src/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java
new file mode 100644
index 000000000..4c9544cc7
--- /dev/null
+++ b/src/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java
@@ -0,0 +1,356 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java,v 1.1 2003/11/29 18:04:57 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgement:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgement may appear in the software itself,
+ * if and wherever such third-party acknowledgements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ *
+ * The removal order of a 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.
+ *
+ * The {@link #add(Object)}, {@link #remove()} and {@link #get()} operations + * all perform in constant time. All other operations perform in linear + * time or worse. + *
+ * Note that this implementation is not synchronized. The following can be
+ * used to provide synchronized access to your BoundedFifoBuffer:
+ *
+ * Buffer fifo = BufferUtils.synchronizedBuffer(new BoundedFifoBuffer()); + *+ *
+ * This buffer prevents null objects from being added.
+ *
+ * @since Commons Collections 3.0
+ * @version $Revision: 1.1 $ $Date: 2003/11/29 18:04:57 $
+ *
+ * @author Avalon
+ * @author Berin Loritsch
+ * @author Paul Jack
+ * @author Stephen Colebourne
+ * @author Herve Quiroz
+ */
+public class BoundedFifoBuffer extends AbstractCollection
+ implements Buffer, BoundedCollection {
+
+ private final Object[] m_elements;
+ private int m_start = 0;
+ private int m_end = 0;
+ private boolean m_full = false;
+ private final int maxElements;
+
+ /**
+ * Constructs a new BoundedFifoBuffer big enough to hold
+ * 32 elements.
+ */
+ public BoundedFifoBuffer() {
+ this(32);
+ }
+
+ /**
+ * Constructs a new BoundedFifoBuffer big enough to hold
+ * the specified number of elements.
+ *
+ * @param size the maximum number of elements for this fifo
+ * @throws IllegalArgumentException if the size is less than 1
+ */
+ public BoundedFifoBuffer(int size) {
+ if (size <= 0) {
+ throw new IllegalArgumentException("The size must be greater than 0");
+ }
+ m_elements = new Object[size];
+ maxElements = m_elements.length;
+ }
+
+ /**
+ * Constructs a new BoundedFifoBuffer big enough to hold all
+ * of the elements in the specified collection. That collection's
+ * elements will also be added to the buffer.
+ *
+ * @param coll the collection whose elements to add, may not be null
+ * @throws NullPointerException if the collection is null
+ */
+ public BoundedFifoBuffer(Collection coll) {
+ this(coll.size());
+ addAll(coll);
+ }
+
+ /**
+ * Returns the number of elements stored in the buffer.
+ *
+ * @return this buffer's size
+ */
+ public int size() {
+ int size = 0;
+
+ if (m_end < m_start) {
+ size = maxElements - m_start + m_end;
+ } else if (m_end == m_start) {
+ size = (m_full ? maxElements : 0);
+ } else {
+ size = m_end - m_start;
+ }
+
+ return size;
+ }
+
+ /**
+ * Returns true if this buffer is empty; false otherwise.
+ *
+ * @return true if this buffer is empty
+ */
+ public boolean isEmpty() {
+ return size() == 0;
+ }
+
+ /**
+ * Returns true if this collection is full and no new elements can be added.
+ *
+ * @return true if the collection is full
+ */
+ public boolean isFull() {
+ return size() == maxElements;
+ }
+
+ /**
+ * Gets the maximum size of the collection (the bound).
+ *
+ * @return the maximum number of elements the collection can hold
+ */
+ public int maxSize() {
+ return maxElements;
+ }
+
+ /**
+ * Clears this buffer.
+ */
+ public void clear() {
+ m_full = false;
+ m_start = 0;
+ m_end = 0;
+ Arrays.fill(m_elements, null);
+ }
+
+ /**
+ * Adds the given element to this buffer.
+ *
+ * @param element the element to add
+ * @return true, always
+ * @throws NullPointerException if the given element is null
+ * @throws BufferOverflowException if this buffer is full
+ */
+ public boolean add(Object element) {
+ if (null == element) {
+ throw new NullPointerException("Attempted to add null object to buffer");
+ }
+
+ if (m_full) {
+ throw new BufferOverflowException("The buffer cannot hold more than " + maxElements + " objects.");
+ }
+
+ m_elements[m_end++] = element;
+
+ if (m_end >= maxElements) {
+ m_end = 0;
+ }
+
+ if (m_end == m_start) {
+ m_full = true;
+ }
+
+ return true;
+ }
+
+ /**
+ * Returns the least recently inserted element in this buffer.
+ *
+ * @return the least recently inserted element
+ * @throws BufferUnderflowException if the buffer is empty
+ */
+ public Object get() {
+ if (isEmpty()) {
+ throw new BufferUnderflowException("The buffer is already empty");
+ }
+
+ return m_elements[m_start];
+ }
+
+ /**
+ * Removes the least recently inserted element from this buffer.
+ *
+ * @return the least recently inserted element
+ * @throws BufferUnderflowException if the buffer is empty
+ */
+ public Object remove() {
+ if (isEmpty()) {
+ throw new BufferUnderflowException("The buffer is already empty");
+ }
+
+ Object element = m_elements[m_start];
+
+ if (null != element) {
+ m_elements[m_start++] = null;
+
+ if (m_start >= maxElements) {
+ m_start = 0;
+ }
+
+ m_full = false;
+ }
+
+ return element;
+ }
+
+ /**
+ * Increments the internal index.
+ *
+ * @param index the index to increment
+ * @return the updated index
+ */
+ private int increment(int index) {
+ index++;
+ if (index >= maxElements) {
+ index = 0;
+ }
+ return index;
+ }
+
+ /**
+ * Decrements the internal index.
+ *
+ * @param index the index to decrement
+ * @return the updated index
+ */
+ private int decrement(int index) {
+ index--;
+ if (index < 0) {
+ index = maxElements - 1;
+ }
+ return index;
+ }
+
+ /**
+ * Returns an iterator over this buffer's elements.
+ *
+ * @return an iterator over this buffer's elements
+ */
+ public Iterator iterator() {
+ return new Iterator() {
+
+ private int index = m_start;
+ private int lastReturnedIndex = -1;
+ private boolean isFirst = m_full;
+
+ public boolean hasNext() {
+ return isFirst || (index != m_end);
+
+ }
+
+ public Object next() {
+ if (!hasNext()) throw new NoSuchElementException();
+ isFirst = false;
+ lastReturnedIndex = index;
+ index = increment(index);
+ return m_elements[lastReturnedIndex];
+ }
+
+ public void remove() {
+ if (lastReturnedIndex == -1) throw new IllegalStateException();
+
+ // First element can be removed quickly
+ if (lastReturnedIndex == m_start) {
+ BoundedFifoBuffer.this.remove();
+ lastReturnedIndex = -1;
+ return;
+ }
+
+ // Other elements require us to shift the subsequent elements
+ int i = lastReturnedIndex + 1;
+ while (i != m_end) {
+ if (i >= maxElements) {
+ m_elements[i - 1] = m_elements[0];
+ i = 0;
+ } else {
+ m_elements[i - 1] = m_elements[i];
+ i++;
+ }
+ }
+
+ lastReturnedIndex = -1;
+ m_end = decrement(m_end);
+ m_elements[m_end] = null;
+ m_full = false;
+ index = decrement(index);
+ }
+
+ };
+ }
+
+}
diff --git a/src/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java b/src/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java
new file mode 100644
index 000000000..12ce13184
--- /dev/null
+++ b/src/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java
@@ -0,0 +1,132 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/CircularFifoBuffer.java,v 1.1 2003/11/29 18:04:57 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgement:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgement may appear in the software itself,
+ * if and wherever such third-party acknowledgements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ *
+ * The removal order of a 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.
+ *
+ * The {@link #add(Object)}, {@link #remove()} and {@link #get()} operations + * all perform in constant time. All other operations perform in linear + * time or worse. + *
+ * Note that this implementation is not synchronized. The following can be
+ * used to provide synchronized access to your CircularFifoBuffer:
+ *
+ * Buffer fifo = BufferUtils.synchronizedBuffer(new CircularFifoBuffer()); + *+ *
+ * This buffer prevents null objects from being added.
+ *
+ * @since Commons Collections 3.0
+ * @version $Revision: 1.1 $ $Date: 2003/11/29 18:04:57 $
+ *
+ * @author Stefano Fornari
+ * @author Stephen Colebourne
+ */
+public class CircularFifoBuffer extends BoundedFifoBuffer {
+
+ /**
+ * Constructor that creates a buffer with the default size of 32.
+ */
+ public CircularFifoBuffer() {
+ super(32);
+ }
+
+ /**
+ * Constructor that creates a buffer with the specified size.
+ *
+ * @param size the size of the buffer (cannot be changed)
+ * @throws IllegalArgumentException if the size is less than 1
+ */
+ public CircularFifoBuffer(int size) {
+ super(size);
+ }
+
+ /**
+ * Constructor that creates a buffer from the specified collection.
+ * The collection size also sets the buffer size
+ *
+ * @param coll the collection to copy into the buffer, may not be null
+ * @throws NullPointerException if the collection is null
+ */
+ public CircularFifoBuffer(Collection coll) {
+ super(coll);
+ }
+
+ /**
+ * If the buffer is full, the least recently added element is discarded so
+ * that a new element can be inserted.
+ *
+ * @param element the element to add
+ * @return true, always
+ */
+ public boolean add(Object element) {
+ if (isFull()) {
+ remove();
+ }
+ return super.add(element);
+ }
+
+}
diff --git a/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java b/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java
new file mode 100644
index 000000000..a31d98828
--- /dev/null
+++ b/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java
@@ -0,0 +1,321 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java,v 1.1 2003/11/29 18:04:57 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowledgement:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgement may appear in the software itself,
+ * if and wherever such third-party acknowledgements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ *
+ * The removal order of an 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.
+ *
+ * The {@link #remove()} and {@link #get()} operations perform in constant time. + * The {@link #add(Object)} operation performs in amortized constant time. All + * other operations perform in linear time or worse. + *
+ * Note that this implementation is not synchronized. The following can be
+ * used to provide synchronized access to your UnboundedFifoBuffer:
+ *
+ * Buffer fifo = BufferUtils.synchronizedBuffer(new UnboundedFifoBuffer()); + *+ *
+ * This buffer prevents null objects from being added. + * + * @since Commons Collections 3.0 + * @version $Revision: 1.1 $ $Date: 2003/11/29 18:04:57 $ + * + * @author Avalon + * @author Federico Barbieri + * @author Berin Loritsch + * @author Paul Jack + * @author Stephen Colebourne + */ +public class UnboundedFifoBuffer extends AbstractCollection implements Buffer { + + protected Object[] m_buffer; + protected int m_head; + protected int m_tail; + + /** + * Constructs an UnboundedFifoBuffer with the default number of elements. + * It is exactly the same as performing the following: + * + *
+ * new UnboundedFifoBuffer(32); + *+ */ + public UnboundedFifoBuffer() { + this(32); + } + + /** + * Constructs an UnboundedFifoBuffer with the specified number of elements. + * The integer must be a positive integer. + * + * @param initialSize the initial size of the buffer + * @throws IllegalArgumentException if the size is less than 1 + */ + public UnboundedFifoBuffer(int initialSize) { + if (initialSize <= 0) { + throw new IllegalArgumentException("The size must be greater than 0"); + } + m_buffer = new Object[initialSize + 1]; + m_head = 0; + m_tail = 0; + } + + /** + * Returns the number of elements stored in the buffer. + * + * @return this buffer's size + */ + public int size() { + int size = 0; + + if (m_tail < m_head) { + size = m_buffer.length - m_head + m_tail; + } else { + size = m_tail - m_head; + } + + return size; + } + + /** + * Returns true if this buffer is empty; false otherwise. + * + * @return true if this buffer is empty + */ + public boolean isEmpty() { + return (size() == 0); + } + + /** + * Adds the given element to this buffer. + * + * @param obj the element to add + * @return true, always + * @throws NullPointerException if the given element is null + * @throws BufferOverflowException if this buffer is full + */ + public boolean add(final Object obj) { + if (obj == null) { + throw new NullPointerException("Attempted to add null object to buffer"); + } + + if (size() + 1 >= m_buffer.length) { + Object[] tmp = new Object[((m_buffer.length - 1) * 2) + 1]; + + int j = 0; + for (int i = m_head; i != m_tail;) { + tmp[j] = m_buffer[i]; + m_buffer[i] = null; + + j++; + i++; + if (i == m_buffer.length) { + i = 0; + } + } + + m_buffer = tmp; + m_head = 0; + m_tail = j; + } + + m_buffer[m_tail] = obj; + m_tail++; + if (m_tail >= m_buffer.length) { + m_tail = 0; + } + return true; + } + + /** + * Returns the next object in the buffer. + * + * @return the next object in the buffer + * @throws BufferUnderflowException if this buffer is empty + */ + public Object get() { + if (isEmpty()) { + throw new BufferUnderflowException("The buffer is already empty"); + } + + return m_buffer[m_head]; + } + + /** + * Removes the next object from the buffer + * + * @return the removed object + * @throws BufferUnderflowException if this buffer is empty + */ + public Object remove() { + if (isEmpty()) { + throw new BufferUnderflowException("The buffer is already empty"); + } + + Object element = m_buffer[m_head]; + + if (null != element) { + m_buffer[m_head] = null; + + m_head++; + if (m_head >= m_buffer.length) { + m_head = 0; + } + } + + return element; + } + + /** + * Increments the internal index. + * + * @param index the index to increment + * @return the updated index + */ + private int increment(int index) { + index++; + if (index >= m_buffer.length) { + index = 0; + } + return index; + } + + /** + * Decrements the internal index. + * + * @param index the index to decrement + * @return the updated index + */ + private int decrement(int index) { + index--; + if (index < 0) { + index = m_buffer.length - 1; + } + return index; + } + + /** + * Returns an iterator over this buffer's elements. + * + * @return an iterator over this buffer's elements + */ + public Iterator iterator() { + return new Iterator() { + + private int index = m_head; + private int lastReturnedIndex = -1; + + public boolean hasNext() { + return index != m_tail; + + } + + public Object next() { + if (!hasNext()) + throw new NoSuchElementException(); + lastReturnedIndex = index; + index = increment(index); + return m_buffer[lastReturnedIndex]; + } + + public void remove() { + if (lastReturnedIndex == -1) + throw new IllegalStateException(); + + // First element can be removed quickly + if (lastReturnedIndex == m_head) { + UnboundedFifoBuffer.this.remove(); + lastReturnedIndex = -1; + return; + } + + // Other elements require us to shift the subsequent elements + int i = lastReturnedIndex + 1; + while (i != m_tail) { + if (i >= m_buffer.length) { + m_buffer[i - 1] = m_buffer[0]; + i = 0; + } else { + m_buffer[i - 1] = m_buffer[i]; + i++; + } + } + + lastReturnedIndex = -1; + m_tail = decrement(m_tail); + m_buffer[m_tail] = null; + index = decrement(index); + } + + }; + } + +} diff --git a/src/test/org/apache/commons/collections/buffer/TestAll.java b/src/test/org/apache/commons/collections/buffer/TestAll.java index ec4b0a17e..17537bfbb 100644 --- a/src/test/org/apache/commons/collections/buffer/TestAll.java +++ b/src/test/org/apache/commons/collections/buffer/TestAll.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/buffer/TestAll.java,v 1.1 2003/11/16 00:05:46 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/buffer/TestAll.java,v 1.2 2003/11/29 18:04:56 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -65,7 +65,7 @@ import junit.framework.TestSuite; * Entry point for tests. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:46 $ + * @version $Revision: 1.2 $ $Date: 2003/11/29 18:04:56 $ * * @author Stephen Colebourne */ @@ -83,9 +83,14 @@ public class TestAll extends TestCase { public static Test suite() { TestSuite suite = new TestSuite(); + suite.addTest(TestBinaryHeap.suite()); suite.addTest(TestBlockingBuffer.suite()); + suite.addTest(TestBoundedFifoBuffer.suite()); + suite.addTest(TestBoundedFifoBuffer2.suite()); + suite.addTest(TestCircularFifoBuffer.suite()); suite.addTest(TestPredicatedBuffer.suite()); suite.addTest(TestTransformedBuffer.suite()); + suite.addTest(TestUnboundedFifoBuffer.suite()); return suite; } diff --git a/src/test/org/apache/commons/collections/buffer/TestBinaryHeap.java b/src/test/org/apache/commons/collections/buffer/TestBinaryHeap.java new file mode 100644 index 000000000..238c53c8c --- /dev/null +++ b/src/test/org/apache/commons/collections/buffer/TestBinaryHeap.java @@ -0,0 +1,293 @@ +/* + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/buffer/Attic/TestBinaryHeap.java,v 1.1 2003/11/29 18:04:56 scolebourne Exp $ + * ==================================================================== + * + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2001-2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowledgement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgement may appear in the software itself, + * if and wherever such third-party acknowledgements normally appear. + * + * 4. The names "The Jakarta Project", "Commons", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + *