Update licence and javadoc

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131078 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/collections/ArrayStack.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ArrayStack.java,v 1.10 2002/10/13 12:56:42 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ArrayStack.java,v 1.11 2003/05/11 14:15:24 scolebourne Exp $
- * $Revision: 1.10 $
- * $Date: 2002/10/13 12:56:42 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -62,6 +59,7 @@ package org.apache.commons.collections;
 
 import java.util.ArrayList;
 import java.util.EmptyStackException;
+
 /**
  * An implementation of the {@link java.util.Stack} API that is based on an
  * <code>ArrayList</code> instead of a <code>Vector</code>, so it is not
@@ -77,12 +75,13 @@ import java.util.EmptyStackException;
  * <p>
  * Unlike <code>Stack</code>, <code>ArrayStack</code> accepts null entries.
  *
+ * @see java.util.Stack
+ * @since Commons Collections 1.0
+ * @version $Revision: 1.11 $ $Date: 2003/05/11 14:15:24 $
+ * 
  * @author Craig R. McClanahan
  * @author Paul Jack
  * @author Stephen Colebourne
- * @since 1.0
- * @version $Id: ArrayStack.java,v 1.10 2002/10/13 12:56:42 scolebourne Exp $
- * @see java.util.Stack
  */
 public class ArrayStack extends ArrayList implements Buffer {
 

src/java/org/apache/commons/collections/BeanMap.java

@@ -1,10 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BeanMap.java,v 1.18 2003/04/18 23:29:24 rwaldhoff Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BeanMap.java,v 1.19 2003/05/11 14:15:23 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -73,7 +73,6 @@ import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Set;
 
-
 /** 
  * An implementation of Map for JavaBeans which uses introspection to
  * get and put properties in the bean.
@@ -82,7 +81,7 @@ import java.util.Set;
  * property is considered non existent in the Map
  *
  * @since Commons Collections 1.0
- * @version $Revision: 1.18 $ $Date: 2003/04/18 23:29:24 $
+ * @version $Revision: 1.19 $ $Date: 2003/05/11 14:15:23 $
  * 
  * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
  * @author Stephen Colebourne

src/java/org/apache/commons/collections/BinaryHeap.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BinaryHeap.java,v 1.12 2003/02/19 20:14:25 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BinaryHeap.java,v 1.13 2003/05/11 14:15:23 scolebourne Exp $
- * $Revision: 1.12 $
- * $Date: 2003/02/19 20:14:25 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -64,6 +61,7 @@ import java.util.AbstractCollection;
 import java.util.Comparator;
 import java.util.Iterator;
 import java.util.NoSuchElementException;
+
 /**
  * Binary heap implementation of {@link PriorityQueue} and {@link Buffer}.
  * <p>
@@ -88,13 +86,14 @@ import java.util.NoSuchElementException;
  * Buffer heap = BufferUtils.synchronizedBuffer(new BinaryHeap());
  * </pre>
  *
+ * @since Commons Collections 1.0
+ * @version $Revision: 1.13 $ $Date: 2003/05/11 14:15:23 $
+ * 
  * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
  * @author <a href="mailto:ram.chidambaram@telus.com">Ram Chidambaram</a>
  * @author <a href="mailto:mas@apache.org">Michael A. Smith</a>
  * @author Paul Jack
  * @author Stephen Colebourne
- * @since 1.0
- * @version $Id: BinaryHeap.java,v 1.12 2003/02/19 20:14:25 scolebourne Exp $
  */
 public final class BinaryHeap extends AbstractCollection
         implements PriorityQueue, Buffer {

src/java/org/apache/commons/collections/BoundedFifoBuffer.java

@@ -1,10 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BoundedFifoBuffer.java,v 1.7 2003/04/26 15:09:48 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BoundedFifoBuffer.java,v 1.8 2003/05/11 14:15:23 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -20,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -33,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -84,7 +84,7 @@ import java.util.NoSuchElementException;
  * This buffer prevents null objects from being added.
  *
  * @since 2.1
- * @version $Revision: 1.7 $ $Date: 2003/04/26 15:09:48 $
+ * @version $Revision: 1.8 $ $Date: 2003/05/11 14:15:23 $
  * 
  * @author Avalon
  * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>

src/java/org/apache/commons/collections/Buffer.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Buffer.java,v 1.3 2002/10/13 12:58:04 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Buffer.java,v 1.4 2003/05/11 14:15:23 scolebourne Exp $
- * $Revision: 1.3 $
- * $Date: 2002/10/13 12:58:04 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -61,6 +58,7 @@
 package org.apache.commons.collections;
 
 import java.util.Collection;
+
 /**
  * A Buffer is a collection that allows objects to be removed in some
  * well-defined order.  The removal order can be based on insertion order
@@ -78,12 +76,13 @@ import java.util.Collection;
  * also implement {@link java.util.List}, {@link java.util.Set} or 
  * {@link Bag}.
  *
+ * @since Commons Collections 2.1
+ * @version $Revision: 1.4 $ $Date: 2003/05/11 14:15:23 $
+ * 
  * @author Avalon
  * @author <a href="bloritsch@apache.org">Berin Loritsch</a>
  * @author Paul Jack
  * @author Stephen Colebourne
- * @version $Id: Buffer.java,v 1.3 2002/10/13 12:58:04 scolebourne Exp $
- * @since 2.1
  */
 public interface Buffer extends Collection {
 
@@ -102,4 +101,5 @@ public interface Buffer extends Collection {
      * @throws BufferUnderflowException if the buffer is empty
      */
     Object get();
+    
 }

src/java/org/apache/commons/collections/BufferOverflowException.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferOverflowException.java,v 1.4 2002/10/13 12:57:12 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferOverflowException.java,v 1.5 2003/05/11 14:15:23 scolebourne Exp $
- * $Revision: 1.4 $
- * $Date: 2002/10/13 12:57:12 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -64,23 +61,26 @@ package org.apache.commons.collections;
  * The BufferOverflowException is used when the buffer's capacity has been
  * exceeded.
  *
+ * @since Commons Collections 2.1
+ * @version $Revision: 1.5 $ $Date: 2003/05/11 14:15:23 $
+ * 
  * @author Avalon
  * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  * @author <a href="mailto:jefft@apache.org">Jeff Turner</a>
  * @author Paul Jack
  * @author Stephen Colebourne
- * @since 2.1
- * @version $Id: BufferOverflowException.java,v 1.4 2002/10/13 12:57:12 scolebourne Exp $
  */
 public class BufferOverflowException extends RuntimeException {
-    private final Throwable m_throwable;
+    
+    /** The root cause throwable */
+    private final Throwable throwable;
 
     /**
      * Constructs a new <code>BufferOverflowException</code>.
      */
     public BufferOverflowException() {
         super();
-        m_throwable = null;
+        throwable = null;
     }
 
     /** 
@@ -100,7 +100,7 @@ public class BufferOverflowException extends RuntimeException {
      */
     public BufferOverflowException(String message, Throwable exception) {
         super(message);
-        m_throwable = exception;
+        throwable = exception;
     }
 
     /**
@@ -109,6 +109,7 @@ public class BufferOverflowException extends RuntimeException {
      * @return the root cause
      */
     public final Throwable getCause() {
-        return m_throwable;
+        return throwable;
     }
+    
 }

src/java/org/apache/commons/collections/BufferUnderflowException.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferUnderflowException.java,v 1.5 2002/10/13 12:57:38 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BufferUnderflowException.java,v 1.6 2003/05/11 14:15:23 scolebourne Exp $
- * $Revision: 1.5 $
- * $Date: 2002/10/13 12:57:38 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -61,25 +58,28 @@
 package org.apache.commons.collections;
 
 /**
- * The BufferUnderflowException is used when the buffer is already empty
+ * The BufferUnderflowException is used when the buffer is already empty.
+ * 
+ * @since Commons Collections 2.1
+ * @version $Revision: 1.6 $ $Date: 2003/05/11 14:15:23 $
  *
  * @author Avalon
  * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  * @author <a href="mailto:jefft@apache.org">Jeff Turner</a>
  * @author Paul Jack
  * @author Stephen Colebourne
- * @since 2.1
- * @version $Id: BufferUnderflowException.java,v 1.5 2002/10/13 12:57:38 scolebourne Exp $
  */
 public class BufferUnderflowException extends RuntimeException {
-    private final Throwable m_throwable;
+    
+    /** The root cause throwable */
+    private final Throwable throwable;
 
     /**
      * Constructs a new <code>BufferUnderflowException</code>.
      */
     public BufferUnderflowException() {
         super();
-        m_throwable = null;
+        throwable = null;
     }
 
     /** 
@@ -99,7 +99,7 @@ public class BufferUnderflowException extends RuntimeException {
      */
     public BufferUnderflowException(String message, Throwable exception) {
         super(message);
-        m_throwable = exception;
+        throwable = exception;
     }
 
     /**
@@ -108,6 +108,7 @@ public class BufferUnderflowException extends RuntimeException {
      * @return the root cause
      */
     public final Throwable getCause() {
-        return m_throwable;
+        return throwable;
     }
+    
 }

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.1 2003/04/26 15:10:56 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.2 2003/05/11 14:15:23 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -20,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -33,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -82,7 +82,7 @@ import org.apache.commons.collections.BoundedFifoBuffer;
  * This buffer prevents null objects from being added.
  * 
  * @since Commons Collections 2.2
- * @version $Revision: 1.1 $ $Date: 2003/04/26 15:10:56 $
+ * @version $Revision: 1.2 $ $Date: 2003/05/11 14:15:23 $
  * 
  * @author Stefano Fornari
  * @author Stephen Colebourne

src/java/org/apache/commons/collections/Closure.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Closure.java,v 1.4 2002/06/12 03:59:15 mas Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Closure.java,v 1.5 2003/05/11 14:15:23 scolebourne Exp $
- * $Revision: 1.4 $
- * $Date: 2002/06/12 03:59:15 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -60,16 +57,21 @@
  */
 package org.apache.commons.collections;
 
-/** An interface to represent some Closure, a block of code which is executed 
+/** 
-  * from inside some block, function or iteration which operates on an input 
+ * An interface to represent some Closure, a block of code which is executed 
-  * object.
+ * from inside some block, function or iteration which operates on an input 
-  *
+ * object.
-  * @since 1.0
+ *
-  * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
+ * @since Commons Collections 1.0
-  */
+ * @version $Revision: 1.5 $ $Date: 2003/05/11 14:15:23 $
+ * 
+ * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
+ */
 public interface Closure {
 
-    /** Performs some operation on the input object
+    /** 
-      */
+     * Performs some operation on the input object.
-    public void execute(Object input);
+     */
+    void execute(Object input);
+    
 }

src/java/org/apache/commons/collections/CommonsLinkedList.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/CommonsLinkedList.java,v 1.4 2003/02/19 20:14:25 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/CommonsLinkedList.java,v 1.5 2003/05/11 14:15:23 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -76,8 +76,9 @@ import java.util.NoSuchElementException;
  * subclasses to extend.
  * 
  * @since Commons Collections 2.2
+ * @version $Revision: 1.5 $ $Date: 2003/05/11 14:15:23 $
+ * 
  * @author <a href="mailto:rich@rd.gen.nz">Rich Dougherty</a>
- * @version $Revision: 1.4 $ $Date: 2003/02/19 20:14:25 $
  */
 class CommonsLinkedList extends LinkedList
         implements List, Serializable {

src/java/org/apache/commons/collections/ComparatorUtils.java

@@ -1,7 +1,10 @@
-/* ====================================================================
+/*
+ * $Header: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/BufferUtils.java,v 1.12 2003/05/11 13:29:16 scolebourne Exp $
+ * ====================================================================
+ *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2001 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -16,21 +19,21 @@
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
- * 3. The end-user documentation included with the redistribution,
+ * 3. The end-user documentation included with the redistribution, if
- *    if any, must include the following acknowledgment:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowledgment may appear in the software itself,
  *    if and wherever such third-party acknowledgments normally appear.
  *
- * 4. The names "Apache" and "Apache Software Foundation" and
+ * 4. The names "The Jakarta Project", "Commons", and "Apache Software
- *    "Apache Commons" must not be used to endorse or promote products
+ *    Foundation" must not be used to endorse or promote products derived
- *    derived from this software without prior written permission. For
+ *    from this software without prior written permission. For written
- *    written permission, please contact apache@apache.org.
+ *    permission, please contact apache@apache.org.
  *
- * 5. Products derived from this software may not be called "Apache",
+ * 5. Products derived from this software may not be called "Apache"
- *    "Apache Turbine", nor may "Apache" appear in their name, without
+ *    nor may "Apache" appear in their names without prior written
- *    prior written permission of the Apache Software Foundation.
+ *    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
@@ -50,6 +53,7 @@
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
+ *
  */
 package org.apache.commons.collections;
 
@@ -62,6 +66,7 @@ import org.apache.commons.collections.comparators.ComparatorChain;
 import org.apache.commons.collections.comparators.NullComparator;
 import org.apache.commons.collections.comparators.ReverseComparator;
 import org.apache.commons.collections.comparators.TransformingComparator;
+
 /**
  * Provides convenient static utility methods for <Code>Comparator</Code>
  * objects.
@@ -75,17 +80,18 @@ import org.apache.commons.collections.comparators.TransformingComparator;
  * <code>null</code> instead of a comparator, in which case 
  * {@link #NATURAL_COMPARATOR} will be used.
  *
- * @since 2.1
+ * @since Commons Collections 2.1
+ * @version $Revision: $ $Date: $
+ * 
  * @author Paul Jack
- * @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
+ * @author Stephen Colebourne
- * @version $Id: $
  */
 public class ComparatorUtils {
 
     /**
-     * Restrictive constructor
+     * ComparatorUtils should not normally be constructed.
      */
-    private ComparatorUtils() {
+    public ComparatorUtils() {
     }
 
     /**
@@ -276,4 +282,5 @@ public class ComparatorUtils {
         int c = comparator.compare(o1, o2);
         return (c > 0) ? o1 : o2;
     }
+    
 }

src/java/org/apache/commons/collections/CursorableLinkedList.java

@@ -1,13 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/CursorableLinkedList.java,v 1.11 2003/02/19 20:14:25 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/CursorableLinkedList.java,v 1.12 2003/05/11 14:15:23 scolebourne Exp $
- * $Revision: 1.11 $
- * $Date: 2003/02/19 20:14:25 $
- *
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
+ * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -23,11 +20,11 @@
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowlegement:
+ *    any, must include the following acknowledgment:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowlegement may appear in the software itself,
+ *    Alternately, this acknowledgment may appear in the software itself,
- *    if and wherever such third-party acknowlegements normally appear.
+ *    if and wherever such third-party acknowledgments normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
@@ -36,7 +33,7 @@
  *
  * 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 Group.
+ *    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
@@ -58,9 +55,6 @@
  * <http://www.apache.org/>.
  *
  */
-
-// to do: use weak references to cursors in case they aren't closed directly
-
 package org.apache.commons.collections;
 
 import java.io.IOException;
@@ -88,12 +82,14 @@ import java.util.NoSuchElementException;
  * <p>
  * <b>Note that this implementation is not synchronized.</b>
  *
- * @since 1.0
- * @author Rodney Waldhoff
- * @version $Id: CursorableLinkedList.java,v 1.11 2003/02/19 20:14:25 scolebourne Exp $
  * @see java.util.LinkedList
+ * @since Commons Collections 1.0
+ * @version $Revision: 1.12 $ $Date: 2003/05/11 14:15:23 $
+ * 
+ * @author Rodney Waldhoff
  */
 public class CursorableLinkedList implements List, Serializable {
+    //  TODO: use weak references to cursors in case they aren't closed directly
 
     //--- public methods ---------------------------------------------