Modifier and Type	Class and Description
private static class	CharRange.CharacterIterator Character `Iterator`.

Modifier and Type	Field and Description
pack-priv static final CharRange[]	EMPTY_ARRAY Empty array.
private final char	end The last character, inclusive, in the range.
private transient String	iToString Cached toString.
private final boolean	negated True if the range is everything except the characters specified.
private static final long	serialVersionUID Required for serialization support.
private final char	start The first character, inclusive, in the range.

Access	Constructor and Description
private	CharRange(char first character, inclusive, in this range start, char last character, inclusive, in this range end, final boolean true to express everything except the range negated) Constructs a `CharRange` over a set of characters, optionally negating the range.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if this range contains the input character contains(final char the character to check ch) Is the character specified contained in this range.
public boolean	Returns: `true` if this range entirely contains the input range contains(final CharRange the range to check against range) Are all the characters of the passed in range contained in this range.
public boolean	Returns: true if equal equals(final Object the object to compare to obj) Overrides java.lang.Object.equals. Compares two CharRange objects, returning true if they represent exactly the same range of characters defined in the same way.
public char	Returns: the end char (inclusive) getEnd() Gets the end character for this character range.
public char	Returns: the start char (inclusive) getStart() Gets the start character for this character range.
public int	Returns: a suitable hashCode hashCode() Overrides java.lang.Object.hashCode. Gets a hashCode compatible with the equals method.
public static CharRange	Returns: the new CharRange object is(final char only character in this range ch) Constructs a `CharRange` over a single character.
public static CharRange	Returns: the new CharRange object isIn(final char first character, inclusive, in this range start, final char last character, inclusive, in this range end) Constructs a `CharRange` over a set of characters.
public boolean	Returns: `true` if negated isNegated() Is this `CharRange` negated.
public static CharRange	Returns: the new CharRange object isNot(final char only character in this range ch) Constructs a negated `CharRange` over a single character.
public static CharRange	Returns: the new CharRange object isNotIn(final char first character, inclusive, in this range start, final char last character, inclusive, in this range end) Constructs a negated `CharRange` over a set of characters.
public Iterator<Character>	Returns: an iterator to the chars represented by this range iterator() Implements java.lang.Iterable.iterator. Returns an iterator which can be used to walk through the characters described by this range.
public String	Returns: string representation of this range toString() Overrides java.lang.Object.toString. Gets a string representation of the character range.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

EMPTY_ARRAY	back to summary
pack-priv static final CharRange[] EMPTY_ARRAY Empty array.

end	back to summary
private final char end The last character, inclusive, in the range.

iToString	back to summary
private transient String iToString Cached toString.

negated	back to summary
private final boolean negated True if the range is everything except the characters specified.

serialVersionUID back to summary

serialVersionUID	back to summary
private static final long serialVersionUID Required for serialization support. Lang version 2.0. See Also `java.io.Serializable`

private static final long serialVersionUID

Required for serialization support. Lang version 2.0.

See Also: java.io.Serializable

start	back to summary
private final char start The first character, inclusive, in the range.

Constructor Detail

CharRange back to summary

CharRange	back to summary
private CharRange(char start, char end, final boolean negated) Constructs a `CharRange` over a set of characters, optionally negating the range. A negated range includes everything except that defined by the start and end characters. If start and end are in the wrong order, they are reversed. Thus `a-e` is the same as `e-a`. Parameters start:char first character, inclusive, in this range end:char last character, inclusive, in this range negated:boolean true to express everything except the range

private CharRange(char start, char end, final boolean negated)

Constructs a CharRange over a set of characters, optionally negating the range.

A negated range includes everything except that defined by the start and end characters.

If start and end are in the wrong order, they are reversed. Thus a-e is the same as e-a.

Parameters

start:char: first character, inclusive, in this range
end:char: last character, inclusive, in this range
negated:boolean: true to express everything except the range

Method Detail

contains back to summary

contains	back to summary
public boolean contains(final char ch) Is the character specified contained in this range. Parameters ch:char the character to check Returns:boolean `true` if this range contains the input character

public boolean contains(final char ch)

Is the character specified contained in this range.

Parameters

ch:char: the character to check

Returns:boolean

true if this range contains the input character

contains back to summary

contains	back to summary
public boolean contains(final CharRange range) Are all the characters of the passed in range contained in this range. Parameters range:CharRange the range to check against Returns:boolean `true` if this range entirely contains the input range Exceptions NullPointerException: if `null` input

public boolean contains(final CharRange range)

Are all the characters of the passed in range contained in this range.

Parameters

range:CharRange: the range to check against

Returns:boolean

true if this range entirely contains the input range

Exceptions

NullPointerException:: if null input

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Compares two CharRange objects, returning true if they represent exactly the same range of characters defined in the same way. Parameters obj:Object the object to compare to Returns:boolean true if equal Annotations @Override

equals

back to summary

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Compares two CharRange objects, returning true if they represent exactly the same range of characters defined in the same way.

Parameters

obj:Object: the object to compare to

Returns:boolean

true if equal

Annotations

@Override

getEnd	back to summary
public char getEnd() Gets the end character for this character range. Returns:char the end char (inclusive)

getEnd

back to summary

public char getEnd()

Gets the end character for this character range.

Returns:char: the end char (inclusive)

getStart	back to summary
public char getStart() Gets the start character for this character range. Returns:char the start char (inclusive)

getStart

back to summary

public char getStart()

Gets the start character for this character range.

Returns:char: the start char (inclusive)

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Gets a hashCode compatible with the equals method. Returns:int a suitable hashCode Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Gets a hashCode compatible with the equals method.

Returns:int

a suitable hashCode

Annotations

