public class CharSet extends Object implements Serializable
A set of characters.
Instances are immutable, but instances of subclasses may not be.
#ThreadSafe#
Modifier and Type | Field and Description |
---|---|
static CharSet |
ASCII_ALPHA
A CharSet defining ASCII alphabetic characters "a-zA-Z".
|
static CharSet |
ASCII_ALPHA_LOWER
A CharSet defining ASCII alphabetic characters "a-z".
|
static CharSet |
ASCII_ALPHA_UPPER
A CharSet defining ASCII alphabetic characters "A-Z".
|
static CharSet |
ASCII_NUMERIC
A CharSet defining ASCII alphabetic characters "0-9".
|
protected static Map<String,CharSet> |
COMMON
A Map of the common cases used in the factory.
|
static CharSet |
EMPTY
A CharSet defining no characters.
|
Modifier | Constructor and Description |
---|---|
protected |
CharSet(String... set)
Constructs a new CharSet using the set syntax.
|
Modifier and Type | Method and Description |
---|---|
protected void |
add(String str)
Add a set definition string to the
CharSet . |
boolean |
contains(char ch)
Does the
CharSet contain the specified
character ch . |
boolean |
equals(Object obj)
Compares two
CharSet objects, returning true if they represent
exactly the same set of characters defined in the same way. |
static CharSet |
getInstance(String... setStrs)
Factory method to create a new CharSet using a special syntax.
|
int |
hashCode()
Gets a hash code compatible with the equals method.
|
String |
toString()
Gets a string representation of the set.
|
public static final CharSet ASCII_ALPHA
public static final CharSet ASCII_ALPHA_LOWER
public static final CharSet ASCII_ALPHA_UPPER
public static final CharSet ASCII_NUMERIC
protected CharSet(String... set)
Constructs a new CharSet using the set syntax. Each string is merged in with the set.
set
- Strings to merge into the initial setNullPointerException
- if set is null
public static CharSet getInstance(String... setStrs)
Factory method to create a new CharSet using a special syntax.
null
or empty string ("")
- set containing no charactersThe matching order is:
Matching works left to right. Once a match is found the search starts again from the next character.
If the same range is defined twice using the same syntax, only one range will be kept. Thus, "a-ca-c" creates only one range of "a-c".
If the start and end of a range are in the wrong order, they are reversed. Thus "a-e" is the same as "e-a". As a result, "a-ee-a" would create only one range, as the "a-e" and "e-a" are the same.
The set of characters represented is the union of the specified ranges.
All CharSet objects returned by this method will be immutable.
setStrs
- Strings to merge into the set, may be nullprotected void add(String str)
Add a set definition string to the CharSet
.
str
- set definition stringpublic boolean contains(char ch)
Does the CharSet
contain the specified
character ch
.
ch
- the character to check fortrue
if the set contains the characterspublic boolean equals(Object obj)
Compares two CharSet
objects, returning true if they represent
exactly the same set of characters defined in the same way.
The two sets abc
and a-c
are not
equal according to this method.
public int hashCode()
Gets a hash code compatible with the equals method.
Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.