You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2004/05/22 00:43:10 UTC
cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections IteratorUtils.java
scolebourne 2004/05/21 15:43:10
Modified: collections/src/java/org/apache/commons/collections
IteratorUtils.java
Log:
Add binary incompatability warnings on problem methods
Revision Changes Path
1.25 +26 -6 jakarta-commons/collections/src/java/org/apache/commons/collections/IteratorUtils.java
Index: IteratorUtils.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/IteratorUtils.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- IteratorUtils.java 9 Apr 2004 22:53:27 -0000 1.24
+++ IteratorUtils.java 21 May 2004 22:43:10 -0000 1.25
@@ -63,23 +63,27 @@
// public classes allow invalid states
/**
- * An iterator over no elements
+ * An iterator over no elements.
+ * <p>
+ * WARNING: This constant is binary incompatible with Commons Collections 2.1.
*/
public static final ResettableIterator EMPTY_ITERATOR = new EmptyIterator();
/**
- * A list iterator over no elements
+ * A list iterator over no elements.
+ * <p>
+ * WARNING: This constant is binary incompatible with Commons Collections 2.1.
*/
public static final ResettableListIterator EMPTY_LIST_ITERATOR = new EmptyListIterator();
/**
- * An ordered iterator over no elements
+ * An ordered iterator over no elements.
*/
public static final OrderedIterator EMPTY_ORDERED_ITERATOR = new EmptyOrderedIterator();
/**
- * A map iterator over no elements
+ * A map iterator over no elements.
*/
public static final MapIterator EMPTY_MAP_ITERATOR = new EmptyMapIterator();
/**
- * An ordered map iterator over no elements
+ * An ordered map iterator over no elements.
*/
public static final OrderedMapIterator EMPTY_ORDERED_MAP_ITERATOR = new EmptyOrderedMapIterator();
@@ -96,6 +100,8 @@
* <p>
* This iterator is a valid iterator object that will iterate over
* nothing.
+ * <p>
+ * WARNING: This method is binary incompatible with Commons Collections 2.1.
*
* @return an iterator over nothing
*/
@@ -108,6 +114,8 @@
* <p>
* This iterator is a valid list iterator object that will iterate
* over nothing.
+ * <p>
+ * WARNING: This method is binary incompatible with Commons Collections 2.1.
*
* @return a list iterator over nothing
*/
@@ -158,6 +166,9 @@
* <p>
* This iterator is a valid iterator object that will iterate over
* the specified object.
+ * <p>
+ * WARNING: This method is binary incompatible with Commons Collections 2.1.
+ * Use <code>new SingletonIterator(object)</code> for compatability.
*
* @param object the single object over which to iterate
* @return a singleton iterator over the object
@@ -183,6 +194,9 @@
//-----------------------------------------------------------------------
/**
* Gets an iterator over an object array.
+ * <p>
+ * WARNING: This method is binary incompatible with Commons Collections 2.1.
+ * Use <code>new ArrayIterator(array)</code> for compatability.
*
* @param array the array over which to iterate
* @return an iterator over the array
@@ -209,6 +223,9 @@
/**
* Gets an iterator over the end part of an object array.
+ * <p>
+ * WARNING: This method is binary incompatible with Commons Collections 2.1.
+ * Use <code>new ArrayIterator(array,start)</code> for compatability.
*
* @param array the array over which to iterate
* @param start the index to start iterating at
@@ -241,6 +258,9 @@
/**
* Gets an iterator over part of an object array.
+ * <p>
+ * WARNING: This method is binary incompatible with Commons Collections 2.1.
+ * Use <code>new ArrayIterator(array,start,end)</code> for compatability.
*
* @param array the array over which to iterate
* @param start the index to start iterating at
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org