com.ibm.icu.text
Class UnicodeSet

java.lang.Object
  com.ibm.icu.text.UnicodeFilter
      com.ibm.icu.text.UnicodeSet

All Implemented Interfaces:

UnicodeMatcher, Freezable<UnicodeSet>, Cloneable, Comparable<UnicodeSet>, Iterable<String>

public class UnicodeSet
extends UnicodeFilter
implements Iterable<String>, Comparable<UnicodeSet>, Freezable<UnicodeSet>

A mutable set of Unicode characters and multicharacter strings. Objects of this class represent character classes used in regular expressions. A character specifies a subset of Unicode code points. Legal code points are U+0000 to U+10FFFF, inclusive. Note: method freeze() will not only makes the set immutable, but also makes important methods much higher performance: contains(c), containsNone(...), span(...), spanBack(...) etc. After the object is frozen, any subsequent call that wants to change the object will throw UnsupportedOperationException.

The UnicodeSet class is not designed to be subclassed.

UnicodeSet supports two APIs. The first is the operand API that allows the caller to modify the value of a UnicodeSet object. It conforms to Java 2's java.util.Set interface, although UnicodeSet does not actually implement that interface. All methods of Set are supported, with the modification that they take a character range or single character instead of an Object, and they take a UnicodeSet instead of a Collection. The operand API may be thought of in terms of boolean logic: a boolean OR is implemented by add, a boolean AND is implemented by retain, a boolean XOR is implemented by complement taking an argument, and a boolean NOT is implemented by complement with no argument. In terms of traditional set theory function names, add is a union, retain is an intersection, remove is an asymmetric difference, and complement with no argument is a set complement with respect to the superset range MIN_VALUE-MAX_VALUE

The second API is the applyPattern()/toPattern() API from the java.text.Format-derived classes. Unlike the methods that add characters, add categories, and control the logic of the set, the method applyPattern() sets all attributes of a UnicodeSet at once, based on a string pattern.

Pattern syntax

Patterns are accepted by the constructors and the applyPattern() methods and returned by the toPattern() method. These patterns follow a syntax similar to that employed by version 8 regular expression character classes. Here are some simple examples:

[]	No characters
[a]	The character 'a'
[ae]	The characters 'a' and 'e'
[a-e]	The characters 'a' through 'e' inclusive, in Unicode code point order
[\\u4E01]	The character U+4E01
[a{ab}{ac}]	The character 'a' and the multicharacter strings "ab" and "ac"
[\p{Lu}]	All characters in the general category Uppercase Letter

Any character may be preceded by a backslash in order to remove any special meaning. White space characters, as defined by the Unicode Pattern_White_Space property, are ignored, unless they are escaped.

Property patterns specify a set of characters having a certain property as defined by the Unicode standard. Both the POSIX-like "[:Lu:]" and the Perl-like syntax "\p{Lu}" are recognized. For a complete list of supported property patterns, see the User's Guide for UnicodeSet at http://www.icu-project.org/userguide/unicodeSet.html. Actual determination of property data is defined by the underlying Unicode database as implemented by UCharacter.

Patterns specify individual characters, ranges of characters, and Unicode property sets. When elements are concatenated, they specify their union. To complement a set, place a '^' immediately after the opening '['. Property patterns are inverted by modifying their delimiters; "[:^foo]" and "\P{foo}". In any other location, '^' has no special meaning.

Ranges are indicated by placing two a '-' between two characters, as in "a-z". This specifies the range of all characters from the left to the right, in Unicode order. If the left character is greater than or equal to the right character it is a syntax error. If a '-' occurs as the first character after the opening '[' or '[^', or if it occurs as the last character before the closing ']', then it is taken as a literal. Thus "[a\\-b]", "[-ab]", and "[ab-]" all indicate the same set of three characters, 'a', 'b', and '-'.

Sets may be intersected using the '&' operator or the asymmetric set difference may be taken using the '-' operator, for example, "[[:L:]&[\\u0000-\\u0FFF]]" indicates the set of all Unicode letters with values less than 4096. Operators ('&' and '|') have equal precedence and bind left-to-right. Thus "[[:L:]-[a-z]-[\\u0100-\\u01FF]]" is equivalent to "[[[:L:]-[a-z]]-[\\u0100-\\u01FF]]". This only really matters for difference; intersection is commutative.

[a]	The set containing 'a'
[a-z]	The set containing 'a' through 'z' and all letters in between, in Unicode order
[^a-z]	The set containing all characters but 'a' through 'z', that is, U+0000 through 'a'-1 and 'z'+1 through U+10FFFF
[[pat1][pat2]]	The union of sets specified by pat1 and pat2
[[pat1]&[pat2]]	The intersection of sets specified by pat1 and pat2
[[pat1]-[pat2]]	The asymmetric difference of sets specified by pat1 and pat2
[:Lu:] or \p{Lu}	The set of characters having the specified Unicode property; in this case, Unicode uppercase letters
[:^Lu:] or \P{Lu}	The set of characters not having the given Unicode property

Warning: you cannot add an empty string ("") to a UnicodeSet.

Formal syntax

pattern :=	('[' '^'? item* ']') | property
item :=	char | (char '-' char) | pattern-expr
pattern-expr :=	pattern | pattern-expr pattern | pattern-expr op pattern
op :=	'&' | '-'
special :=	'[' | ']' | '-'
char :=	any character that is not special | ('\\' any character) | ('\u' hex hex hex hex)
hex :=	any character for which Character.digit(c, 16) returns a non-negative result
property :=	a Unicode property set pattern

Legend:

a := b		a may be replaced by b
a?		zero or one instance of a
a*		one or more instances of a
a | b		either a or b
'a'		the literal string between the quotes

To iterate over contents of UnicodeSet, use UnicodeSetIterator class.

Author:

Alan Liu

See Also:

UnicodeSetIterator

Status:

Stable ICU 2.0.

Nested Class Summary

static class	UnicodeSet.ComparisonStyle Comparison style enums used by compareTo(UnicodeSet, ComparisonStyle).
static class	UnicodeSet.SpanCondition Argument values for whether span() and similar functions continue while the current character is contained vs.
static class	UnicodeSet.XSymbolTable Internal class for customizing UnicodeSet parsing of properties.

Field Summary

static int	ADD_CASE_MAPPINGS Bitmask for constructor, applyPattern(), and closeOver() indicating letter case.
static UnicodeSet	ALL_CODE_POINTS Constant for the set of all code points.
static int	CASE Bitmask for constructor, applyPattern(), and closeOver() indicating letter case.
static int	CASE_INSENSITIVE Alias for UnicodeSet.CASE, for ease of porting from C++ where ICU4C also has both USET_CASE and USET_CASE_INSENSITIVE (see uset.h).
static UnicodeSet	EMPTY Constant for the empty set.
static int	IGNORE_SPACE Bitmask for constructor and applyPattern() indicating that white space should be ignored.
static int	MAX_VALUE Maximum value that can be stored in a UnicodeSet.
static int	MIN_VALUE Minimum value that can be stored in a UnicodeSet.

