org.apache.commons.lang
Class CharRange

java.lang.Object
  extended byorg.apache.commons.lang.CharRange
All Implemented Interfaces:
java.io.Serializable

public final class CharRange
extends java.lang.Object
implements java.io.Serializable

A contiguous range of characters, optionally negated.

Instances are immutable.

Since:
1.0
Version:
$Id: CharRange.java 471626 2006-11-06 04:02:09Z bayard $
Author:
Stephen Colebourne, Chris Feldhacker, Gary Gregory
See Also:
Serialized Form

Constructor Summary
CharRange(char ch)
          Constructs a CharRange over a single character.
CharRange(char ch, boolean negated)
          Constructs a CharRange over a single character, optionally negating the range.
CharRange(char start, char end)
          Constructs a CharRange over a set of characters.
CharRange(char start, char end, boolean negated)
          Constructs a CharRange over a set of characters, optionally negating the range.
 
Method Summary
 boolean contains(char ch)
          Is the character specified contained in this range.
 boolean contains(CharRange range)
          Are all the characters of the passed in range contained in this range.
 boolean equals(java.lang.Object obj)
          Compares two CharRange objects, returning true if they represent exactly the same range of characters defined in the same way.
 char getEnd()
          Gets the end character for this character range.
 char getStart()
          Gets the start character for this character range.
 int hashCode()
          Gets a hashCode compatible with the equals method.
 boolean isNegated()
          Is this CharRange negated.
 java.lang.String toString()
          Gets a string representation of the character range.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CharRange

public CharRange(char ch)

Constructs a CharRange over a single character.

Parameters:
ch - only character in this range

CharRange

public CharRange(char ch,
                 boolean negated)

Constructs a CharRange over a single character, optionally negating the range.

A negated range includes everything except the specified char.

Parameters:
ch - only character in this range
negated - true to express everything except the range

CharRange

public CharRange(char start,
                 char end)

Constructs a CharRange over a set of characters.

Parameters:
start - first character, inclusive, in this range
end - last character, inclusive, in this range

CharRange

public CharRange(char start,
                 char end,
                 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 - first character, inclusive, in this range
end - last character, inclusive, in this range
negated - true to express everything except the range
Method Detail

getStart

public char getStart()

Gets the start character for this character range.

Returns:
the start char (inclusive)

getEnd

public char getEnd()

Gets the end character for this character range.

Returns:
the end char (inclusive)

isNegated

public boolean isNegated()

Is this CharRange negated.

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

Returns:
true is negated

contains

public boolean contains(char ch)

Is the character specified contained in this range.

Parameters:
ch - the character to check
Returns:
true if this range contains the input character

contains

public boolean contains(CharRange range)

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

Parameters:
range - the range to check against
Returns:
true if this range entirely contains the input range
Throws:
java.lang.IllegalArgumentException - if null input

equals

public boolean equals(java.lang.Object obj)

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

Parameters:
obj - the object to compare to
Returns:
true if equal

hashCode

public int hashCode()

Gets a hashCode compatible with the equals method.

Returns:
a suitable hashCode

toString

public java.lang.String toString()

Gets a string representation of the character range.

Returns:
string representation of this range


Copyright 2001-2008 The Apache Software Foundation. All Rights Reserved.