AlphabeticIndex.Bucket (ICU4J 78)

java.lang.Object
- com.ibm.icu.text.AlphabeticIndex.Bucket<V>

Type Parameters:

V - Data type

All Implemented Interfaces:

Iterable<AlphabeticIndex.Record<V>>

Enclosing class:

AlphabeticIndex<V>
```
public static class AlphabeticIndex.Bucket<V>
extends Object
implements Iterable<AlphabeticIndex.Record<V>>
```
An index "bucket" with a label string and type. It is referenced by AlphabeticIndex.getBucketIndex(CharSequence) and AlphabeticIndex.ImmutableIndex.getBucketIndex(CharSequence), returned by AlphabeticIndex.ImmutableIndex.getBucket(int), and AlphabeticIndex.addRecord(CharSequence, Object) adds a record into a bucket according to the record's name.

Status:
Stable ICU 4.8.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AlphabeticIndex.Bucket.LabelType
Type of the label

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getLabel()`	Get the label
`AlphabeticIndex.Bucket.LabelType`	`getLabelType()`	Is a normal, underflow, overflow, or inflow bucket
`Iterator<AlphabeticIndex.Record<V>>`	`iterator()`	Iterator over the records in the bucket
`int`	`size()`	Get the number of records in the bucket.
`String`	`toString()`	Standard toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getLabel
```
public String getLabel()
```
    Get the label
    
    Returns:
    
    label for the bucket
    
    Status:
    Stable ICU 4.8.
  - getLabelType
```
public AlphabeticIndex.Bucket.LabelType getLabelType()
```
    Is a normal, underflow, overflow, or inflow bucket
    
    Returns:
    
    is an underflow, overflow, or inflow bucket
    
    Status:
    Stable ICU 4.8.
  - size
```
public int size()
```
    Get the number of records in the bucket.
    
    Returns:
    
    number of records in bucket
    
    Status:
    Stable ICU 4.8.
  - iterator
```
public Iterator<AlphabeticIndex.Record<V>> iterator()
```
    Iterator over the records in the bucket
    
    Specified by:
    
    iterator in interface Iterable<V>
    
    Status:
    Stable ICU 4.8.
  - toString
```
public String toString()
```
    Standard toString()
    
    Overrides:
    
    toString in class Object
    
    Status:
    Stable ICU 4.8.