Fields inherited from interface com.ibm.icu.text.UnicodeMatcher

ETHER, U_MATCH, U_MISMATCH, U_PARTIAL_MATCH

Constructor Summary

UnicodeSet()
Constructs an empty set.

UnicodeSet(int... pairs)
Quickly constructs a set from a set of ranges .

UnicodeSet(int start, int end)
Constructs a set containing the given range.

UnicodeSet(String pattern)
Constructs a set from the given pattern.

UnicodeSet(String pattern, boolean ignoreWhitespace)
Constructs a set from the given pattern.

UnicodeSet(String pattern, int options)
Constructs a set from the given pattern.

UnicodeSet(String pattern, ParsePosition pos, SymbolTable symbols)
Constructs a set from the given pattern.

UnicodeSet(String pattern, ParsePosition pos, SymbolTable symbols, int options)
Constructs a set from the given pattern.

UnicodeSet(UnicodeSet other)
Constructs a copy of an existing set.

Method Summary

StringBuffer	_generatePattern(StringBuffer result, boolean escapeUnprintable) Generate and append a string representation of this set to result.
StringBuffer	_generatePattern(StringBuffer result, boolean escapeUnprintable, boolean includeStrings) Generate and append a string representation of this set to result.
UnicodeSet	add(CharSequence s) Adds the specified multicharacter to this set if it is not already present.
UnicodeSet	add(Collection<?> source) Add the contents of the collection (as strings) into this UnicodeSet.
UnicodeSet	add(int c) Adds the specified character to this set if it is not already present.
UnicodeSet	add(int start, int end) Adds the specified range to this set if it is not already present.
UnicodeSet	addAll(CharSequence s) Adds each of the characters in this string to the set.
UnicodeSet	addAll(Collection<?> source) Add the contents of the UnicodeSet (as strings) into a collection.
UnicodeSet	addAll(int start, int end) Adds all characters in range (uses preferred naming convention).
UnicodeSet	addAll(String... collection)
UnicodeSet	addAll(UnicodeSet c) Adds all of the elements in the specified set to this set if they're not already present.
static <T> T[]	addAllTo(Iterable<T> source, T[] target) Utility for adding the contents of an iterable to a collection.
static <T,U extends Collection<T>> U	addAllTo(Iterable<T> source, U target) Utility for adding the contents of an iterable to a collection.
String[]	addAllTo(String[] target) Add the contents of the UnicodeSet (as strings) into a collection.
<T extends Collection<String>> T	addAllTo(T target) Add the contents of the UnicodeSet (as strings) into a collection.
UnicodeSet	addBridges(UnicodeSet dontCare) Deprecated. This API is ICU internal only.
void	addMatchSetTo(UnicodeSet toUnionTo) Implementation of UnicodeMatcher API.
UnicodeSet	applyIntPropertyValue(int prop, int value) Modifies this set to contain those code points which have the given value for the given binary or enumerated property, as returned by UCharacter.getIntPropertyValue.
UnicodeSet	applyPattern(String pattern) Modifies this set to represent the set specified by the given pattern.
UnicodeSet	applyPattern(String pattern, boolean ignoreWhitespace) Modifies this set to represent the set specified by the given pattern, optionally ignoring whitespace.
UnicodeSet	applyPattern(String pattern, int options) Modifies this set to represent the set specified by the given pattern, optionally ignoring whitespace.
UnicodeSet	applyPattern(String pattern, ParsePosition pos, SymbolTable symbols, int options) Deprecated. This API is ICU internal only.
UnicodeSet	applyPropertyAlias(String propertyAlias, String valueAlias) Modifies this set to contain those code points which have the given value for the given property.
UnicodeSet	applyPropertyAlias(String propertyAlias, String valueAlias, SymbolTable symbols) Modifies this set to contain those code points which have the given value for the given property.
int	charAt(int index) Returns the character at the given index within this set, where the set is ordered by ascending code point.
UnicodeSet	clear() Removes all of the elements from this set.
Object	clone() Return a new set that is equivalent to this one.
UnicodeSet	cloneAsThawed() Clone a thawed version of this class, according to the Freezable interface.
UnicodeSet	closeOver(int attribute) Close this set over the given attribute.
UnicodeSet	compact() Reallocate this objects internal structures to take up the least possible space, without changing this object's value.
static <T extends Comparable<T>> int	compare(Collection<T> collection1, Collection<T> collection2, UnicodeSet.ComparisonStyle style) Utility to compare two collections, optionally by size, and then lexicographically.
static int	compare(int codePoint, String string) Utility to compare a string to a code point.
static <T extends Comparable<T>> int	compare(Iterable<T> collection1, Iterable<T> collection2) Utility to compare two iterables.
static <T extends Comparable<T>> int	compare(Iterator<T> first, Iterator<T> other) Deprecated. This API is ICU internal only.
static int	compare(String string, int codePoint) Utility to compare a string to a code point.
int	compareTo(Iterable<String> other)
int	compareTo(UnicodeSet o) Compares UnicodeSets, where shorter come first, and otherwise lexigraphically (according to the comparison of the first characters that differ).
int	compareTo(UnicodeSet o, UnicodeSet.ComparisonStyle style) Compares UnicodeSets, in three different ways.
UnicodeSet	complement() This is equivalent to complement(MIN_VALUE, MAX_VALUE).
UnicodeSet	complement(int c) Complements the specified character in this set.
UnicodeSet	complement(int start, int end) Complements the specified range in this set.
UnicodeSet	complement(String s) Complement the specified string in this set.
UnicodeSet	complementAll(String s) Complement EACH of the characters in this string.
UnicodeSet	complementAll(UnicodeSet c) Complements in this set all elements contained in the specified set.
boolean	contains(int c) Returns true if this set contains the given character.
boolean	contains(int start, int end) Returns true if this set contains every character of the given range.
boolean	contains(String s) Returns true if this set contains the given multicharacter string.
boolean	containsAll(Collection<String> collection)
boolean	containsAll(String s) Returns true if there is a partition of the string such that this set contains each of the partitioned strings.
boolean	containsAll(UnicodeSet b) Returns true if this set contains all the characters and strings of the given set.
boolean	containsNone(Collection<String> collection)
boolean	containsNone(int start, int end) Returns true if this set contains none of the characters of the given range.
boolean	containsNone(String s) Returns true if this set contains none of the characters of the given string.
boolean	containsNone(UnicodeSet b) Returns true if none of the characters or strings in this UnicodeSet appears in the string.
boolean	containsSome(Collection<String> collection)
boolean	containsSome(int start, int end) Returns true if this set contains one or more of the characters in the given range.
boolean	containsSome(String s) Returns true if this set contains one or more of the characters of the given string.
boolean	containsSome(UnicodeSet s) Returns true if this set contains one or more of the characters and strings of the given set.
boolean	equals(Object o) Compares the specified object with this set for equality.
int	findIn(CharSequence value, int fromIndex, boolean findNot) Deprecated. This API is ICU internal only.
int	findLastIn(CharSequence value, int fromIndex, boolean findNot) Deprecated. This API is ICU internal only.
UnicodeSet	freeze() Freeze this class, according to the Freezable interface.
static UnicodeSet	from(String s) Makes a set from a multicharacter string.
static UnicodeSet	fromAll(String s) Makes a set from each of the characters in the string.
static UnicodeSet.XSymbolTable	getDefaultXSymbolTable() Get the default symbol table.
int	getRangeCount() Iteration method that returns the number of ranges contained in this set.
int	getRangeEnd(int index) Iteration method that returns the last character in the specified range of this set.
int	getRangeStart(int index) Iteration method that returns the first character in the specified range of this set.
String	getRegexEquivalent() Deprecated. This API is ICU internal only.
static int	getSingleCodePoint(CharSequence s) Deprecated. This API is ICU internal only.
int	hashCode() Returns the hash code value for this set.
int	indexOf(int c) Returns the index of the given character within this set, where the set is ordered by ascending code point.
boolean	isEmpty() Returns true if this set contains no elements.
boolean	isFrozen() Is this frozen, according to the Freezable interface?
Iterator<String>	iterator() Returns a string iterator.
int	matches(Replaceable text, int[] offset, int limit, boolean incremental) Implementation of UnicodeMatcher.matches().
int	matchesAt(CharSequence text, int offset) Deprecated. This API is ICU internal only.
boolean	matchesIndexValue(int v) Implementation of UnicodeMatcher API.
UnicodeSet	remove(int c) Removes the specified character from this set if it is present.
UnicodeSet	remove(int start, int end) Removes the specified range from this set if it is present.
UnicodeSet	remove(String s) Removes the specified string from this set if it is present.
UnicodeSet	removeAll(Collection<String> collection)
UnicodeSet	removeAll(String s) Remove EACH of the characters in this string.
UnicodeSet	removeAll(UnicodeSet c) Removes from this set all of its elements that are contained in the specified set.
UnicodeSet	removeAllStrings() Remove all strings from this UnicodeSet
static boolean	resemblesPattern(String pattern, int pos) Return true if the given position, in the given pattern, appears to be the start of a UnicodeSet pattern.
UnicodeSet	retain(int c) Retain the specified character from this set if it is present.
UnicodeSet	retain(int start, int end) Retain only the elements in this set that are contained in the specified range.
UnicodeSet	retain(String s) Retain the specified string in this set if it is present.
UnicodeSet	retainAll(Collection<String> collection)
UnicodeSet	retainAll(String s) Retains EACH of the characters in this string.
UnicodeSet	retainAll(UnicodeSet c) Retains only the elements in this set that are contained in the specified set.
UnicodeSet	set(int start, int end) Make this object represent the range start - end.
UnicodeSet	set(UnicodeSet other) Make this object represent the same set as other.
static void	setDefaultXSymbolTable(UnicodeSet.XSymbolTable xSymbolTable) Set the default symbol table.
int	size() Returns the number of elements in this set (its cardinality) Note than the elements of a set may include both individual codepoints and strings.
int	span(CharSequence s, int start, UnicodeSet.SpanCondition spanCondition) Span a string using this UnicodeSet.
int	span(CharSequence s, UnicodeSet.SpanCondition spanCondition) Span a string using this UnicodeSet.
int	spanBack(CharSequence s, int fromIndex, UnicodeSet.SpanCondition spanCondition) Span a string backwards (from the fromIndex) using this UnicodeSet.
int	spanBack(CharSequence s, UnicodeSet.SpanCondition spanCondition) Span a string backwards (from the end) using this UnicodeSet.
Iterable<String>	strings() For iterating through the strings in the set.
String	stripFrom(CharSequence source, boolean matches) Deprecated. This API is ICU internal only.
static String[]	toArray(UnicodeSet set) Add the contents of the UnicodeSet (as strings) into an array.
String	toPattern(boolean escapeUnprintable) Returns a string representation of this set.
String	toString() Return a programmer-readable string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final UnicodeSet EMPTY

