AlphabeticIndex.ImmutableIndex | API reference

public static final class AlphabeticIndex.ImmutableIndex
extends Object implements Iterable<Bucket<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 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.Iterable

`default void`	`forEach(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 Iterator<Bucket<V>>`	`iterator()` Returns an iterator over elements of type `T`.
`default Spliterator<Bucket<V>>`	`spliterator()` Creates a `Spliterator` over the elements described by this `Iterable`.

Public methods

getBucket

public 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

public int getBucketCount ()

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

Returns
`int`	the number of index buckets

getBucketIndex

public 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

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.