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/04/10 00:53:27 UTC
cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections IteratorUtils.java
scolebourne 2004/04/09 15:53:27
Modified: collections/src/java/org/apache/commons/collections
IteratorUtils.java
Log:
Add since tags and Javadoc
Revision Changes Path
1.24 +15 -2 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.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- IteratorUtils.java 20 Mar 2004 00:21:08 -0000 1.23
+++ IteratorUtils.java 9 Apr 2004 22:53:27 -0000 1.24
@@ -556,7 +556,8 @@
*
* @param root the root object to start iterating from, null results in an empty iterator
* @param transformer the transformer to use, see above, null uses no effect transformer
- * @return
+ * @return a new object graph iterator
+ * @since Commons Collections 3.1
*/
public static Iterator objectGraphIterator(Object root, Transformer transformer) {
return new ObjectGraphIterator(root, transformer);
@@ -572,6 +573,7 @@
*
* @param iterator the iterator to use, not null
* @param transform the transform to use, not null
+ * @return a new transforming iterator
* @throws NullPointerException if either parameter is null
*/
public static Iterator transformedIterator(Iterator iterator, Transformer transform) {
@@ -594,6 +596,7 @@
*
* @param iterator the iterator to use, not null
* @param predicate the predicate to use as a filter, not null
+ * @return a new filtered iterator
* @throws NullPointerException if either parameter is null
*/
public static Iterator filteredIterator(Iterator iterator, Predicate predicate) {
@@ -614,6 +617,7 @@
*
* @param listIterator the list iterator to use, not null
* @param predicate the predicate to use as a filter, not null
+ * @return a new filtered iterator
* @throws NullPointerException if either parameter is null
*/
public static ListIterator filteredListIterator(ListIterator listIterator, Predicate predicate) {
@@ -636,6 +640,7 @@
* to start with.
*
* @param coll the collection to iterate over, not null
+ * @return a new looping iterator
* @throws NullPointerException if the collection is null
*/
public static ResettableIterator loopingIterator(Collection coll) {
@@ -651,6 +656,7 @@
* Gets an iterator that provides an iterator view of the given enumeration.
*
* @param enumeration the enumeration to use
+ * @return a new iterator
*/
public static Iterator asIterator(Enumeration enumeration) {
if (enumeration == null) {
@@ -665,6 +671,7 @@
*
* @param enumeration the enumeration to use
* @param removeCollection the collection to remove elements from
+ * @return a new iterator
*/
public static Iterator asIterator(Enumeration enumeration, Collection removeCollection) {
if (enumeration == null) {
@@ -680,6 +687,7 @@
* Gets an enumeration that wraps an iterator.
*
* @param iterator the iterator to use, not null
+ * @return a new enumeration
* @throws NullPointerException if iterator is null
*/
public static Enumeration asEnumeration(Iterator iterator) {
@@ -696,6 +704,7 @@
* cached, permitting all required operations of ListIterator.
*
* @param iterator the iterator to use, not null
+ * @return a new iterator
* @throws NullPointerException if iterator parameter is null
*/
public static ListIterator toListIterator(Iterator iterator) {
@@ -712,6 +721,7 @@
* created. At the end, this is converted to an array.
*
* @param iterator the iterator to use, not null
+ * @return an array of the iterator contents
* @throws NullPointerException if iterator parameter is null
*/
public static Object[] toArray(Iterator iterator) {
@@ -730,6 +740,7 @@
*
* @param iterator the iterator to use, not null
* @param arrayClass the class of array to create
+ * @return an array of the iterator contents
* @throws NullPointerException if iterator parameter is null
* @throws NullPointerException if arrayClass is null
* @throws ClassCastException if the arrayClass is invalid
@@ -752,6 +763,7 @@
* created. At the end, the list is returned.
*
* @param iterator the iterator to use, not null
+ * @return a list of the iterator contents
* @throws NullPointerException if iterator parameter is null
*/
public static List toList(Iterator iterator) {
@@ -766,6 +778,7 @@
*
* @param iterator the iterator to use, not null
* @param estimatedSize the initial size of the ArrayList
+ * @return a list of the iterator contents
* @throws NullPointerException if iterator parameter is null
* @throws IllegalArgumentException if the size is less than 1
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org