Constant for the empty set.

Status:

Stable ICU 4.8.

ALL_CODE_POINTS

public static final UnicodeSet ALL_CODE_POINTS

Constant for the set of all code points. (Since UnicodeSets can include strings, does not include everything that a UnicodeSet can.)

Status:

Stable ICU 4.8.

MIN_VALUE

public static final int MIN_VALUE

Minimum value that can be stored in a UnicodeSet.

See Also:

Constant Field Values

Status:

Stable ICU 2.0.

MAX_VALUE

public static final int MAX_VALUE

Maximum value that can be stored in a UnicodeSet.

See Also:

Constant Field Values

Status:

Stable ICU 2.0.

IGNORE_SPACE

public static final int IGNORE_SPACE

Bitmask for constructor and applyPattern() indicating that white space should be ignored. If set, ignore Unicode Pattern_White_Space characters, unless they are quoted or escaped. This may be ORed together with other selectors.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

CASE

public static final int CASE

Bitmask for constructor, applyPattern(), and closeOver() indicating letter case. This may be ORed together with other selectors. Enable case insensitive matching. E.g., "[ab]" with this flag will match 'a', 'A', 'b', and 'B'. "[^ab]" with this flag will match all except 'a', 'A', 'b', and 'B'. This performs a full closure over case mappings, e.g. U+017F for s. The resulting set is a superset of the input for the code points but not for the strings. It performs a case mapping closure of the code points and adds full case folding strings for the code points, and reduces strings of the original set to their full case folding equivalents. This is designed for case-insensitive matches, for example in regular expressions. The full code point case closure allows checking of an input character directly against the closure set. Strings are matched by comparing the case-folded form from the closure set with an incremental case folding of the string in question. The closure set will also contain single code points if the original set contained case-equivalent strings (like U+00DF for "ss" or "Ss" etc.). This is not necessary (that is, redundant) for the above matching method but results in the same closure sets regardless of whether the original set contained the code point or a string.

See Also:

Constant Field Values

Status:

Stable ICU 3.8.

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE

Alias for UnicodeSet.CASE, for ease of porting from C++ where ICU4C also has both USET_CASE and USET_CASE_INSENSITIVE (see uset.h).

See Also:

CASE, Constant Field Values

Status:

Stable ICU 3.4.

ADD_CASE_MAPPINGS

public static final int ADD_CASE_MAPPINGS

Bitmask for constructor, applyPattern(), and closeOver() indicating letter case. This may be ORed together with other selectors. Enable case insensitive matching. E.g., "[ab]" with this flag will match 'a', 'A', 'b', and 'B'. "[^ab]" with this flag will match all except 'a', 'A', 'b', and 'B'. This adds the lower-, title-, and uppercase mappings as well as the case folding of each existing element in the set.

See Also:

Constant Field Values

Status:

Stable ICU 3.4.

Constructor Detail

UnicodeSet

public UnicodeSet()

Constructs an empty set.

Status:

Stable ICU 2.0.

UnicodeSet

