From 5db7fd697622ee56a4da46034db63eb1f8d0431f Mon Sep 17 00:00:00 2001 From: Stephen Colebourne Date: Thu, 9 Oct 2003 20:51:15 +0000 Subject: [PATCH] Fix various javadoc link warnings bug 23680, from Eric Johnson git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131269 13f79535-47bb-0310-9956-ffa450edef68 --- .../observed/ModificationHandler.java | 68 +++++++++---------- .../collections/observed/ObservableBag.java | 7 +- .../observed/ObservableBuffer.java | 7 +- .../observed/ObservableCollection.java | 6 +- .../collections/observed/ObservableList.java | 7 +- .../collections/observed/ObservableSet.java | 8 +-- .../observed/ObservableSortedBag.java | 7 +- .../observed/ObservableSortedSet.java | 7 +- .../standard/StandardModificationHandler.java | 18 +++-- .../primitives/ArrayUnsignedIntList.java | 6 +- .../collections/primitives/CharList.java | 6 +- .../primitives/IntCollections.java | 8 +-- 12 files changed, 79 insertions(+), 76 deletions(-) diff --git a/src/java/org/apache/commons/collections/observed/ModificationHandler.java b/src/java/org/apache/commons/collections/observed/ModificationHandler.java index 871f9896a..973c1b38a 100644 --- a/src/java/org/apache/commons/collections/observed/ModificationHandler.java +++ b/src/java/org/apache/commons/collections/observed/ModificationHandler.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ModificationHandler.java,v 1.7 2003/09/21 20:01:53 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ModificationHandler.java,v 1.8 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -76,7 +76,7 @@ import java.util.Collection; * later collections release. * * @since Commons Collections 3.0 - * @version $Revision: 1.7 $ $Date: 2003/09/21 20:01:53 $ + * @version $Revision: 1.8 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ @@ -324,7 +324,7 @@ public class ModificationHandler { /** * Store data and send event before add(obj) is called. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * It does not set the index for List implementations. * * @param object the object being added @@ -337,7 +337,7 @@ public class ModificationHandler { /** * Send an event after add(obj) is called. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * It does not set the index for List implementations. * * @param object the object being added @@ -351,7 +351,7 @@ public class ModificationHandler { /** * Store data and send event before add(int,obj) is called on a List. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index to add at * @param object the object being added @@ -364,7 +364,7 @@ public class ModificationHandler { /** * Send an event after add(int,obj) is called on a List. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index to add at * @param object the object being added @@ -377,7 +377,7 @@ public class ModificationHandler { /** * Store data and send event before add(obj,int) is called on a Bag. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param object the object being added * @param nCopies the number of copies being added @@ -390,7 +390,7 @@ public class ModificationHandler { /** * Send an event after add(obj,int) is called on a Bag. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * The method result is not used by this implementation (Bag violates the * Collection contract) * @@ -406,7 +406,7 @@ public class ModificationHandler { /** * Store data and send event before add(obj) is called on a ListIterator. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index of the iterator * @param object the object being added @@ -419,7 +419,7 @@ public class ModificationHandler { /** * Send an event after add(obj) is called on a ListIterator. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index of the iterator * @param object the object being added @@ -433,7 +433,7 @@ public class ModificationHandler { /** * Store data and send event before addAll(coll) is called. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param coll the collection being added * @return true to process modification @@ -445,7 +445,7 @@ public class ModificationHandler { /** * Send an event after addAll(coll) is called. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param coll the collection being added * @param collChanged the result from the addAll method @@ -458,7 +458,7 @@ public class ModificationHandler { /** * Store data and send event before addAll(int,coll) is called on a List. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index to addAll at * @param coll the collection being added @@ -471,7 +471,7 @@ public class ModificationHandler { /** * Send an event after addAll(int,coll) is called on a List. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index to addAll at * @param coll the collection being added @@ -485,7 +485,7 @@ public class ModificationHandler { /** * Store data and send event before clear() is called. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @return true to process modification */ @@ -496,7 +496,7 @@ public class ModificationHandler { /** * Send an event after clear() is called. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int)}. + * This implementation forwards to {@link #postEvent}. */ protected void postClear() { // assumes a modification occurred @@ -507,7 +507,7 @@ public class ModificationHandler { /** * Store data and send event before remove(obj) is called. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param object the object being removed * @return true to process modification @@ -519,7 +519,7 @@ public class ModificationHandler { /** * Send an event after remove(obj) is called. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param object the object being removed * @param collChanged the result from the remove method @@ -532,7 +532,7 @@ public class ModificationHandler { /** * Store data and send event before remove(int) is called on a List. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index to remove at * @return true to process modification @@ -546,7 +546,7 @@ public class ModificationHandler { /** * Send an event after remove(int) is called on a List. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index to remove at * @param previousValue the result from the remove method @@ -559,7 +559,7 @@ public class ModificationHandler { /** * Store data and send event before remove(obj,int) is called on a Bag. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param object the object being removed * @param nCopies the number of copies being removed @@ -572,7 +572,7 @@ public class ModificationHandler { /** * Send an event after remove(obj,int) is called on a Bag. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param object the object being removed * @param nCopies the number of copies being removed @@ -586,7 +586,7 @@ public class ModificationHandler { /** * Store data and send event before remove() is called on a Buffer. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @return true to process modification */ @@ -597,7 +597,7 @@ public class ModificationHandler { /** * Send an event after remove() is called on a Buffer. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param removedValue the previous value at this index */ @@ -610,7 +610,7 @@ public class ModificationHandler { /** * Store data and send event before remove(obj) is called on an Iterator. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index of the iterator * @param removedValue the object being removed @@ -623,7 +623,7 @@ public class ModificationHandler { /** * Send an event after remove(obj) is called on an Iterator. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index of the iterator * @param removedValue the previous value at this index @@ -637,7 +637,7 @@ public class ModificationHandler { /** * Store data and send event before removeAll(coll) is called. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param coll the collection being removed * @return true to process modification @@ -649,7 +649,7 @@ public class ModificationHandler { /** * Send an event after removeAll(coll) is called. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param coll the collection being removed * @param collChanged the result from the removeAll method @@ -662,7 +662,7 @@ public class ModificationHandler { /** * Store data and send event before retainAll(coll) is called. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param coll the collection being retained * @return true to process modification @@ -674,7 +674,7 @@ public class ModificationHandler { /** * Send an event after retainAll(coll) is called. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param coll the collection being retained * @param collChanged the result from the retainAll method @@ -687,7 +687,7 @@ public class ModificationHandler { /** * Store data and send event before set(int,obj) is called on a List. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index to add at * @param object the object being added @@ -702,7 +702,7 @@ public class ModificationHandler { /** * Send an event after set(int,obj) is called on a List. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index to add at * @param object the object being added @@ -717,7 +717,7 @@ public class ModificationHandler { /** * Store data and send event before set(obj) is called on a ListIterator. *

- * This implementation forwards to {@link #preEvent(int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #preEvent}. * * @param index the index to set at * @param object the object being added @@ -731,7 +731,7 @@ public class ModificationHandler { /** * Send an event after set(obj) is called on a ListIterator. *

- * This implementation forwards to {@link #postEvent(boolean, int, int, Object, int, Object, Object, int)}. + * This implementation forwards to {@link #postEvent}. * * @param index the index to set at * @param object the object being added diff --git a/src/java/org/apache/commons/collections/observed/ObservableBag.java b/src/java/org/apache/commons/collections/observed/ObservableBag.java index 146114ea3..e437c6609 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableBag.java +++ b/src/java/org/apache/commons/collections/observed/ObservableBag.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableBag.java,v 1.1 2003/09/21 16:00:28 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableBag.java,v 1.2 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -67,14 +67,15 @@ import org.apache.commons.collections.Bag; * Each modifying method call made on this Bag is forwarded to a * {@link ModificationHandler}. * The handler manages the event, notifying listeners and optionally vetoing changes. - * The default handler is {@link StandardModificationHandler}. + * The default handler is + * {@link org.apache.commons.collections.observed.standard.StandardModificationHandler StandardModificationHandler}. * See this class for details of configuration available. *

* NOTE: The {@link #uniqueSet()} method returns a Set that is * NOT observed. This is because the set should be unmodifiable. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/09/21 16:00:28 $ + * @version $Revision: 1.2 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/observed/ObservableBuffer.java b/src/java/org/apache/commons/collections/observed/ObservableBuffer.java index 1ab5c6c9c..b85590703 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableBuffer.java +++ b/src/java/org/apache/commons/collections/observed/ObservableBuffer.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableBuffer.java,v 1.1 2003/09/21 16:00:28 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableBuffer.java,v 1.2 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -65,11 +65,12 @@ import org.apache.commons.collections.Buffer; * Each modifying method call made on this Buffer is forwarded to a * {@link ModificationHandler}. * The handler manages the event, notifying listeners and optionally vetoing changes. - * The default handler is {@link StandardModificationHandler}. + * The default handler is + * {@link org.apache.commons.collections.observed.standard.StandardModificationHandler StandardModificationHandler}. * See this class for details of configuration available. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/09/21 16:00:28 $ + * @version $Revision: 1.2 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/observed/ObservableCollection.java b/src/java/org/apache/commons/collections/observed/ObservableCollection.java index 15ba4989c..1a6f20314 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableCollection.java +++ b/src/java/org/apache/commons/collections/observed/ObservableCollection.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableCollection.java,v 1.1 2003/09/21 16:00:28 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableCollection.java,v 1.2 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -74,7 +74,7 @@ import org.apache.commons.collections.observed.standard.StandardModificationHand * See this class for details of configuration available. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/09/21 16:00:28 $ + * @version $Revision: 1.2 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ @@ -186,7 +186,7 @@ public class ObservableCollection extends AbstractCollectionDecorator { * ModificationHandler instance. * * @param coll the collection to decorate, must not be null - * @param handler the observing handler, may be null + * @param listener the observing handler, may be null * @throws IllegalArgumentException if the collection is null */ protected ObservableCollection( diff --git a/src/java/org/apache/commons/collections/observed/ObservableList.java b/src/java/org/apache/commons/collections/observed/ObservableList.java index 5a96901b4..03dc7f798 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableList.java +++ b/src/java/org/apache/commons/collections/observed/ObservableList.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableList.java,v 1.1 2003/09/21 16:00:28 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableList.java,v 1.2 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -69,14 +69,15 @@ import org.apache.commons.collections.decorators.AbstractListIteratorDecorator; * Each modifying method call made on this List is forwarded to a * {@link ModificationHandler}. * The handler manages the event, notifying listeners and optionally vetoing changes. - * The default handler is {@link StandardModificationHandler}. + * The default handler is + * {@link org.apache.commons.collections.observed.standard.StandardModificationHandler StandardModificationHandler}. * See this class for details of configuration available. *

* All indices on events returned by subList are relative to the * base List. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/09/21 16:00:28 $ + * @version $Revision: 1.2 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/observed/ObservableSet.java b/src/java/org/apache/commons/collections/observed/ObservableSet.java index 4d89db462..239ce22ae 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableSet.java +++ b/src/java/org/apache/commons/collections/observed/ObservableSet.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableSet.java,v 1.1 2003/09/21 16:00:28 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableSet.java,v 1.2 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -59,18 +59,18 @@ package org.apache.commons.collections.observed; import java.util.Set; - /** * Decorates a Set implementation to observe modifications. *

* Each modifying method call made on this Set is forwarded to a * {@link ModificationHandler}. * The handler manages the event, notifying listeners and optionally vetoing changes. - * The default handler is {@link StandardModificationHandler}. + * The default handler is + * {@link org.apache.commons.collections.observed.standard.StandardModificationHandler StandardModificationHandler}. * See this class for details of configuration available. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/09/21 16:00:28 $ + * @version $Revision: 1.2 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/observed/ObservableSortedBag.java b/src/java/org/apache/commons/collections/observed/ObservableSortedBag.java index 4a0ce061b..4f59cc022 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableSortedBag.java +++ b/src/java/org/apache/commons/collections/observed/ObservableSortedBag.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableSortedBag.java,v 1.1 2003/09/28 21:50:37 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableSortedBag.java,v 1.2 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -67,11 +67,12 @@ import org.apache.commons.collections.SortedBag; * Each modifying method call made on this SortedBag is forwarded to a * {@link ModificationHandler}. * The handler manages the event, notifying listeners and optionally vetoing changes. - * The default handler is {@link StandardModificationHandler}. + * The default handler is + * {@link org.apache.commons.collections.observed.standard.StandardModificationHandler StandardModificationHandler}. * See this class for details of configuration available. * * @since Commons Collections 3.0 - * @version $Revision: 1.1 $ $Date: 2003/09/28 21:50:37 $ + * @version $Revision: 1.2 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/observed/ObservableSortedSet.java b/src/java/org/apache/commons/collections/observed/ObservableSortedSet.java index 54a214a42..84e57d7c6 100644 --- a/src/java/org/apache/commons/collections/observed/ObservableSortedSet.java +++ b/src/java/org/apache/commons/collections/observed/ObservableSortedSet.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableSortedSet.java,v 1.2 2003/09/28 21:49:50 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/Attic/ObservableSortedSet.java,v 1.3 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -66,11 +66,12 @@ import java.util.SortedSet; * Each modifying method call made on this SortedSet is forwarded to a * {@link ModificationHandler}. * The handler manages the event, notifying listeners and optionally vetoing changes. - * The default handler is {@link StandardModificationHandler}. + * The default handler is + * {@link org.apache.commons.collections.observed.standard.StandardModificationHandler StandardModificationHandler}. * See this class for details of configuration available. * * @since Commons Collections 3.0 - * @version $Revision: 1.2 $ $Date: 2003/09/28 21:49:50 $ + * @version $Revision: 1.3 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ diff --git a/src/java/org/apache/commons/collections/observed/standard/StandardModificationHandler.java b/src/java/org/apache/commons/collections/observed/standard/StandardModificationHandler.java index c65ff2e2f..7adf4902a 100644 --- a/src/java/org/apache/commons/collections/observed/standard/StandardModificationHandler.java +++ b/src/java/org/apache/commons/collections/observed/standard/StandardModificationHandler.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/standard/Attic/StandardModificationHandler.java,v 1.6 2003/09/21 20:00:29 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/observed/standard/Attic/StandardModificationHandler.java,v 1.7 2003/10/09 20:50:04 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -77,7 +77,7 @@ import org.apache.commons.collections.observed.ObservableCollection; * modification events. * * @since Commons Collections 3.0 - * @version $Revision: 1.6 $ $Date: 2003/09/21 20:00:29 $ + * @version $Revision: 1.7 $ $Date: 2003/10/09 20:50:04 $ * * @author Stephen Colebourne */ @@ -111,9 +111,9 @@ public class StandardModificationHandler extends ModificationHandler { /** * Constructor the creates the handler but leaves it invalid. *

- * The handler can only be used after {@link #init(ObservableCollection)} is - * called. This is normally done automatically by - * {@link ObservableCollection#decorate(Collection, ModificationHandler)}. + * The handler can only be used after it has been properly initialized. + * This is normally done automatically by + * {@link ObservableCollection#decorate(Collection, Object)}. */ public StandardModificationHandler() { super(); @@ -122,9 +122,9 @@ public class StandardModificationHandler extends ModificationHandler { /** * Constructor the creates the handler but leaves it invalid. *

- * The handler can only be used after {@link #init(ObservableCollection)} is - * called. This is normally done automatically by - * {@link ObservableCollection#decorate(Collection, ModificationHandler)}. + * The handler can only be used after it has been properly initialized. + * This is normally done automatically by + * {@link ObservableCollection#decorate(Collection, Object)}. * * @param pre the pre listener * @param preMask the mask for the pre listener @@ -244,7 +244,6 @@ public class StandardModificationHandler extends ModificationHandler { * * @param listener the listener to change, may be null * @param mask the new mask (0 for none, -1 for all) - * @return a non-null array of listeners */ public synchronized void setPreModificationListenerMask(StandardPreModificationListener listener, int mask) { if (listener != null) { @@ -380,7 +379,6 @@ public class StandardModificationHandler extends ModificationHandler { * * @param listener the listener to change, may be null * @param mask the new mask (0 for none, -1 for all) - * @return a non-null array of listeners */ public synchronized void setPostModificationListenerMask(StandardPostModificationListener listener, int mask) { if (listener != null) { diff --git a/src/java/org/apache/commons/collections/primitives/ArrayUnsignedIntList.java b/src/java/org/apache/commons/collections/primitives/ArrayUnsignedIntList.java index 95d8baf43..ccdcdd0e8 100644 --- a/src/java/org/apache/commons/collections/primitives/ArrayUnsignedIntList.java +++ b/src/java/org/apache/commons/collections/primitives/ArrayUnsignedIntList.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/Attic/ArrayUnsignedIntList.java,v 1.5 2003/08/31 17:21:14 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/Attic/ArrayUnsignedIntList.java,v 1.6 2003/10/09 20:51:15 scolebourne Exp $ * ==================================================================== * The Apache Software License, Version 1.1 * @@ -76,7 +76,7 @@ import java.io.Serializable; * This implementation supports all optional methods. * * @since Commons Collections 2.2 - * @version $Revision: 1.5 $ $Date: 2003/08/31 17:21:14 $ + * @version $Revision: 1.6 $ $Date: 2003/10/09 20:51:15 $ * * @author Rodney Waldhoff */ @@ -110,7 +110,7 @@ public class ArrayUnsignedIntList extends RandomAccessLongList implements LongLi * Constructs a list containing the elements of the given collection, * in the order they are returned by that collection's iterator. * - * @see ArrayIntList#addAll(org.apache.commons.collections.primitives.LongCollection) + * @see AbstractLongCollection#addAll(LongCollection) * @param that the non-null collection of ints * to add * @throws NullPointerException if that is null diff --git a/src/java/org/apache/commons/collections/primitives/CharList.java b/src/java/org/apache/commons/collections/primitives/CharList.java index 1939f3a25..7ee2dbdfa 100644 --- a/src/java/org/apache/commons/collections/primitives/CharList.java +++ b/src/java/org/apache/commons/collections/primitives/CharList.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/Attic/CharList.java,v 1.2 2003/08/31 17:21:14 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/Attic/CharList.java,v 1.3 2003/10/09 20:51:15 scolebourne Exp $ * ==================================================================== * The Apache Software License, Version 1.1 * @@ -64,7 +64,7 @@ package org.apache.commons.collections.primitives; * @see org.apache.commons.collections.primitives.adapters.ListCharList * * @since Commons Collections 2.2 - * @version $Revision: 1.2 $ $Date: 2003/08/31 17:21:14 $ + * @version $Revision: 1.3 $ $Date: 2003/10/09 20:51:15 $ * * @author Rodney Waldhoff */ @@ -168,7 +168,7 @@ public interface CharList extends CharCollection { * This contract ensures that this method is consistent with * {@link #equals equals} and with the * {@link java.util.List#hashCode hashCode} - * method of a {@link java.util.List List} of {@link Char}s. + * method of a {@link java.util.List List} of {@link Character}s. * * @return my hash code */ diff --git a/src/java/org/apache/commons/collections/primitives/IntCollections.java b/src/java/org/apache/commons/collections/primitives/IntCollections.java index 45d129fe7..cf47bfd32 100644 --- a/src/java/org/apache/commons/collections/primitives/IntCollections.java +++ b/src/java/org/apache/commons/collections/primitives/IntCollections.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/Attic/IntCollections.java,v 1.3 2003/08/31 17:21:15 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/Attic/IntCollections.java,v 1.4 2003/10/09 20:51:15 scolebourne Exp $ * ==================================================================== * The Apache Software License, Version 1.1 * @@ -68,7 +68,7 @@ import org.apache.commons.collections.primitives.decorators.UnmodifiableIntListI * The methods of this class all throw a NullPointerException is the * provided collections are null. * - * @version $Revision: 1.3 $ $Date: 2003/08/31 17:21:15 $ + * @version $Revision: 1.4 $ $Date: 2003/10/09 20:51:15 $ * * @author Rodney Waldhoff */ @@ -120,7 +120,7 @@ public final class IntCollections { /** * Returns an unmodifiable version of the given non-null IntIterator. - * @param list the non-null IntIterator to wrap in an unmodifiable decorator + * @param iter the non-null IntIterator to wrap in an unmodifiable decorator * @return an unmodifiable version of the given non-null IntIterator * @throws NullPointerException if the given IntIterator is null * @see org.apache.commons.collections.primitives.decorators.UnmodifiableIntIterator#wrap @@ -134,7 +134,7 @@ public final class IntCollections { /** * Returns an unmodifiable version of the given non-null IntListIterator. - * @param list the non-null IntListIterator to wrap in an unmodifiable decorator + * @param iter the non-null IntListIterator to wrap in an unmodifiable decorator * @return an unmodifiable version of the given non-null IntListIterator * @throws NullPointerException if the given IntListIterator is null * @see org.apache.commons.collections.primitives.decorators.UnmodifiableIntListIterator#wrap