svn commit: r906028 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java

[niallp]

Author: niallp
Date: Wed Feb  3 12:22:27 2010
New Revision: 906028

URL: http://svn.apache.org/viewvc?rev=906028&view=rev
Log:
LANG-454 implement Iterable<Character> and some javadoc changes

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

Modified: 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java
URL: 
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java?rev=906028&r1=906027&r2=906028&view=diff
==============================================================================
--- 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java 
(original)
+++ 
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java 
Wed Feb  3 12:22:27 2010
@@ -31,7 +31,7 @@
  * @since 1.0
  * @version $Id$
  */
-public final class CharRange implements Serializable {
+public final class CharRange implements Iterable<Character>, Serializable {
 
     /**
      * Required for serialization support. Lang version 2.0. 
@@ -251,18 +251,26 @@
      *
      * @return an iterator to the chars represented by this range
      */
-    public Iterator iterator() {
+    public Iterator<Character> iterator() {
         return new CharacterIterator(this);
     }
 
-    static class CharacterIterator implements Iterator {
-        /** The currect character */
+    /**
+     * Character {...@link Iterator}.
+     */
+    private static class CharacterIterator implements Iterator<Character> {
+        /** The current character */
         private char current;
 
         private CharRange range;
         private boolean hasNext;
 
-        public CharacterIterator(CharRange r) {
+        /**
+         * Construct a new iterator for the character range.
+         *
+         * @param r The character range
+         */
+        private CharacterIterator(CharRange r) {
             range = r;
             hasNext = true;
 
@@ -282,6 +290,9 @@
             }
         }
 
+        /**
+         * Prepare the next character in the range.
+         */
         private void prepareNext() {
             if (range.negated) {
                 if (current == Character.MAX_VALUE) {
@@ -316,7 +327,7 @@
          *
          * @return <code>Character</code> for the next character
          */
-        public Object next() {
+        public Character next() {
             if (hasNext == false) {
                 throw new NoSuchElementException();
             }