public UnicodeSet(UnicodeSet other)

Constructs a copy of an existing set.

Status:

Stable ICU 2.0.

UnicodeSet

public UnicodeSet(int start,
                  int end)

Constructs a set containing the given range. If end > start then an empty set is created.

Parameters:

start - first character, inclusive, of range

end - last character, inclusive, of range

Status:

Stable ICU 2.0.

UnicodeSet

public UnicodeSet(int... pairs)

Quickly constructs a set from a set of ranges . There must be an even number of integers, and they must be all greater than zero, all less than or equal to Character.MAX_CODE_POINT. In each pair (..., si, ei, ...) it must be true that si <= ei Between adjacent pairs (...ei, sj...), it must be true that ei+1 < sj

Parameters:

pairs - pairs of character representing ranges

Status:

Stable ICU 4.4.

UnicodeSet

public UnicodeSet(String pattern)

Constructs a set from the given pattern. See the class description for the syntax of the pattern language. Whitespace is ignored.

Parameters:

pattern - a string specifying what characters are in the set

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 2.0.

UnicodeSet

public UnicodeSet(String pattern,
                  boolean ignoreWhitespace)

Constructs a set from the given pattern. See the class description for the syntax of the pattern language.

Parameters:

pattern - a string specifying what characters are in the set

ignoreWhitespace - if true, ignore Unicode Pattern_White_Space characters

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 2.0.

UnicodeSet

public UnicodeSet(String pattern,
                  int options)

Constructs a set from the given pattern. See the class description for the syntax of the pattern language.

Parameters:

pattern - a string specifying what characters are in the set

options - a bitmask indicating which options to apply. Valid options are IGNORE_SPACE and CASE.

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 3.8.

UnicodeSet

public UnicodeSet(String pattern,
                  ParsePosition pos,
                  SymbolTable symbols)

Constructs a set from the given pattern. See the class description for the syntax of the pattern language.

Parameters:

pattern - a string specifying what characters are in the set

pos - on input, the position in pattern at which to start parsing. On output, the position after the last character parsed.

symbols - a symbol table mapping variables to char[] arrays and chars to UnicodeSets

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 2.0.

UnicodeSet

public UnicodeSet(String pattern,
                  ParsePosition pos,
                  SymbolTable symbols,
                  int options)

Constructs a set from the given pattern. See the class description for the syntax of the pattern language.

Parameters:

pattern - a string specifying what characters are in the set

pos - on input, the position in pattern at which to start parsing. On output, the position after the last character parsed.

symbols - a symbol table mapping variables to char[] arrays and chars to UnicodeSets

options - a bitmask indicating which options to apply. Valid options are IGNORE_SPACE and CASE.

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 3.2.

Method Detail

clone

public Object clone()

Return a new set that is equivalent to this one.

Overrides:

clone in class Object

Status:

Stable ICU 2.0.

set

public UnicodeSet set(int start,
                      int end)

Make this object represent the range start - end. If end > start then this object is set to an an empty range.

Parameters:

start - first character in the set, inclusive

end - last character in the set, inclusive

Status:

Stable ICU 2.0.

set

public UnicodeSet set(UnicodeSet other)

Make this object represent the same set as other.

Parameters:

other - a UnicodeSet whose value will be copied to this object

Status:

Stable ICU 2.0.

applyPattern

public final UnicodeSet applyPattern(String pattern)

Modifies this set to represent the set specified by the given pattern. See the class description for the syntax of the pattern language. Whitespace is ignored.

Parameters:

pattern - a string specifying what characters are in the set

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 2.0.

applyPattern

public UnicodeSet applyPattern(String pattern,
                               boolean ignoreWhitespace)

Modifies this set to represent the set specified by the given pattern, optionally ignoring whitespace. See the class description for the syntax of the pattern language.

Parameters:

pattern - a string specifying what characters are in the set

ignoreWhitespace - if true then Unicode Pattern_White_Space characters are ignored

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 2.0.

applyPattern

public UnicodeSet applyPattern(String pattern,
                               int options)

Modifies this set to represent the set specified by the given pattern, optionally ignoring whitespace. See the class description for the syntax of the pattern language.

Parameters:

pattern - a string specifying what characters are in the set

options - a bitmask indicating which options to apply. Valid options are IGNORE_SPACE and CASE.

Throws:

IllegalArgumentException - if the pattern contains a syntax error.

Status:

Stable ICU 3.8.

resemblesPattern

public static boolean resemblesPattern(String pattern,
                                       int pos)

Return true if the given position, in the given pattern, appears to be the start of a UnicodeSet pattern.

Status:

Stable ICU 2.0.

toPattern

public String toPattern(boolean escapeUnprintable)

Returns a string representation of this set. If the result of calling this function is passed to a UnicodeSet constructor, it will produce another set that is equal to this one.

Specified by:

toPattern in interface UnicodeMatcher

Parameters:

escapeUnprintable - if TRUE then convert unprintable character to their hex escape representations, \\uxxxx or \\Uxxxxxxxx. Unprintable characters are those other than U+000A, U+0020..U+007E.

Status:

Stable ICU 2.0.

_generatePattern

public StringBuffer _generatePattern(StringBuffer result,
                                     boolean escapeUnprintable)

Generate and append a string representation of this set to result. This does not use this.pat, the cleaned up copy of the string passed to applyPattern().

Parameters:

result - the buffer into which to generate the pattern

escapeUnprintable - escape unprintable characters if true

Status:

Stable ICU 2.0.

_generatePattern

public StringBuffer _generatePattern(StringBuffer result,
                                     boolean escapeUnprintable,
                                     boolean includeStrings)

Generate and append a string representation of this set to result. This does not use this.pat, the cleaned up copy of the string passed to applyPattern().

Parameters:

includeStrings - if false, doesn't include the strings.

Status:

Stable ICU 3.8.

size

public int size()

Returns the number of elements in this set (its cardinality) Note than the elements of a set may include both individual codepoints and strings.

Returns:

the number of elements in this set (its cardinality).

Status:

Stable ICU 2.0.

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Returns:

true if this set contains no elements.

Status:

Stable ICU 2.0.

matchesIndexValue

public boolean matchesIndexValue(int v)

Implementation of UnicodeMatcher API. Returns true if this set contains any character whose low byte is the given value. This is used by RuleBasedTransliterator for indexing.

Specified by:

matchesIndexValue in interface UnicodeMatcher

Status:

Stable ICU 2.0.

matches

public int matches(Replaceable text,
                   int[] offset,
                   int limit,
                   boolean incremental)

Implementation of UnicodeMatcher.matches(). Always matches the longest possible multichar string.

Specified by:

matches in interface UnicodeMatcher

Overrides:

matches in class UnicodeFilter

Parameters:

text - the text to be matched

offset - on input, the index into text at which to begin matching. On output, the limit of the matched text. The number of matched characters is the output value of offset minus the input value. Offset should always point to the HIGH SURROGATE (leading code unit) of a pair of surrogates, both on entry and upon return.

