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

Add binary incompatability warnings on problem methods

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131734 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-05-21 22:43:10 +00:00
parent 90154dba4b
commit 48a8545611
1 changed files with 26 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/java/org/apache/commons/collections/IteratorUtils.java
View File

@ -53,7 +53,7 @@ import org.apache.commons.collections.iterators.UnmodifiableMapIterator;
* instances. The implementations are provided in the iterators subpackage.
*
* @since Commons Collections 2.1
* @version $Revision: 1.24 $ $Date: 2004/04/09 22:53:27 $
* @version $Revision: 1.25 $ $Date: 2004/05/21 22:43:10 $
*
* @author Stephen Colebourne
* @author Phil Steitz
@ -63,23 +63,27 @@ public class IteratorUtils {
// 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 @@ public class IteratorUtils {
* <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 @@ public class IteratorUtils {
* <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 @@ public class IteratorUtils {
* <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 @@ public class IteratorUtils {
//-----------------------------------------------------------------------
/**
* 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 @@ public class IteratorUtils {
/**
* 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 @@ public class IteratorUtils {
/**
* 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