commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject commons-collections git commit: Javadoc.
Date Fri, 12 Jan 2018 18:03:46 GMT
Repository: commons-collections
Updated Branches:
  refs/heads/master 22daa5f1d -> 1e6435ec1


Javadoc.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-collections/commit/1e6435ec
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/1e6435ec
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/1e6435ec

Branch: refs/heads/master
Commit: 1e6435ec103c1d52b119602a3aa48bfa5775d01d
Parents: 22daa5f
Author: Gary Gregory <ggregory@apache.org>
Authored: Fri Jan 12 11:03:43 2018 -0700
Committer: Gary Gregory <ggregory@apache.org>
Committed: Fri Jan 12 11:03:43 2018 -0700

----------------------------------------------------------------------
 .../org/apache/commons/collections4/IterableUtils.java   |  4 ++++
 .../org/apache/commons/collections4/IteratorUtils.java   | 11 +++++++----
 2 files changed, 11 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/1e6435ec/src/main/java/org/apache/commons/collections4/IterableUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index d5cb444..104f4d1 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -775,10 +775,14 @@ public class IterableUtils {
     }
 
     /**
+     * Shortcut for {@code get(iterator, 0)}.
+     * <p>
      * Returns the <code>first</code> value in the <code>iterable</code>'s
{@link Iterator}, throwing
      * <code>IndexOutOfBoundsException</code> if there is no such element.
+     * </p>
      * <p>
      * If the {@link Iterable} is a {@link List}, then it will use {@link List#get(int)}.
+     * </p>
      *
      * @param <T> the type of object in the {@link Iterable}.
      * @param iterable  the {@link Iterable} to get a value from, may be null

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/1e6435ec/src/main/java/org/apache/commons/collections4/IteratorUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/IteratorUtils.java b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
index 86a2c09..79ce159 100644
--- a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
@@ -1413,14 +1413,17 @@ public class IteratorUtils {
     }
 
     /**
+     * Shortcut for {@code get(iterator, 0)}.
+     * <p>
      * Returns the <code>first</code> value in {@link Iterator}, throwing
      * <code>IndexOutOfBoundsException</code> if there is no such element.
+     * </p>
      * <p>
-     * The Iterator is advanced to <code>index</code> (or to the end, if
-     * <code>index</code> exceeds the number of entries) as a side effect of
this method.
-     *
+     * The Iterator is advanced to <code>0</code> (or to the end, if
+     * <code>0</code> exceeds the number of entries) as a side effect of this
method.
+     * </p>
      * @param <E> the type of object in the {@link Iterator}
-     * @param iterator  the iterator to get a value from
+     * @param iterator the iterator to get a value from
      * @return the first object
      * @throws IndexOutOfBoundsException if the request is invalid
      * @since 4.2


Mime
View raw message