SearchIterator.ElementComparisonType

Kotlin |Java

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

java.lang.Object
↳	java.lang.Enum<android.icu.text.SearchIterator.ElementComparisonType>
	↳	android.icu.text.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:

Summary

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

Public methods
`static SearchIterator.ElementComparisonType`	`valueOf(String name)`
`static final ElementComparisonType[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(SearchIterator.ElementComparisonType o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<SearchIterator.ElementComparisonType>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)` Returns the enum constant of the specified enum class with the specified name.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(SearchIterator.ElementComparisonType o)

Compares this object with the specified object for order.

Enum values

ANY_BASE_WEIGHT_IS_WILDCARD

Added in API level 24

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.

PATTERN_BASE_WEIGHT_IS_WILDCARD

Added in API level 24

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.

STANDARD_ELEMENT_COMPARISON

Added in API level 24

public static final SearchIterator.ElementComparisonType STANDARD_ELEMENT_COMPARISON

Standard collation element comparison at the specified collator strength.

Public methods

valueOf

public static SearchIterator.ElementComparisonType valueOf (String name)

Parameters
`name`	`String`

Returns
`SearchIterator.ElementComparisonType`

values

public static final ElementComparisonType[] values ()

Returns
`ElementComparisonType[]`