# SearchIterator.ElementComparisonType

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# ElementComparisonType

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/icu/text/SearchIterator.ElementComparisonType "View this page in Java")  

```
class ElementComparisonType
```

|---|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                    |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)\<[android.icu.text.SearchIterator.ElementComparisonType](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#)\> ||
|   | ↳ | [android.icu.text.SearchIterator.ElementComparisonType](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#) |

|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known Direct Subclasses [SearchIterator.ElementComparisonType.ANY_BASE_WEIGHT_IS_WILDCARD](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE:ANY_BASE_WEIGHT_IS_WILDCARD),[SearchIterator.ElementComparisonType.PATTERN_BASE_WEIGHT_IS_WILDCARD](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE:PATTERN_BASE_WEIGHT_IS_WILDCARD),[SearchIterator.ElementComparisonType.STANDARD_ELEMENT_COMPARISON](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE:STANDARD_ELEMENT_COMPARISON) |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [SearchIterator.ElementComparisonType.ANY_BASE_WEIGHT_IS_WILDCARD](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE: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](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE: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](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE:STANDARD_ELEMENT_COMPARISON)         | Standard collation element comparison at the specified collator strength.                                                 | |

Option to control how collation elements are compared. The default value will be[STANDARD_ELEMENT_COMPARISON](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#).

PATTERN_BASE_WEIGHT_IS_WILDCARD supports "asymmetric search" as described in[UTS #10 Unicode Collation Algorithm](http://www.unicode.org/reports/tr10/#Asymmetric_Search), 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.

## Summary

|                                                                                                                                                   Enum values                                                                                                                                                   ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [ANY_BASE_WEIGHT_IS_WILDCARD](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE: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](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE:PATTERN_BASE_WEIGHT_IS_WILDCARD) Collation element comparison is modified to effectively provide behavior between the specified strength and strength - 1. |
| [STANDARD_ELEMENT_COMPARISON](https://developer.android.com/reference/kotlin/android/icu/text/SearchIterator.ElementComparisonType#ENUM_VALUE:STANDARD_ELEMENT_COMPARISON) Standard collation element comparison at the specified collator strength.                                                         |

## Enum values

### ANY_BASE_WEIGHT_IS_WILDCARD

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
enum val ANY_BASE_WEIGHT_IS_WILDCARD : SearchIterator.ElementComparisonType
```

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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
enum val PATTERN_BASE_WEIGHT_IS_WILDCARD : SearchIterator.ElementComparisonType
```

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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
enum val STANDARD_ELEMENT_COMPARISON : SearchIterator.ElementComparisonType
```

Standard collation element comparison at the specified collator strength.