limit - the limit index of text to be matched. Greater than offset for a forward direction match, less than offset for a backward direction match. The last character to be considered for matching will be text.charAt(limit-1) in the forward direction or text.charAt(limit+1) in the backward direction.

incremental - if TRUE, then assume further characters may be inserted at limit and check for partial matching. Otherwise assume the text as given is complete.

Returns:

a match degree value indicating a full match, a partial match, or a mismatch. If incremental is FALSE then U_PARTIAL_MATCH should never be returned.

Status:

Stable ICU 2.0.

matchesAt

public int matchesAt(CharSequence text,
                     int offset)

Deprecated. This API is ICU internal only.

Tests whether the text matches at the offset. If so, returns the end of the longest substring that it matches. If not, returns -1.

Status:

Internal. This API is ICU internal only.

addMatchSetTo

public void addMatchSetTo(UnicodeSet toUnionTo)

Implementation of UnicodeMatcher API. Union the set of all characters that may be matched by this object into the given set.

Specified by:

addMatchSetTo in interface UnicodeMatcher

Parameters:

toUnionTo - the set into which to union the source characters

Status:

Stable ICU 2.2.

indexOf

public int indexOf(int c)

Returns the index of the given character within this set, where the set is ordered by ascending code point. If the character is not in this set, return -1. The inverse of this method is charAt().

Returns:

an index from 0..size()-1, or -1

Status:

Stable ICU 2.0.

charAt

public int charAt(int index)

Returns the character at the given index within this set, where the set is ordered by ascending code point. If the index is out of range, return -1. The inverse of this method is indexOf().

Parameters:

index - an index from 0..size()-1

Returns:

the character at the given index, or -1.

Status:

Stable ICU 2.0.

add

public UnicodeSet add(int start,
                      int end)

Adds the specified range to this set if it is not already present. If this set already contains the specified range, the call leaves this set unchanged. If end > start then an empty range is added, leaving the set unchanged.

Parameters:

start - first character, inclusive, of range to be added to this set.

end - last character, inclusive, of range to be added to this set.

Status:

Stable ICU 2.0.

addAll

public UnicodeSet addAll(int start,
                         int end)

Adds all characters in range (uses preferred naming convention).

Parameters:

start - The index of where to start on adding all characters.

end - The index of where to end on adding all characters.

Returns:

a reference to this object

Status:

Stable ICU 4.4.

add

public final UnicodeSet add(int c)

Adds the specified character to this set if it is not already present. If this set already contains the specified character, the call leaves this set unchanged.

Status:

Stable ICU 2.0.

add

public final UnicodeSet add(CharSequence s)

Adds the specified multicharacter to this set if it is not already present. If this set already contains the multicharacter, the call leaves this set unchanged. Thus "ch" => {"ch"}
Warning: you cannot add an empty string ("") to a UnicodeSet.

Parameters:

s - the source string

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

addAll

public final UnicodeSet addAll(CharSequence s)

Adds each of the characters in this string to the set. Thus "ch" => {"c", "h"} If this set already any particular character, it has no effect on that character.

Parameters:

s - the source string

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

retainAll

public final UnicodeSet retainAll(String s)

Retains EACH of the characters in this string. Note: "ch" == {"c", "h"} If this set already any particular character, it has no effect on that character.

Parameters:

s - the source string

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

complementAll

public final UnicodeSet complementAll(String s)

Complement EACH of the characters in this string. Note: "ch" == {"c", "h"} If this set already any particular character, it has no effect on that character.

Parameters:

s - the source string

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

removeAll

public final UnicodeSet removeAll(String s)

Remove EACH of the characters in this string. Note: "ch" == {"c", "h"} If this set already any particular character, it has no effect on that character.

Parameters:

s - the source string

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

removeAllStrings

public final UnicodeSet removeAllStrings()

Remove all strings from this UnicodeSet

Returns:

this object, for chaining

Status:

Stable ICU 4.2.

from

public static UnicodeSet from(String s)

Makes a set from a multicharacter string. Thus "ch" => {"ch"}
Warning: you cannot add an empty string ("") to a UnicodeSet.

Parameters:

s - the source string

Returns:

a newly created set containing the given string

Status:

Stable ICU 2.0.

fromAll

public static UnicodeSet fromAll(String s)

Makes a set from each of the characters in the string. Thus "ch" => {"c", "h"}

Parameters:

s - the source string

Returns:

a newly created set containing the given characters

Status:

Stable ICU 2.0.

retain

public UnicodeSet retain(int start,
                         int end)

Retain only the elements in this set that are contained in the specified range. If end > start then an empty range is retained, leaving the set empty.

Parameters:

start - first character, inclusive, of range to be retained to this set.

end - last character, inclusive, of range to be retained to this set.

Status:

Stable ICU 2.0.

retain

public final UnicodeSet retain(int c)

Retain the specified character from this set if it is present. Upon return this set will be empty if it did not contain c, or will only contain c if it did contain c.

Parameters:

c - the character to be retained

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

retain

public final UnicodeSet retain(String s)

Retain the specified string in this set if it is present. Upon return this set will be empty if it did not contain s, or will only contain s if it did contain s.

Parameters:

s - the string to be retained

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

remove

public UnicodeSet remove(int start,
                         int end)

Removes the specified range from this set if it is present. The set will not contain the specified range once the call returns. If end > start then an empty range is removed, leaving the set unchanged.

Parameters:

start - first character, inclusive, of range to be removed from this set.

end - last character, inclusive, of range to be removed from this set.

Status:

Stable ICU 2.0.

remove

public final UnicodeSet remove(int c)

Removes the specified character from this set if it is present. The set will not contain the specified character once the call returns.

Parameters:

c - the character to be removed

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

remove

public final UnicodeSet remove(String s)

Removes the specified string from this set if it is present. The set will not contain the specified string once the call returns.

Parameters:

s - the string to be removed

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

complement

public UnicodeSet complement(int start,
                             int end)

Complements the specified range in this set. Any character in the range will be removed if it is in this set, or will be added if it is not in this set. If end > start then an empty range is complemented, leaving the set unchanged.

Parameters:

start - first character, inclusive, of range to be removed from this set.

end - last character, inclusive, of range to be removed from this set.

Status:

Stable ICU 2.0.

complement

public final UnicodeSet complement(int c)

Complements the specified character in this set. The character will be removed if it is in this set, or will be added if it is not in this set.

Status:

Stable ICU 2.0.

complement

public UnicodeSet complement()

This is equivalent to complement(MIN_VALUE, MAX_VALUE).

Status:

Stable ICU 2.0.

complement

public final UnicodeSet complement(String s)

Complement the specified string in this set. The set will not contain the specified string once the call returns.
Warning: you cannot add an empty string ("") to a UnicodeSet.

Parameters:

s - the string to complement

Returns:

this object, for chaining

Status:

Stable ICU 2.0.

contains

public boolean contains(int c)

Returns true if this set contains the given character.

Specified by:

contains in class UnicodeFilter

Parameters:

