org.foxlabs.util

Class UnicodeSet

java.lang.Object

org.foxlabs.util.UnicodeSet

All Implemented Interfaces:

Serializable

public final class UnicodeSet
extends Object
implements Serializable

This class represents a set of unicode characters and provides operations on it.

Author:

Fox Mulder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static UnicodeSet	ALNUM Character set that contains alphanumeric characters.
static UnicodeSet	ALPHA Character set that contains ASCII letters.
static UnicodeSet	ASCII Character set that contains all ASCII characters.
static UnicodeSet	DIGIT Character set that contains ASCII digits.
static UnicodeSet	EMPTY Empty character set.
static int	MAX_ELEMENT The maximum value of a unicode code point.
static int	MIN_ELEMENT The minimum value of a unicode code point.
static UnicodeSet	PRINT Character set that contains printable ASCII characters.
static UnicodeSet	SPACE Character set that contains ASCII whitespace characters.
static UnicodeSet	WHOLE Character set that contains all unicode characters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(int ch) Determines if this character set contains the specified character.
boolean	equals(Object obj) Determines if this character set equals to the specified one.
static String	escape(char ch) Adds escape (\) character to the specified one if needed.
static String	escape(String source) Adds escape (\) characters to the specified string.
static StringBuilder	escape(String source, StringBuilder buf) Adds escape (\) characters to the specified string and appends result to the specified buffer.
static UnicodeSet	fromElements(char... elements) Creates a new character set from the specified array of characters.
static UnicodeSet	fromElements(int[] elements) Creates a new character set from the specified array of characters.
static UnicodeSet	fromElements(String elements) Creates a new character set from the specified string of characters.
static UnicodeSet	fromIntervals(char... intervals) Creates a new character set from the specified array of intervals.
static UnicodeSet	fromIntervals(int[] intervals) Creates a new character set from the specified array of intervals.
int	getMax() Returns maximum bound for this character set.
int	getMin() Returns minimum bound for this character set.
int	hashCode() Returns a hash code value for this character set.
UnicodeSet	inverse() Returns inverse character set for this character set.
boolean	isElementSet() Determines if this character set represents a set of single characters.
int	size() Returns number of intervals for this character set.
int[]	toArray() Returns array that contains all intervals of this character set.
String	toString() Returns string representing this character set.
void	toString(StringBuilder buf) Appends string representation of this character set to the specified buffer.
static String	unescape(String source) Removes escape (\) characters from the specified string.
static StringBuilder	unescape(String source, StringBuilder buf) Removes escape (\) characters from the specified string and appends result to the specified buffer.
UnicodeSet	union(UnicodeSet uset) Merges this character set with the specified one and returns a new character set.
static UnicodeSet	unionAll(UnicodeSet... usets) Merges the specified character sets and returns a new character set.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MIN_ELEMENT

public static final int MIN_ELEMENT

The minimum value of a unicode code point.

See Also:

Constant Field Values

MAX_ELEMENT

public static final int MAX_ELEMENT

The maximum value of a unicode code point.

See Also:

Constant Field Values

EMPTY

public static final UnicodeSet EMPTY

Empty character set.

WHOLE

public static final UnicodeSet WHOLE

Character set that contains all unicode characters.

ASCII

public static final UnicodeSet ASCII

Character set that contains all ASCII characters.

DIGIT

public static final UnicodeSet DIGIT

Character set that contains ASCII digits.

ALPHA

public static final UnicodeSet ALPHA

Character set that contains ASCII letters.

ALNUM

public static final UnicodeSet ALNUM

Character set that contains alphanumeric characters.

SPACE

public static final UnicodeSet SPACE

Character set that contains ASCII whitespace characters.

PRINT

public static final UnicodeSet PRINT

Character set that contains printable ASCII characters.

Method Detail

size

public int size()

Returns number of intervals for this character set.

Returns:

Number of intervals for this character set.

getMin

public int getMin()

Returns minimum bound for this character set.

Returns:

Minimum bound for this character set.

getMax

public int getMax()

Returns maximum bound for this character set.

Returns:

Maximum bound for this character set.

isElementSet

public boolean isElementSet()