@Override

is back to summary

is	back to summary
public static CharRange is(final char ch) Constructs a `CharRange` over a single character. Parameters ch:char only character in this range Returns:CharRange the new CharRange object Since 2.5

public static CharRange is(final char ch)

Constructs a CharRange over a single character.

Parameters

ch:char: only character in this range

Returns:CharRange

the new CharRange object

Since

2.5

isIn back to summary

isIn	back to summary
public static CharRange isIn(final char start, final char end) Constructs a `CharRange` over a set of characters. If start and end are in the wrong order, they are reversed. Thus `a-e` is the same as `e-a`. Parameters start:char first character, inclusive, in this range end:char last character, inclusive, in this range Returns:CharRange the new CharRange object Since 2.5

public static CharRange isIn(final char start, final char end)

Constructs a CharRange over a set of characters.

If start and end are in the wrong order, they are reversed. Thus a-e is the same as e-a.

Parameters

start:char: first character, inclusive, in this range
end:char: last character, inclusive, in this range

Returns:CharRange

the new CharRange object

Since

2.5

isNegated back to summary

isNegated	back to summary
public boolean isNegated() Is this `CharRange` negated. A negated range includes everything except that defined by the start and end characters. Returns:boolean `true` if negated

public boolean isNegated()

Is this CharRange negated.

A negated range includes everything except that defined by the start and end characters.

Returns:boolean: true if negated

isNot back to summary

isNot	back to summary
public static CharRange isNot(final char ch) Constructs a negated `CharRange` over a single character. A negated range includes everything except that defined by the single character. Parameters ch:char only character in this range Returns:CharRange the new CharRange object Since 2.5

public static CharRange isNot(final char ch)

Constructs a negated CharRange over a single character.

A negated range includes everything except that defined by the single character.

Parameters

ch:char: only character in this range

Returns:CharRange

the new CharRange object

Since

2.5

isNotIn back to summary

isNotIn	back to summary
public static CharRange isNotIn(final char start, final char end) Constructs a negated `CharRange` over a set of characters. A negated range includes everything except that defined by the start and end characters. If start and end are in the wrong order, they are reversed. Thus `a-e` is the same as `e-a`. Parameters start:char first character, inclusive, in this range end:char last character, inclusive, in this range Returns:CharRange the new CharRange object Since 2.5

public static CharRange isNotIn(final char start, final char end)

Constructs a negated CharRange over a set of characters.

A negated range includes everything except that defined by the start and end characters.

If start and end are in the wrong order, they are reversed. Thus a-e is the same as e-a.

Parameters

start:char: first character, inclusive, in this range
end:char: last character, inclusive, in this range

Returns:CharRange

the new CharRange object

Since

2.5

iterator	back to summary
public Iterator<Character> iterator() Implements java.lang.Iterable.iterator. Returns an iterator which can be used to walk through the characters described by this range. #NotThreadSafe# the iterator is not thread-safe Returns:Iterator<Character> an iterator to the chars represented by this range Annotations @Override Since 2.5

iterator

back to summary

public Iterator<Character> iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator which can be used to walk through the characters described by this range.

#NotThreadSafe# the iterator is not thread-safe

Returns:Iterator<Character>

an iterator to the chars represented by this range

Annotations

@Override

Since

2.5

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Gets a string representation of the character range. Returns:String string representation of this range Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Gets a string representation of the character range.

Returns:String

string representation of this range

Annotations

@Override

org.apache.commons.lang3 back to summary

private final Class CharRange.CharacterIterator

Class Inheritance

extends Object
implements Iterator<Character>

java.lang.Object
org.apache.commons.lang3.CharRange.CharacterIterator

All Implemented Interfaces

java.util.Iterator

Character Iterator.

#NotThreadSafe#

Field Summary

Modifier and Type	Field and Description
private char	current The current character
private boolean	hasNext
private final CharRange	range

Constructor Summary

Access	Constructor and Description
private	CharacterIterator(final CharRange The character range r) Constructs a new iterator for the character range.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the iterator has yet to reach the character date hasNext() Implements java.util.Iterator.hasNext. Has the iterator not reached the end character yet?
public Character	Returns: `Character` for the next character next() Implements java.util.Iterator.next. Returns the next character in the iteration
private void	prepareNext() Prepares the next character in the range.
public void	remove() Overrides default java.util.Iterator.remove. Always throws UnsupportedOperationException.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

current	back to summary
private char current The current character

hasNext	back to summary
private boolean hasNext

range	back to summary
private final CharRange range

Constructor Detail

CharacterIterator	back to summary
private CharacterIterator(final CharRange r) Constructs a new iterator for the character range. Parameters r:CharRange The character range

CharacterIterator

back to summary

private CharacterIterator(final CharRange r)

Constructs a new iterator for the character range.

Parameters

r:CharRange: The character range

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Has the iterator not reached the end character yet? Returns:boolean `true` if the iterator has yet to reach the character date Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Has the iterator not reached the end character yet?

Returns:boolean

true if the iterator has yet to reach the character date

Annotations

@Override

next back to summary

next	back to summary
public Character next() Implements java.util.Iterator.next. Returns the next character in the iteration Returns:Character `Character` for the next character Annotations @Override

public Character next()

Implements java.util.Iterator.next.

Returns the next character in the iteration

Returns:Character

Character for the next character

Annotations

@Override

prepareNext	back to summary
private void prepareNext() Prepares the next character in the range.

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Always throws UnsupportedOperationException. Annotations @Override Exceptions UnsupportedOperationException: Always thrown. See Also `java.util.Iterator#remove()`

public void remove()

Overrides default java.util.Iterator.remove.

Always throws UnsupportedOperationException.

Annotations