c - character to be checked for containment

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

contains

public boolean contains(int start,
                        int end)

Returns true if this set contains every character of the given range.

Parameters:

start - first character, inclusive, of the range

end - last character, inclusive, of the range

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

contains

public final boolean contains(String s)

Returns true if this set contains the given multicharacter string.

Parameters:

s - string to be checked for containment

Returns:

true if this set contains the specified string

Status:

Stable ICU 2.0.

containsAll

public boolean containsAll(UnicodeSet b)

Returns true if this set contains all the characters and strings of the given set.

Parameters:

b - set to be checked for containment

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

containsAll

public boolean containsAll(String s)

Returns true if there is a partition of the string such that this set contains each of the partitioned strings. For example, for the Unicode set [a{bc}{cd}]
containsAll is true for each of: "a", "bc", ""cdbca"
containsAll is false for each of: "acb", "bcda", "bcx"

Parameters:

s - string containing characters to be checked for containment

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

getRegexEquivalent

public String getRegexEquivalent()

Deprecated. This API is ICU internal only.

Get the Regex equivalent for this UnicodeSet

Returns:

regex pattern equivalent to this UnicodeSet

Status:

Internal. This API is ICU internal only.

containsNone

public boolean containsNone(int start,
                            int end)

Returns true if this set contains none of the characters of the given range.

Parameters:

start - first character, inclusive, of the range

end - last character, inclusive, of the range

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

containsNone

public boolean containsNone(UnicodeSet b)

Returns true if none of the characters or strings in this UnicodeSet appears in the string. For example, for the Unicode set [a{bc}{cd}]
containsNone is true for: "xy", "cb"
containsNone is false for: "a", "bc", "bcd"

Parameters:

b - set to be checked for containment

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

containsNone

public boolean containsNone(String s)

Returns true if this set contains none of the characters of the given string.

Parameters:

s - string containing characters to be checked for containment

Returns:

true if the test condition is met

Status:

Stable ICU 2.0.

containsSome

public final boolean containsSome(int start,
                                  int end)

Returns true if this set contains one or more of the characters in the given range.

Parameters:

start - first character, inclusive, of the range

end - last character, inclusive, of the range

Returns:

true if the condition is met

Status:

Stable ICU 2.0.

containsSome

public final boolean containsSome(UnicodeSet s)

Returns true if this set contains one or more of the characters and strings of the given set.

Parameters:

s - set to be checked for containment

Returns:

true if the condition is met

Status:

Stable ICU 2.0.

containsSome

public final boolean containsSome(String s)

Returns true if this set contains one or more of the characters of the given string.

Parameters:

s - string containing characters to be checked for containment

Returns:

true if the condition is met

Status:

Stable ICU 2.0.

addAll

public UnicodeSet addAll(UnicodeSet c)

Adds all of the elements in the specified set to this set if they're not already present. This operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress.

Parameters:

c - set whose elements are to be added to this set.

Status:

Stable ICU 2.0.

retainAll

public UnicodeSet retainAll(UnicodeSet c)

Retains only the elements in this set that are contained in the specified set. In other words, removes from this set all of its elements that are not contained in the specified set. This operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters:

c - set that defines which elements this set will retain.

Status:

Stable ICU 2.0.

removeAll

public UnicodeSet removeAll(UnicodeSet c)

Removes from this set all of its elements that are contained in the specified set. This operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters:

c - set that defines which elements will be removed from this set.

Status:

Stable ICU 2.0.

complementAll

public UnicodeSet complementAll(UnicodeSet c)

Complements in this set all elements contained in the specified set. Any character in the other set will be removed if it is in this set, or will be added if it is not in this set.

Parameters:

c - set that defines which elements will be complemented from this set.

Status:

Stable ICU 2.0.

clear

public UnicodeSet clear()

Removes all of the elements from this set. This set will be empty after this call returns.

Status:

Stable ICU 2.0.

getRangeCount

public int getRangeCount()

Iteration method that returns the number of ranges contained in this set.

See Also:

getRangeStart(int), getRangeEnd(int)

Status:

Stable ICU 2.0.

getRangeStart

public int getRangeStart(int index)

Iteration method that returns the first character in the specified range of this set.

Throws:

ArrayIndexOutOfBoundsException - if index is outside the range 0..getRangeCount()-1

See Also:

getRangeCount(), getRangeEnd(int)

Status:

Stable ICU 2.0.

getRangeEnd

public int getRangeEnd(int index)

Iteration method that returns the last character in the specified range of this set.

Throws:

ArrayIndexOutOfBoundsException - if index is outside the range 0..getRangeCount()-1

See Also:

getRangeStart(int), getRangeEnd(int)

Status:

Stable ICU 2.0.

compact

public UnicodeSet compact()

Reallocate this objects internal structures to take up the least possible space, without changing this object's value.

Status:

Stable ICU 2.0.

equals

public boolean equals(Object o)

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set).

Overrides:

equals in class Object

Parameters:

o - Object to be compared for equality with this set.

Returns:

true if the specified Object is equal to this set.

Status:

Stable ICU 2.0.

hashCode

public int hashCode()

Returns the hash code value for this set.

Overrides:

hashCode in class Object

Returns:

the hash code value for this set.

See Also:

Object.hashCode()

Status:

Stable ICU 2.0.

toString

public String toString()

Return a programmer-readable string representation of this object.

Overrides:

toString in class Object

Status:

Stable ICU 2.0.

applyPattern

public UnicodeSet applyPattern(String pattern,
                               ParsePosition pos,
                               SymbolTable symbols,
                               int options)

Deprecated. This API is ICU internal only.

Parses the given pattern, starting at the given position. The character at pattern.charAt(pos.getIndex()) must be '[', or the parse fails. Parsing continues until the corresponding closing ']'. If a syntax error is encountered between the opening and closing brace, the parse fails. Upon return from a successful parse, the ParsePosition is updated to point to the character following the closing ']', and an inversion list for the parsed pattern is returned. This method calls itself recursively to parse embedded subpatterns.

Parameters:

pattern - the string containing the pattern to be parsed. The portion of the string from pos.getIndex(), which must be a '[', to the corresponding closing ']', is parsed.

pos - upon entry, the position at which to being parsing. The character at pattern.charAt(pos.getIndex()) must be a '['. Upon return from a successful parse, pos.getIndex() is either the character after the closing ']' of the parsed pattern, or pattern.length() if the closing ']' is the last character of the pattern string.

Returns:

an inversion list for the parsed substring of pattern

Throws:

IllegalArgumentException - if the parse fails.

Status:

Internal. This API is ICU internal only.

addAllTo

public <T extends Collection<String>> T addAllTo(T target)

Add the contents of the UnicodeSet (as strings) into a collection.

Parameters:

target - collection to add into

Status:

Stable ICU 4.4.

addAllTo

public String[] addAllTo(String[] target)

Add the contents of the UnicodeSet (as strings) into a collection.

Parameters:

target - collection to add into

Status:

Stable ICU 4.4.

