com.ibm.icu.text

Enum SearchIterator.ElementComparisonType

java.lang.Object

java.lang.Enum<SearchIterator.ElementComparisonType>

com.ibm.icu.text.SearchIterator.ElementComparisonType

All Implemented Interfaces:

Serializable, Comparable<SearchIterator.ElementComparisonType>

Enclosing class:

SearchIterator

public static enum SearchIterator.ElementComparisonType
extends Enum<SearchIterator.ElementComparisonType>

Option to control how collation elements are compared. The default value will be STANDARD_ELEMENT_COMPARISON.

PATTERN_BASE_WEIGHT_IS_WILDCARD supports "asymmetric search" as described in UTS #10 Unicode Collation Algorithm, while ANY_BASE_WEIGHT_IS_WILDCARD supports a related option in which "unmarked" characters in either the pattern or the searched text are treated as wildcards that match marked or unmarked versions of the same character.

See Also:

SearchIterator.setElementComparisonType(ElementComparisonType), SearchIterator.getElementComparisonType()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY_BASE_WEIGHT_IS_WILDCARD Collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1.
PATTERN_BASE_WEIGHT_IS_WILDCARD Collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1.
STANDARD_ELEMENT_COMPARISON Standard collation element comparison at the specified collator strength.

Method Summary

Modifier and Type	Method and Description
static SearchIterator.ElementComparisonType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchIterator.ElementComparisonType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, getSharedConstants, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STANDARD_ELEMENT_COMPARISON

public static final SearchIterator.ElementComparisonType STANDARD_ELEMENT_COMPARISON

Standard collation element comparison at the specified collator strength.

PATTERN_BASE_WEIGHT_IS_WILDCARD

public static final SearchIterator.ElementComparisonType PATTERN_BASE_WEIGHT_IS_WILDCARD

Collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1.

Collation elements in the pattern that have the base weight for the specified strength are treated as "wildcards" that match an element with any other weight at that collation level in the searched text. For example, with a secondary-strength English collator, a plain 'e' in the pattern will match a plain e or an e with any diacritic in the searched text, but an e with diacritic in the pattern will only match an e with the same diacritic in the searched text.

ANY_BASE_WEIGHT_IS_WILDCARD

public static final SearchIterator.ElementComparisonType ANY_BASE_WEIGHT_IS_WILDCARD

Collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1.

Collation elements in either the pattern or the searched text that have the base weight for the specified strength are treated as "wildcards" that match an element with any other weight at that collation level. For example, with a secondary-strength English collator, a plain 'e' in the pattern will match a plain e or an e with any diacritic in the searched text, but an e with diacritic in the pattern will only match an e with the same diacritic or a plain e in the searched text.

Method Detail

values

public static SearchIterator.ElementComparisonType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchIterator.ElementComparisonType c : SearchIterator.ElementComparisonType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchIterator.ElementComparisonType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null