AlphabeticIndex.Bucket

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

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


An index "bucket" with a label string and type. It is referenced by getBucketIndex(CharSequence) and getBucketIndex(CharSequence), returned by getBucket(int), and addRecord(CharSequence, Object) adds a record into a bucket according to the record's name.

Summary

Nested classes

enum AlphabeticIndex.Bucket.LabelType

Type of the label  

Public methods

String getLabel()

Get the label

AlphabeticIndex.Bucket.LabelType getLabelType()

Is a normal, underflow, overflow, or inflow bucket

Iterator<Record<V>> iterator()

Iterator over the records in the bucket

int size()

Get the number of records in the bucket.

String toString()

Standard toString()

Inherited methods

Public methods

getLabel

added in API level 24
String getLabel ()

Get the label

Returns
String label for the bucket

getLabelType

added in API level 24
AlphabeticIndex.Bucket.LabelType getLabelType ()

Is a normal, underflow, overflow, or inflow bucket

Returns
AlphabeticIndex.Bucket.LabelType is an underflow, overflow, or inflow bucket

iterator

added in API level 24
Iterator<Record<V>> iterator ()

Iterator over the records in the bucket

Returns
Iterator<Record<V>> an Iterator.

size

added in API level 24
int size ()

Get the number of records in the bucket.

Returns
int number of records in bucket

toString

added in API level 24
String toString ()

Standard toString()

Returns
String a string representation of the object.