toArray

public static String[] toArray(UnicodeSet set)

Add the contents of the UnicodeSet (as strings) into an array.

Status:

Stable ICU 4.4.

add

public UnicodeSet add(Collection<?> source)

Add the contents of the collection (as strings) into this UnicodeSet.

Parameters:

source - the collection to add

Returns:

a reference to this object

Status:

Stable ICU 4.4.

addAll

public UnicodeSet addAll(Collection<?> source)

Add the contents of the UnicodeSet (as strings) into a collection. Uses standard naming convention.

Parameters:

source - collection to add into

Returns:

a reference to this object

Status:

Stable ICU 4.4.

applyIntPropertyValue

public UnicodeSet applyIntPropertyValue(int prop,
                                        int value)

Modifies this set to contain those code points which have the given value for the given binary or enumerated property, as returned by UCharacter.getIntPropertyValue. Prior contents of this set are lost.

Parameters:

prop - a property in the range UProperty.BIN_START..UProperty.BIN_LIMIT-1 or UProperty.INT_START..UProperty.INT_LIMIT-1 or. UProperty.MASK_START..UProperty.MASK_LIMIT-1.

value - a value in the range UCharacter.getIntPropertyMinValue(prop).. UCharacter.getIntPropertyMaxValue(prop), with one exception. If prop is UProperty.GENERAL_CATEGORY_MASK, then value should not be a UCharacter.getType() result, but rather a mask value produced by logically ORing (1 << UCharacter.getType()) values together. This allows grouped categories such as [:L:] to be represented.

Returns:

a reference to this set

Status:

Stable ICU 2.4.

applyPropertyAlias

public UnicodeSet applyPropertyAlias(String propertyAlias,
                                     String valueAlias)

Modifies this set to contain those code points which have the given value for the given property. Prior contents of this set are lost.

Parameters:

propertyAlias - a property alias, either short or long. The name is matched loosely. See PropertyAliases.txt for names and a description of loose matching. If the value string is empty, then this string is interpreted as either a General_Category value alias, a Script value alias, a binary property alias, or a special ID. Special IDs are matched loosely and correspond to the following sets: "ANY" = [-\U0010FFFF], "ASCII" = [-].

valueAlias - a value alias, either short or long. The name is matched loosely. See PropertyValueAliases.txt for names and a description of loose matching. In addition to aliases listed, numeric values and canonical combining classes may be expressed numerically, e.g., ("nv", "0.5") or ("ccc", "220"). The value string may also be empty.

Returns:

a reference to this set

Status:

Stable ICU 2.4.

applyPropertyAlias

public UnicodeSet applyPropertyAlias(String propertyAlias,
                                     String valueAlias,
                                     SymbolTable symbols)

Modifies this set to contain those code points which have the given value for the given property. Prior contents of this set are lost.

Parameters:

propertyAlias - A string of the property alias.

valueAlias - A string of the value alias.

symbols - if not null, then symbols are first called to see if a property is available. If true, then everything else is skipped.

Returns:

this set

Status:

Stable ICU 3.2.

closeOver

public UnicodeSet closeOver(int attribute)

Close this set over the given attribute. For the attribute CASE, the result is to modify this set so that: 1. For each character or string 'a' in this set, all strings 'b' such that foldCase(a) == foldCase(b) are added to this set. (For most 'a' that are single characters, 'b' will have b.length() == 1.) 2. For each string 'e' in the resulting set, if e != foldCase(e), 'e' will be removed. Example: [aqß{Bc}{bC}{Fi}] => [aAqQßfi{ss}{bc}{fi}] (Here foldCase(x) refers to the operation UCharacter.foldCase(x, true), and a == b actually denotes a.equals(b), not pointer comparison.)

Parameters:

attribute - bitmask for attributes to close over. Currently only the CASE bit is supported. Any undefined bits are ignored.

Returns:

a reference to this set.

Status:

Stable ICU 3.8.

isFrozen

public boolean isFrozen()

Is this frozen, according to the Freezable interface?

Specified by:

isFrozen in interface Freezable<UnicodeSet>

Returns:

value

Status:

Stable ICU 3.8.

freeze

public UnicodeSet freeze()

Freeze this class, according to the Freezable interface.

Specified by:

freeze in interface Freezable<UnicodeSet>

Returns:

this

Status:

Stable ICU 4.4.

span

public int span(CharSequence s,
                UnicodeSet.SpanCondition spanCondition)

Span a string using this UnicodeSet.

Parameters:

s - The string to be spanned

spanCondition - The span condition

Returns:

the length of the span

Status:

Stable ICU 4.4.

span

public int span(CharSequence s,
                int start,
                UnicodeSet.SpanCondition spanCondition)

Span a string using this UnicodeSet. If the start index is less than 0, span will start from 0. If the start index is greater than the string length, span returns the string length.

Parameters:

s - The string to be spanned

start - The start index that the span begins

spanCondition - The span condition

Returns:

the string index which ends the span (i.e. exclusive)

Status:

Stable ICU 4.4.

spanBack

public int spanBack(CharSequence s,
                    UnicodeSet.SpanCondition spanCondition)

Span a string backwards (from the end) using this UnicodeSet.

Parameters:

s - The string to be spanned

spanCondition - The span condition

Returns:

The string index which starts the span (i.e. inclusive).

Status:

Stable ICU 4.4.

spanBack

public int spanBack(CharSequence s,
                    int fromIndex,
                    UnicodeSet.SpanCondition spanCondition)

Span a string backwards (from the fromIndex) using this UnicodeSet. If the fromIndex is less than 0, spanBack will return 0. If fromIndex is greater than the string length, spanBack will start from the string length.

Parameters:

s - The string to be spanned

fromIndex - The index of the char (exclusive) that the string should be spanned backwards

spanCondition - The span condition

Returns:

The string index which starts the span (i.e. inclusive).

Status:

Stable ICU 4.4.

cloneAsThawed

public UnicodeSet cloneAsThawed()

Clone a thawed version of this class, according to the Freezable interface.

Specified by:

cloneAsThawed in interface Freezable<UnicodeSet>

Returns:

this

Status:

Stable ICU 4.4.

iterator

public Iterator<String> iterator()

Returns a string iterator. Uses the same order of iteration as UnicodeSetIterator.

Specified by:

iterator in interface Iterable<String>

See Also:

Set.iterator()

Status:

Stable ICU 4.4.

containsAll

public boolean containsAll(Collection<String> collection)

See Also:

containsAll(com.ibm.icu.text.UnicodeSet)

Status:

Stable ICU 4.4.

containsNone

public boolean containsNone(Collection<String> collection)

See Also:

containsNone(com.ibm.icu.text.UnicodeSet)

Status:

Stable ICU 4.4.

containsSome

public final boolean containsSome(Collection<String> collection)

See Also:

containsAll(com.ibm.icu.text.UnicodeSet)

Status:

Stable ICU 4.4.

addAll

public UnicodeSet addAll(String... collection)

See Also:

