svn commit: r907630 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java

[se...@apache.org]

Author: sebb
Date: Mon Feb  8 12:22:32 2010
New Revision: 907630

URL: http://svn.apache.org/viewvc?rev=907630&view=rev
Log:
Javadoc clarification

Modified:
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java?rev=907630&r1=907629&r2=907630&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java Mon Feb  8 12:22:32 2010
@@ -402,6 +402,8 @@
 
     /**
      * Gets the next token from the String.
+     * Equivalent to {@link #next()} except it returns null rather than
+     * throwing {@link NoSuchElementException} when no tokens remain.
      *
      * @return the next sequential token, or null when no more tokens are found
      */
@@ -506,9 +508,10 @@
     }
 
     /**
-     * Gets the next token. This method is equivalent to {@link #nextToken()}.
+     * Gets the next token.
      *
      * @return the next String token
+     * @throws NoSuchElementException if there are no more elements
      */
     public String next() {
         if (hasNext()) {