Apache/commons-collections
1
0
Fork 0
mirror of https://github.com/apache/commons-collections.git synced 2025-02-17 15:35:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update javadoc

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131436 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-12-13 23:51:28 +00:00
parent 6b8aad6314
commit 41deb399a2
11 changed files with 44 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/java/org/apache/commons/collections/Buffer.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Buffer.java,v 1.6 2003/09/06 20:41:12 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.7 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -60,11 +60,11 @@ 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
* (eg, a FIFO queue or a LIFO stack), on access order (eg, an LRU cache),
* on some arbitrary comparator (eg, a priority queue) or on any other
* well-defined ordering.
* Defines a collection that allows objects to be removed in some well-defined order.
* <p>
* The removal order can be based on insertion order (eg, a FIFO queue or a
* LIFO stack), on access order (eg, an LRU cache), on some arbitrary comparator
* (eg, a priority queue) or on any other well-defined ordering.
* <p>
* Note that the removal order is not necessarily the same as the iteration
* order. A <code>Buffer</code> implementation may have equivalent removal
@ -77,7 +77,7 @@ import java.util.Collection;
* {@link Bag}.
*
* @since Commons Collections 2.1
* @version $Revision: 1.6 $ $Date: 2003/09/06 20:41:12 $
* @version $Revision: 1.7 $ $Date: 2003/12/13 23:51:28 $
*
* @author Avalon
* @author Berin Loritsch

7
src/java/org/apache/commons/collections/Closure.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Closure.java,v 1.7 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/Closure.java,v 1.8 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -58,14 +58,13 @@
package org.apache.commons.collections;
/**
* <code>Closure</code> defines an interface implemented by classes that
* do something.
* Defines a functor interface implemented by classes that do something.
* <p>
* A Closure represents a block of code which is executed from inside some
* block, function or iteration. It operates an input object.
*
* @since Commons Collections 1.0
* @version $Revision: 1.7 $ $Date: 2003/08/31 17:26:44 $
* @version $Revision: 1.8 $ $Date: 2003/12/13 23:51:28 $
*
* @author James Strachan
* @author Nicola Ken Barozzi

7
src/java/org/apache/commons/collections/Factory.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Factory.java,v 1.5 2003/08/31 17:26:43 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Factory.java,v 1.6 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -58,11 +58,10 @@
package org.apache.commons.collections;
/**
* <code>Factory</code> defines an interface implemented by classes that
* create objects.
* Defines a functor interface implemented by classes that create objects.
*
* @since Commons Collections 2.1
* @version $Revision: 1.5 $ $Date: 2003/08/31 17:26:43 $
* @version $Revision: 1.6 $ $Date: 2003/12/13 23:51:28 $
*
* @author Arron Bates
* @author Stephen Colebourne

6
src/java/org/apache/commons/collections/MultiMap.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiMap.java,v 1.8 2003/10/09 20:58:52 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/MultiMap.java,v 1.9 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -60,7 +60,7 @@ package org.apache.commons.collections;
import java.util.Map;
/**
* This is simply a Map with slightly different semantics.
* Defines a map that holds a collection of values against each key.
* <p>
* A <code>MultiMap</code> is a Map with slightly different semantics.
* Putting a value into the map will add the value to a Collection at that
@ -79,7 +79,7 @@ import java.util.Map;
* <code>coll</code> will be a list containing "A", "B", "C".
*
* @since Commons Collections 2.0
* @version $Revision: 1.8 $ $Date: 2003/10/09 20:58:52 $
* @version $Revision: 1.9 $ $Date: 2003/12/13 23:51:28 $
*
* @author Christopher Berry
* @author James Strachan

6
src/java/org/apache/commons/collections/Predicate.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Predicate.java,v 1.7 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/Predicate.java,v 1.8 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -58,12 +58,12 @@
package org.apache.commons.collections;
/**
* <code>Predicate</code> defines an interface implemented by classes that
* Defines a functor interface implemented by classes that
* perform a predicate test on an object. Predicate instances can be used
* to implement queries or to do filtering.
*
* @since Commons Collections 1.0
* @version $Revision: 1.7 $ $Date: 2003/08/31 17:26:44 $
* @version $Revision: 1.8 $ $Date: 2003/12/13 23:51:28 $
*
* @author James Strachan
* @author Stephen Colebourne

7
src/java/org/apache/commons/collections/PriorityQueue.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/PriorityQueue.java,v 1.7 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/PriorityQueue.java,v 1.8 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -60,11 +60,12 @@ package org.apache.commons.collections;
import java.util.NoSuchElementException;
/**
* Interface for priority queues.
* Defines a collection for priority queues, which can insert, peek and pop.
* <p>
* This interface does not dictate whether it is min or max heap.
*
* @since Commons Collections 1.0
* @version $Revision: 1.7 $ $Date: 2003/08/31 17:26:44 $
* @version $Revision: 1.8 $ $Date: 2003/12/13 23:51:28 $
*
* @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
*/

