Class AlphabeticIndex.Bucket<V>

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.
  • Method Details

    • getLabel

      public String getLabel()
      Get the label
      Returns:
      label for the bucket
    • getLabelType

      public AlphabeticIndex.Bucket.LabelType getLabelType()
      Is a normal, underflow, overflow, or inflow bucket
      Returns:
      is an underflow, overflow, or inflow bucket
    • size

      public int size()
      Get the number of records in the bucket.
      Returns:
      number of records in bucket
    • iterator

      public Iterator<AlphabeticIndex.Record<V>> iterator()
      Iterator over the records in the bucket
      Specified by:
      iterator in interface Iterable<V>
    • toString

      public String toString()
      Standard toString()
      Overrides:
      toString in class Object