Javadoc

Author: garydgregory

src/main/java/org/apache/commons/lang3/CharRange.java

@@ -47,7 +47,7 @@ private static final class CharacterIterator implements Iterator<Character> {
         /**
          * Constructs a new iterator for the character range.
          *
-         * @param r The character range
+         * @param r The character range.
          */
         private CharacterIterator(final CharRange r) {
             range = r;
@@ -70,19 +70,19 @@ private CharacterIterator(final CharRange r) {
         }
 
         /**
-         * Has the iterator not reached the end character yet?
+         * Tests whether this iterator reached the end character.
          *
-         * @return {@code true} if the iterator has yet to reach the character date
+         * @return {@code true} if the iterator has yet to reach the character date.
          */
         @Override
         public boolean hasNext() {
             return hasNext;
         }
 
         /**
-         * Returns the next character in the iteration
+         * Returns the next character in the iteration.
          *
-         * @return {@link Character} for the next character
+         * @return {@link Character} for the next character.
          */
         @Override
         public Character next() {
@@ -142,8 +142,8 @@ public void remove() {
     /**
      * Constructs a {@link CharRange} over a single character.
      *
-     * @param ch  only character in this range
-     * @return the new CharRange object
+     * @param ch  only character in this range.
+     * @return the new CharRange object.
      * @since 2.5
      */
     public static CharRange is(final char ch) {
@@ -156,9 +156,9 @@ public static CharRange is(final char ch) {
      * <p>If start and end are in the wrong order, they are reversed.
      * Thus {@code a-e} is the same as {@code e-a}.</p>
      *
-     * @param start  first character, inclusive, in this range
-     * @param end  last character, inclusive, in this range
-     * @return the new CharRange object
+     * @param start  first character, inclusive, in this range.
+     * @param end  last character, inclusive, in this range.
+     * @return the new CharRange object.
      * @since 2.5
      */
     public static CharRange isIn(final char start, final char end) {
@@ -171,8 +171,8 @@ public static CharRange isIn(final char start, final char end) {
      * <p>A negated range includes everything except that defined by the
      * single character.</p>
      *
-     * @param ch  only character in this range
-     * @return the new CharRange object
+     * @param ch  only character in this range.
+     * @return the new CharRange object.
      * @since 2.5
      */
     public static CharRange isNot(final char ch) {
@@ -188,9 +188,9 @@ public static CharRange isNot(final char ch) {
      * <p>If start and end are in the wrong order, they are reversed.
      * Thus {@code a-e} is the same as {@code e-a}.</p>
      *
-     * @param start  first character, inclusive, in this range
-     * @param end  last character, inclusive, in this range
-     * @return the new CharRange object
+     * @param start  first character, inclusive, in this range.
+     * @param end  last character, inclusive, in this range.
+     * @return the new CharRange object.
      * @since 2.5
      */
     public static CharRange isNotIn(final char start, final char end) {
@@ -219,9 +219,9 @@ public static CharRange isNotIn(final char start, final char end) {
      * <p>If start and end are in the wrong order, they are reversed.
      * Thus {@code a-e} is the same as {@code e-a}.</p>
      *
-     * @param start  first character, inclusive, in this range
-     * @param end  last character, inclusive, in this range
-     * @param negated  true to express everything except the range
+     * @param start  first character, inclusive, in this range.
+     * @param end  last character, inclusive, in this range.
+     * @param negated  true to express everything except the range.
      */
     private CharRange(char start, char end, final boolean negated) {
         if (start > end) {
@@ -239,8 +239,8 @@ private CharRange(char start, char end, final boolean negated) {
     /**
      * Is the character specified contained in this range.
      *
-     * @param ch  the character to check
-     * @return {@code true} if this range contains the input character
+     * @param ch  the character to check.
+     * @return {@code true} if this range contains the input character.
      */
     public boolean contains(final char ch) {
         return (ch >= start && ch <= end) != negated;
@@ -250,9 +250,9 @@ public boolean contains(final char ch) {
      * Are all the characters of the passed in range contained in
      * this range.
      *
-     * @param range  the range to check against
-     * @return {@code true} if this range entirely contains the input range
-     * @throws NullPointerException if {@code null} input
+     * @param range  the range to check against.
+     * @return {@code true} if this range entirely contains the input range.
+     * @throws NullPointerException if {@code null} input.
      */
     public boolean contains(final CharRange range) {
         Objects.requireNonNull(range, "range");
@@ -273,8 +273,8 @@ public boolean contains(final CharRange range) {
      * Compares two CharRange objects, returning true if they represent
      * exactly the same range of characters defined in the same way.
      *
-     * @param obj  the object to compare to
-     * @return true if equal
+     * @param obj  the object to compare to.
+     * @return true if equal.
      */
     @Override
     public boolean equals(final Object obj) {
@@ -291,7 +291,7 @@ public boolean equals(final Object obj) {
     /**
      * Gets the end character for this character range.
      *
-     * @return the end char (inclusive)
+     * @return the end char (inclusive).
      */
     public char getEnd() {
         return this.end;
@@ -301,7 +301,7 @@ public char getEnd() {
     /**
      * Gets the start character for this character range.
      *
-     * @return the start char (inclusive)
+     * @return the start char (inclusive).
      */
     public char getStart() {
         return this.start;
@@ -310,7 +310,7 @@ public char getStart() {
     /**
      * Gets a hashCode compatible with the equals method.
      *
-     * @return a suitable hashCode
+     * @return a suitable hashCode.
      */
     @Override
     public int hashCode() {
@@ -323,7 +323,7 @@ public int hashCode() {
      * <p>A negated range includes everything except that defined by the
      * start and end characters.</p>
      *
-     * @return {@code true} if negated
+     * @return {@code true} if negated.
      */
     public boolean isNegated() {
         return negated;
@@ -344,7 +344,7 @@ public Iterator<Character> iterator() {
     /**
      * Gets a string representation of the character range.
      *
-     * @return string representation of this range
+     * @return string representation of this range.
      */
     @Override
     public String toString() {