9
src/java/org/apache/commons/collections/ResettableIterator.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ResettableIterator.java,v 1.1 2003/12/01 22:48:59 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ResettableIterator.java,v 1.2 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -60,11 +60,12 @@ package org.apache.commons.collections;
import java.util.Iterator;
/**
* Interface implemented by those iterators that can be reset back to an
* initial state.
* Defines an iterator that can be reset back to an initial state.
* <p>
* This interface allows an iterator to be repeatedly reused.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/01 22:48:59 $
* @version $Revision: 1.2 $ $Date: 2003/12/13 23:51:28 $
*
* @author Stephen Colebourne
*/

9
src/java/org/apache/commons/collections/ResettableListIterator.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ResettableListIterator.java,v 1.1 2003/12/01 22:48:59 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/ResettableListIterator.java,v 1.2 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -60,11 +60,12 @@ package org.apache.commons.collections;
import java.util.ListIterator;
/**
* Interface implemented by those list iterators that can be reset back
* to an initial state.
* Defines a list iterator that can be reset back to an initial state.
* <p>
* This interface allows an iterator to be repeatedly reused.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/01 22:48:59 $
* @version $Revision: 1.2 $ $Date: 2003/12/13 23:51:28 $
*
* @author Stephen Colebourne
*/

8
src/java/org/apache/commons/collections/SortedBag.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/SortedBag.java,v 1.6 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/SortedBag.java,v 1.7 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -60,11 +60,11 @@ package org.apache.commons.collections;
import java.util.Comparator;
/**
* A type of {@link Bag} that maintains order among its unique
* representative members.
* Defines a type of <code>Bag</code> that maintains a sorted order among
* its unique representative members.
*
* @since Commons Collections 2.0
* @version $Revision: 1.6 $ $Date: 2003/08/31 17:26:44 $
* @version $Revision: 1.7 $ $Date: 2003/12/13 23:51:28 $
*
* @author Chuck Burdick
*/

6
src/java/org/apache/commons/collections/Transformer.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Transformer.java,v 1.6 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/Transformer.java,v 1.7 2003/12/13 23:51:28 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -58,13 +58,13 @@
package org.apache.commons.collections;
/**
* <code>Transformer</code> defines an interface implemented by classes that
* Defines a functor interface implemented by classes that
* transform one object into another. The original object is left unchanged.
* Transformers are typically used for type conversions, or extracting data
* from an object.
*
* @since Commons Collections 1.0
* @version $Revision: 1.6 $ $Date: 2003/08/31 17:26:44 $
* @version $Revision: 1.7 $ $Date: 2003/12/13 23:51:28 $
*
* @author James Strachan
* @author Stephen Colebourne

5
src/java/org/apache/commons/collections/package.html
View File

@ -1,5 +1,8 @@
<!-- $Id: package.html,v 1.9 2003/05/16 16:00:29 scolebourne Exp $ -->
<!-- $Id: package.html,v 1.10 2003/12/13 23:51:28 scolebourne Exp $ -->
<body>
<p>
This package contains new interfaces to complement the Java Collections Framework,
and various utility classes.
<p>
The Apache Jakarta Commons Collections Framework extensions are implemented in
a number of packages.