Most visited

Recently visited

Results for

Added in API level 24

Summary: Methods | Inherited Methods | [Expand All]

AlphabeticIndex.ImmutableIndex

public static final class AlphabeticIndex.ImmutableIndex
extends Object implements Iterable<Bucket<V>>

java.lang.Object
↳	android.icu.text.AlphabeticIndex.ImmutableIndex<V>

Immutable, thread-safe version of 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
`Bucket<V>`	`getBucket(int index)` Returns the index-th bucket.
`int`	`getBucketCount()` Returns the number of index buckets and labels, including underflow/inflow/overflow.
`int`	`getBucketIndex(CharSequence name)` Finds the index bucket for the given name and returns the number of that bucket.
`Iterator<Bucket<V>>`	`iterator()` Returns an iterator over elements of type `T`.

Inherited methods

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface java.lang.Iterable

Public methods

getBucket

Added in API level 24

Bucket<V> getBucket (int index)

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

Parameters
`index`	`int`: bucket number

Returns
`Bucket<V>`	the index-th bucket

getBucketCount

Added in API level 24

int getBucketCount ()

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

Returns
`int`	the number of index buckets

getBucketIndex

Added in API level 24

int getBucketIndex (CharSequence name)

Finds the index bucket for the given name and returns the number of that bucket. Use getBucket(int) to get the bucket's properties.

Parameters
`name`	`CharSequence`: the string to be sorted into an index bucket

Returns
`int`	the bucket number for the name

iterator

Added in API level 24

Iterator<Bucket<V>> iterator ()

Returns an iterator over elements of type T.

Returns
`Iterator<Bucket<V>>`	an Iterator.