Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#inhmethods)

# AlphabeticIndex.ImmutableIndex

*** ** * ** ***

` public static final class AlphabeticIndex.ImmutableIndex `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/lang/Iterable<https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>> `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.icu.text.AlphabeticIndex.ImmutableIndex\<V\> |

<br />

*** ** * ** ***

Immutable, thread-safe version of `https://developer.android.com/reference/android/icu/text/AlphabeticIndex`. This class provides thread-safe methods for bucketing, and random access to buckets and their properties, but does not offer adding records to the index.

## Summary

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>` | ` https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#getBucket(int)(int index) ` Returns the index-th bucket. |
| ` int` | ` https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#getBucketCount()() ` Returns the number of index buckets and labels, including underflow/inflow/overflow. |
| ` int` | ` https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#getBucketIndex(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence name) ` Finds the index bucket for the given name and returns the number of that bucket. |
| ` https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>>` | ` https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#iterator()() ` Returns an iterator over elements of type `T`. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/java/lang/Iterable ` ` default void` ` https://developer.android.com/reference/java/lang/Iterable#forEach(java.util.function.Consumer<?%20super%20T>)(https://developer.android.com/reference/java/util/function/Consumer<? super T> action) `

Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception.
` abstract https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>>` ` https://developer.android.com/reference/java/lang/Iterable#iterator()() `

Returns an iterator over elements of type `T`.
` default https://developer.android.com/reference/java/util/Spliterator<https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>>` ` https://developer.android.com/reference/java/lang/Iterable#spliterator()() `

Creates a `https://developer.android.com/reference/java/util/Spliterator` over the elements described by this `Iterable`.

## Public methods

### getBucket

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

```
public Bucket<V> getBucket (int index)
```

Returns the index-th bucket. Returns null if the index is out of range.

<br />

| Parameters ||
|---|---|
| `index` | `int`: bucket number <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>` | the index-th bucket <br /> |

### getBucketCount

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

```
public int getBucketCount ()
```

Returns the number of index buckets and labels, including underflow/inflow/overflow.

<br />

| Returns ||
|---|---|
| `int` | the number of index buckets <br /> |

### getBucketIndex

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

```
public int getBucketIndex (CharSequence name)
```

Finds the index bucket for the given name and returns the number of that bucket. Use `https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#getBucket(int)` to get the bucket's properties.

<br />

| Parameters ||
|---|---|
| `name` | `CharSequence`: the string to be sorted into an index bucket <br /> |

| Returns ||
|---|---|
| `int` | the bucket number for the name <br /> |

### iterator

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

```
public Iterator<Bucket<V>> iterator ()
```

Returns an iterator over elements of type `T`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Iterator<https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket<V>>` | an Iterator. <br /> |