org.apache.commons.lang
Class CharRange

java.lang.Object
  |
  +--org.apache.commons.lang.CharRange

class CharRange

extends Object

A range of characters. Able to understand the idea of a contiguous sublist of an alphabet, a negated concept, and a set of characters. Used by CharSet to handle sets of characters.

Version:

$Id: CharRange.java,v 1.1 2002/07/19 03:35:54 bayard Exp $

Author:

Henri Yandell, Stephen Colebourne

Field Summary

private char	close
private boolean	negated
private char	start
private static char	UNSET Used internally to represent null in a char.

Constructor Summary

CharRange(char start)
Construct a CharRange over a single character.

CharRange(char start, char close)
Construct a CharRange over a set of characters.

CharRange(String start, String close)
Construct a CharRange over a set of characters.

Method Summary

char	getEnd() Get the end character for this character range
char	getStart() Get the start character for this character range
boolean	inRange(char ch) Is the passed in character inside this range
boolean	isNegated() Checks if this CharRange is negated.
boolean	isRange() Is this CharRange over many characters
void	setEnd(char ch) Set the end character for this character range
void	setNegated(boolean negated) Sets this character range to be negated or not.
void	setStart(char ch) Set the start character for this character range
String	toString() Output a string representation of the character range

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNSET

private static char UNSET

Used internally to represent null in a char.

start

private char start

close

private char close

negated

private boolean negated

Constructor Detail

CharRange

public CharRange(char start)

Construct a CharRange over a single character.

Parameters:

start - char over which this range is placed

CharRange

public CharRange(char start,
                 char close)

Construct a CharRange over a set of characters.

Parameters:

start - char start character in this range. inclusive

close - char close character in this range. inclusive

CharRange

public CharRange(String start,
                 String close)

Construct a CharRange over a set of characters.

Parameters:

start - String start first character is in this range (inclusive).

close - String first character is close character in this range (inclusive).

Method Detail

getStart

public char getStart()

Get the start character for this character range

Returns:

start char (inclusive)

getEnd

public char getEnd()

Get the end character for this character range

Returns:

end char (inclusive)

setStart

public void setStart(char ch)

Set the start character for this character range

Parameters:

ch - start char (inclusive)

setEnd

public void setEnd(char ch)

Set the end character for this character range

Parameters:

ch - start char (inclusive)

isRange

public boolean isRange()

Is this CharRange over many characters

Returns:

boolean true is many characters

inRange

public boolean inRange(char ch)

Is the passed in character inside this range

Returns:

boolean true is in range

isNegated

public boolean isNegated()

Checks if this CharRange is negated.

Returns:

boolean true is negated

setNegated

public void setNegated(boolean negated)

Sets this character range to be negated or not. This implies that this CharRange is over all characters except the ones in this range.

Parameters:

negated - true to negate the range

toString

public String toString()

Output a string representation of the character range

Overrides:

toString in class Object

Returns:

string representation