addAll(com.ibm.icu.text.UnicodeSet)

Status:

Stable ICU 4.4.

removeAll

public UnicodeSet removeAll(Collection<String> collection)

See Also:

removeAll(com.ibm.icu.text.UnicodeSet)

Status:

Stable ICU 4.4.

retainAll

public UnicodeSet retainAll(Collection<String> collection)

See Also:

retainAll(com.ibm.icu.text.UnicodeSet)

Status:

Stable ICU 4.4.

compareTo

public int compareTo(UnicodeSet o)

Compares UnicodeSets, where shorter come first, and otherwise lexigraphically (according to the comparison of the first characters that differ).

Specified by:

compareTo in interface Comparable<UnicodeSet>

See Also:

Comparable.compareTo(java.lang.Object)

Status:

Stable ICU 4.4.

compareTo

public int compareTo(UnicodeSet o,
                     UnicodeSet.ComparisonStyle style)

Compares UnicodeSets, in three different ways.

See Also:

Comparable.compareTo(java.lang.Object)

Status:

Stable ICU 4.4.

compareTo

public int compareTo(Iterable<String> other)

Status:

Stable ICU 4.4.

compare

public static int compare(String string,
                          int codePoint)

Utility to compare a string to a code point. Same results as turning the code point into a string (with the [ugly] new StringBuilder().appendCodePoint(codepoint).toString()) and comparing, but much faster (no object creation). Actually, there is one difference; a null compares as less. Note that this (=String) order is UTF-16 order -- *not* code point order.

Status:

Stable ICU 4.4.

compare

public static int compare(int codePoint,
                          String string)

Utility to compare a string to a code point. Same results as turning the code point into a string and comparing, but much faster (no object creation). Actually, there is one difference; a null compares as less. Note that this (=String) order is UTF-16 order -- *not* code point order.

Status:

Stable ICU 4.4.

compare

public static <T extends Comparable<T>> int compare(Iterable<T> collection1,
                                                    Iterable<T> collection2)

Utility to compare two iterables. Warning: the ordering in iterables is important. For Collections that are ordered, like Lists, that is expected. However, Sets in Java violate Leibniz's law when it comes to iteration. That means that sets can't be compared directly with this method, unless they are TreeSets without (or with the same) comparator. Unfortunately, it is impossible to reliably detect in Java whether subclass of Collection satisfies the right criteria, so it is left to the user to avoid those circumstances.

Status:

Stable ICU 4.4.

compare

public static <T extends Comparable<T>> int compare(Iterator<T> first,
                                                    Iterator<T> other)

Deprecated. This API is ICU internal only.

Utility to compare two iterators. Warning: the ordering in iterables is important. For Collections that are ordered, like Lists, that is expected. However, Sets in Java violate Leibniz's law when it comes to iteration. That means that sets can't be compared directly with this method, unless they are TreeSets without (or with the same) comparator. Unfortunately, it is impossible to reliably detect in Java whether subclass of Collection satisfies the right criteria, so it is left to the user to avoid those circumstances.

Status:

Internal. This API is ICU internal only.

compare

public static <T extends Comparable<T>> int compare(Collection<T> collection1,
                                                    Collection<T> collection2,
                                                    UnicodeSet.ComparisonStyle style)

Utility to compare two collections, optionally by size, and then lexicographically.

Status:

Stable ICU 4.4.

addAllTo

public static <T,U extends Collection<T>> U addAllTo(Iterable<T> source,
                                                     U target)

Utility for adding the contents of an iterable to a collection.

Status:

Stable ICU 4.4.

addAllTo

public static <T> T[] addAllTo(Iterable<T> source,
                               T[] target)

Utility for adding the contents of an iterable to a collection.

Status:

Stable ICU 4.4.

strings

public Iterable<String> strings()

For iterating through the strings in the set. Example:

 for (String key : myUnicodeSet.strings()) {
   doSomethingWith(key);
 }
 

Status:

Stable ICU 4.4.

getSingleCodePoint

public static int getSingleCodePoint(CharSequence s)

Deprecated. This API is ICU internal only.

Return the value of the first code point, if the string is exactly one code point. Otherwise return Integer.MAX_VALUE.

Status:

Internal. This API is ICU internal only.

addBridges

public UnicodeSet addBridges(UnicodeSet dontCare)

Deprecated. This API is ICU internal only.

Simplify the ranges in a Unicode set by merging any ranges that are only separated by characters in the dontCare set. For example, the ranges: \\u2E80-\\u2E99\\u2E9B-\\u2EF3\\u2F00-\\u2FD5\\u2FF0-\\u2FFB\\u3000-\\u303E change to \\u2E80-\\u303E if the dontCare set includes unassigned characters (for a particular version of Unicode).

Parameters:

dontCare - Set with the don't-care characters for spanning

Returns:

the input set, modified

Status:

Internal. This API is ICU internal only.

findIn

public int findIn(CharSequence value,
                  int fromIndex,
                  boolean findNot)

Deprecated. This API is ICU internal only.

Find the first index at or after fromIndex where the UnicodeSet matches at that index. If findNot is true, then reverse the sense of the match: find the first place where the UnicodeSet doesn't match. If there is no match, length is returned.

Status:

Internal. This API is ICU internal only.

findLastIn

public int findLastIn(CharSequence value,
                      int fromIndex,
                      boolean findNot)

Deprecated. This API is ICU internal only.

Find the last index before fromIndex where the UnicodeSet matches at that index. If findNot is true, then reverse the sense of the match: find the last place where the UnicodeSet doesn't match. If there is no match, -1 is returned. BEFORE index is not in the UnicodeSet.

Status:

Internal. This API is ICU internal only.

stripFrom

public String stripFrom(CharSequence source,
                        boolean matches)

Deprecated. This API is ICU internal only.

Strips code points from source. If matches is true, script all that match this. If matches is false, then strip all that don't match.

Parameters:

source - The source of the CharSequence to strip from.

matches - A boolean to either strip all that matches or don't match with the current UnicodeSet object.

Returns:

The string after it has been stripped.

Status:

Internal. This API is ICU internal only.

getDefaultXSymbolTable

public static UnicodeSet.XSymbolTable getDefaultXSymbolTable()

Get the default symbol table. Null means ordinary processing. For internal use only.

Returns:

the symbol table

Status:

Internal. This API is ICU internal only.

setDefaultXSymbolTable

public static void setDefaultXSymbolTable(UnicodeSet.XSymbolTable xSymbolTable)

Set the default symbol table. Null means ordinary processing. For internal use only. Will affect all subsequent parsing of UnicodeSets.

WARNING: If this function is used with a UnicodeProperty, and the Unassigned characters (gc=Cn) are different than in ICU other than in ICU, you MUST call UnicodeProperty.ResetCacheProperties afterwards. If you then call UnicodeSet.setDefaultXSymbolTable with null to clear the value, you MUST also call UnicodeProperty.ResetCacheProperties.

Parameters:

xSymbolTable - the new default symbol table.

Status:

Internal. This API is ICU internal only.