scolebourne 2003/10/09 13:50:04
Modified: collections/src/java/org/apache/commons/collections/observed
ObservableSortedBag.java ObservableSortedSet.java
ObservableList.java ObservableCollection.java
ObservableBuffer.java ObservableSet.java
ModificationHandler.java ObservableBag.java
collections/src/java/org/apache/commons/collections/observed/standard
StandardModificationHandler.java
Log:
Fix various javadoc link warnings
bug 23680, from Eric Johnson
Revision Changes Path
1.2 +4 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableSortedBag.java
Index: ObservableSortedBag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableSortedBag.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObservableSortedBag.java 28 Sep 2003 21:50:37 -0000 1.1
+++ ObservableSortedBag.java 9 Oct 2003 20:50:04 -0000 1.2
@@ -67,7 +67,8 @@
* Each modifying method call made on this <code>SortedBag</code> is forwarded to a
* [EMAIL PROTECTED] ModificationHandler}.
* The handler manages the event, notifying listeners and optionally vetoing
changes.
- * The default handler is [EMAIL PROTECTED] StandardModificationHandler}.
+ * The default handler is
+ * [EMAIL PROTECTED]
org.apache.commons.collections.observed.standard.StandardModificationHandler
StandardModificationHandler}.
* See this class for details of configuration available.
*
* @since Commons Collections 3.0
1.3 +4 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableSortedSet.java
Index: ObservableSortedSet.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableSortedSet.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ObservableSortedSet.java 28 Sep 2003 21:49:50 -0000 1.2
+++ ObservableSortedSet.java 9 Oct 2003 20:50:04 -0000 1.3
@@ -66,7 +66,8 @@
* Each modifying method call made on this <code>SortedSet</code> is forwarded to a
* [EMAIL PROTECTED] ModificationHandler}.
* The handler manages the event, notifying listeners and optionally vetoing
changes.
- * The default handler is [EMAIL PROTECTED] StandardModificationHandler}.
+ * The default handler is
+ * [EMAIL PROTECTED]
org.apache.commons.collections.observed.standard.StandardModificationHandler
StandardModificationHandler}.
* See this class for details of configuration available.
*
* @since Commons Collections 3.0
1.2 +4 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableList.java
Index: ObservableList.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableList.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObservableList.java 21 Sep 2003 16:00:28 -0000 1.1
+++ ObservableList.java 9 Oct 2003 20:50:04 -0000 1.2
@@ -69,7 +69,8 @@
* Each modifying method call made on this <code>List</code> is forwarded to a
* [EMAIL PROTECTED] ModificationHandler}.
* The handler manages the event, notifying listeners and optionally vetoing
changes.
- * The default handler is [EMAIL PROTECTED] StandardModificationHandler}.
+ * The default handler is
+ * [EMAIL PROTECTED]
org.apache.commons.collections.observed.standard.StandardModificationHandler
StandardModificationHandler}.
* See this class for details of configuration available.
* <p>
* All indices on events returned by <code>subList</code> are relative to the
1.2 +3 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableCollection.java
Index: ObservableCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableCollection.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObservableCollection.java 21 Sep 2003 16:00:28 -0000 1.1
+++ ObservableCollection.java 9 Oct 2003 20:50:04 -0000 1.2
@@ -186,7 +186,7 @@
* <code>ModificationHandler</code> 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(
1.2 +4 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableBuffer.java
Index: ObservableBuffer.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableBuffer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObservableBuffer.java 21 Sep 2003 16:00:28 -0000 1.1
+++ ObservableBuffer.java 9 Oct 2003 20:50:04 -0000 1.2
@@ -65,7 +65,8 @@
* Each modifying method call made on this <code>Buffer</code> is forwarded to a
* [EMAIL PROTECTED] ModificationHandler}.
* The handler manages the event, notifying listeners and optionally vetoing
changes.
- * The default handler is [EMAIL PROTECTED] StandardModificationHandler}.
+ * The default handler is
+ * [EMAIL PROTECTED]
org.apache.commons.collections.observed.standard.StandardModificationHandler
StandardModificationHandler}.
* See this class for details of configuration available.
*
* @since Commons Collections 3.0
1.2 +4 -4
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableSet.java
Index: ObservableSet.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableSet.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObservableSet.java 21 Sep 2003 16:00:28 -0000 1.1
+++ ObservableSet.java 9 Oct 2003 20:50:04 -0000 1.2
@@ -59,14 +59,14 @@
import java.util.Set;
-
/**
* Decorates a <code>Set</code> implementation to observe modifications.
* <p>
* Each modifying method call made on this <code>Set</code> is forwarded to a
* [EMAIL PROTECTED] ModificationHandler}.
* The handler manages the event, notifying listeners and optionally vetoing
changes.
- * The default handler is [EMAIL PROTECTED] StandardModificationHandler}.
+ * The default handler is
+ * [EMAIL PROTECTED]
org.apache.commons.collections.observed.standard.StandardModificationHandler
StandardModificationHandler}.
* See this class for details of configuration available.
*
* @since Commons Collections 3.0
1.8 +34 -34
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ModificationHandler.java
Index: ModificationHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ModificationHandler.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ModificationHandler.java 21 Sep 2003 20:01:53 -0000 1.7
+++ ModificationHandler.java 9 Oct 2003 20:50:04 -0000 1.8
@@ -324,7 +324,7 @@
/**
* Store data and send event before add(obj) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
* It does not set the index for List implementations.
*
* @param object the object being added
@@ -337,7 +337,7 @@
/**
* Send an event after add(obj) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
* It does not set the index for List implementations.
*
* @param object the object being added
@@ -351,7 +351,7 @@
/**
* Store data and send event before add(int,obj) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index to add at
* @param object the object being added
@@ -364,7 +364,7 @@
/**
* Send an event after add(int,obj) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index to add at
* @param object the object being added
@@ -377,7 +377,7 @@
/**
* Store data and send event before add(obj,int) is called on a Bag.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param object the object being added
* @param nCopies the number of copies being added
@@ -390,7 +390,7 @@
/**
* Send an event after add(obj,int) is called on a Bag.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
* The method result is not used by this implementation (Bag violates the
* Collection contract)
*
@@ -406,7 +406,7 @@
/**
* Store data and send event before add(obj) is called on a ListIterator.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index of the iterator
* @param object the object being added
@@ -419,7 +419,7 @@
/**
* Send an event after add(obj) is called on a ListIterator.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index of the iterator
* @param object the object being added
@@ -433,7 +433,7 @@
/**
* Store data and send event before addAll(coll) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param coll the collection being added
* @return true to process modification
@@ -445,7 +445,7 @@
/**
* Send an event after addAll(coll) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param coll the collection being added
* @param collChanged the result from the addAll method
@@ -458,7 +458,7 @@
/**
* Store data and send event before addAll(int,coll) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index to addAll at
* @param coll the collection being added
@@ -471,7 +471,7 @@
/**
* Send an event after addAll(int,coll) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index to addAll at
* @param coll the collection being added
@@ -485,7 +485,7 @@
/**
* Store data and send event before clear() is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @return true to process modification
*/
@@ -496,7 +496,7 @@
/**
* Send an event after clear() is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*/
protected void postClear() {
// assumes a modification occurred
@@ -507,7 +507,7 @@
/**
* Store data and send event before remove(obj) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param object the object being removed
* @return true to process modification
@@ -519,7 +519,7 @@
/**
* Send an event after remove(obj) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param object the object being removed
* @param collChanged the result from the remove method
@@ -532,7 +532,7 @@
/**
* Store data and send event before remove(int) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index to remove at
* @return true to process modification
@@ -546,7 +546,7 @@
/**
* Send an event after remove(int) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index to remove at
* @param previousValue the result from the remove method
@@ -559,7 +559,7 @@
/**
* Store data and send event before remove(obj,int) is called on a Bag.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param object the object being removed
* @param nCopies the number of copies being removed
@@ -572,7 +572,7 @@
/**
* Send an event after remove(obj,int) is called on a Bag.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param object the object being removed
* @param nCopies the number of copies being removed
@@ -586,7 +586,7 @@
/**
* Store data and send event before remove() is called on a Buffer.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @return true to process modification
*/
@@ -597,7 +597,7 @@
/**
* Send an event after remove() is called on a Buffer.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param removedValue the previous value at this index
*/
@@ -610,7 +610,7 @@
/**
* Store data and send event before remove(obj) is called on an Iterator.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index of the iterator
* @param removedValue the object being removed
@@ -623,7 +623,7 @@
/**
* Send an event after remove(obj) is called on an Iterator.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index of the iterator
* @param removedValue the previous value at this index
@@ -637,7 +637,7 @@
/**
* Store data and send event before removeAll(coll) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param coll the collection being removed
* @return true to process modification
@@ -649,7 +649,7 @@
/**
* Send an event after removeAll(coll) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param coll the collection being removed
* @param collChanged the result from the removeAll method
@@ -662,7 +662,7 @@
/**
* Store data and send event before retainAll(coll) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param coll the collection being retained
* @return true to process modification
@@ -674,7 +674,7 @@
/**
* Send an event after retainAll(coll) is called.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param coll the collection being retained
* @param collChanged the result from the retainAll method
@@ -687,7 +687,7 @@
/**
* Store data and send event before set(int,obj) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index to add at
* @param object the object being added
@@ -702,7 +702,7 @@
/**
* Send an event after set(int,obj) is called on a List.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index to add at
* @param object the object being added
@@ -717,7 +717,7 @@
/**
* Store data and send event before set(obj) is called on a ListIterator.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #preEvent(int, int,
Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #preEvent}.
*
* @param index the index to set at
* @param object the object being added
@@ -731,7 +731,7 @@
/**
* Send an event after set(obj) is called on a ListIterator.
* <p>
- * This implementation forwards to [EMAIL PROTECTED] #postEvent(boolean, int,
int, Object, int, Object, Object, int)}.
+ * This implementation forwards to [EMAIL PROTECTED] #postEvent}.
*
* @param index the index to set at
* @param object the object being added
1.2 +4 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableBag.java
Index: ObservableBag.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/ObservableBag.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObservableBag.java 21 Sep 2003 16:00:28 -0000 1.1
+++ ObservableBag.java 9 Oct 2003 20:50:04 -0000 1.2
@@ -67,7 +67,8 @@
* Each modifying method call made on this <code>Bag</code> is forwarded to a
* [EMAIL PROTECTED] ModificationHandler}.
* The handler manages the event, notifying listeners and optionally vetoing
changes.
- * The default handler is [EMAIL PROTECTED] StandardModificationHandler}.
+ * The default handler is
+ * [EMAIL PROTECTED]
org.apache.commons.collections.observed.standard.StandardModificationHandler
StandardModificationHandler}.
* See this class for details of configuration available.
* <p>
* NOTE: The [EMAIL PROTECTED] #uniqueSet()} method returns a <code>Set</code> that
is
1.7 +8 -10
jakarta-commons/collections/src/java/org/apache/commons/collections/observed/standard/StandardModificationHandler.java
Index: StandardModificationHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/observed/standard/StandardModificationHandler.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- StandardModificationHandler.java 21 Sep 2003 20:00:29 -0000 1.6
+++ StandardModificationHandler.java 9 Oct 2003 20:50:04 -0000 1.7
@@ -111,9 +111,9 @@
/**
* Constructor the creates the handler but leaves it invalid.
* <p>
- * The handler can only be used after [EMAIL PROTECTED]
#init(ObservableCollection)} is
- * called. This is normally done automatically by
- * [EMAIL PROTECTED] ObservableCollection#decorate(Collection,
ModificationHandler)}.
+ * The handler can only be used after it has been properly initialized.
+ * This is normally done automatically by
+ * [EMAIL PROTECTED] ObservableCollection#decorate(Collection, Object)}.
*/
public StandardModificationHandler() {
super();
@@ -122,9 +122,9 @@
/**
* Constructor the creates the handler but leaves it invalid.
* <p>
- * The handler can only be used after [EMAIL PROTECTED]
#init(ObservableCollection)} is
- * called. This is normally done automatically by
- * [EMAIL PROTECTED] ObservableCollection#decorate(Collection,
ModificationHandler)}.
+ * The handler can only be used after it has been properly initialized.
+ * This is normally done automatically by
+ * [EMAIL PROTECTED] ObservableCollection#decorate(Collection, Object)}.
*
* @param pre the pre listener
* @param preMask the mask for the pre listener
@@ -244,7 +244,6 @@
*
* @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 @@
*
* @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) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