Determines if this character set represents a set of single characters.

Returns:

true if this character set represents a set of single characters; false otherwise.

contains

public boolean contains(int ch)

Determines if this character set contains the specified character.

Parameters:

ch - Character to be tested.

Returns:

true if this character set contains the specified character; false otherwise.

union

public UnicodeSet union(UnicodeSet uset)

Merges this character set with the specified one and returns a new character set.

Parameters:

uset - Character set to merge.

Returns:

Union of this character set and the specified one.

inverse

public UnicodeSet inverse()

Returns inverse character set for this character set. More formally, this method returns character set that contains all characters not contained in this set.

Returns:

Inverse character set for this character set.

hashCode

public int hashCode()

Returns a hash code value for this character set.

Overrides:

hashCode in class Object

Returns:

A hash code value for this character set.

equals

public boolean equals(Object obj)

Determines if this character set equals to the specified one.

Overrides:

equals in class Object

Parameters:

obj - Another character set.

Returns:

true if this character set equals to the specified one; false otherwise.

toArray

public int[] toArray()

Returns array that contains all intervals of this character set. All odd elements are minimum bounds, all even elements are maximum bounds.

Returns:

Array that contains all intervals of this character set.

toString

public String toString()

Returns string representing this character set.

Overrides:

toString in class Object

Returns:

String representing this character set.

toString

public void toString(StringBuilder buf)

Appends string representation of this character set to the specified buffer.

Parameters:

buf - Buffer to append.

unionAll

public static UnicodeSet unionAll(UnicodeSet... usets)

Merges the specified character sets and returns a new character set.

Parameters:

usets - Character sets to merge.

Returns:

Union of the specified character sets.

fromElements

public static UnicodeSet fromElements(char... elements)

Creates a new character set from the specified array of characters.

Parameters:

elements - Array of characters.

Returns:

A new character set from the specified array of characters.

fromElements

public static UnicodeSet fromElements(int[] elements)

Creates a new character set from the specified array of characters.

Parameters:

elements - Array of characters.

Returns:

A new character set from the specified array of characters.

fromElements

public static UnicodeSet fromElements(String elements)

Creates a new character set from the specified string of characters.

Parameters:

elements - String of characters.

Returns:

A new character set from the specified string of characters.

fromIntervals

public static UnicodeSet fromIntervals(char... intervals)

Creates a new character set from the specified array of intervals. All odd elements are minimum bounds, all even elements are maximum bounds.

Parameters:

intervals - Array of intervals.

Returns:

A new character set from the specified array of intervals.

Throws:

IllegalArgumentException - if length of the specified array of intervals is invalid.

fromIntervals

public static UnicodeSet fromIntervals(int[] intervals)

Creates a new character set from the specified array of intervals. All odd elements are minimum bounds, all even elements are maximum bounds.

Parameters:

intervals - Array of intervals.

Returns:

A new character set from the specified array of intervals.

Throws:

IllegalArgumentException - if length of the specified array of intervals is invalid.

escape

public static String escape(char ch)

Adds escape (\) character to the specified one if needed.

Parameters:

ch - Source character.

Returns:

Escaped character string.

escape

public static String escape(String source)

Adds escape (\) characters to the specified string.

Parameters:

source - Source string.

Returns:

String with added escape characters.

See Also:

escape(String, StringBuilder)

escape

public static StringBuilder escape(String source,
                   StringBuilder buf)

Adds escape (\) characters to the specified string and appends result to the specified buffer.

Parameters:

source - Source string.

buf - Buffer to append.

Returns:

The specified buffer.

See Also:

escape(char)

unescape

public static String unescape(String source)

Removes escape (\) characters from the specified string.

Parameters:

source - Source string.

Returns:

String with removed escape characters.

Throws:

IllegalArgumentException - if the specified string is malformed.

See Also:

unescape(String, StringBuilder)

unescape

public static StringBuilder unescape(String source,
                     StringBuilder buf)

Removes escape (\) characters from the specified string and appends result to the specified buffer.

Parameters:

source - Source string.

buf - Buffer to append.

Returns:

The specified buffer.

Throws:

IllegalArgumentException - if the specified string is malformed.