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 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.
Summary
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
public String getLabel ()
Get the label
| Returns | |
|---|---|
String |
label for the bucket |
getLabelType
public AlphabeticIndex.Bucket.LabelType getLabelType ()
Is a normal, underflow, overflow, or inflow bucket
| Returns | |
|---|---|
AlphabeticIndex.Bucket.LabelType |
is an underflow, overflow, or inflow bucket |
iterator
public Iterator<Record<V>> iterator ()
Iterator over the records in the bucket
| Returns | |
|---|---|
Iterator<Record<V>> |
an Iterator. |
size
public int size ()
Get the number of records in the bucket.
| Returns | |
|---|---|
int |
number of records in bucket |
toString
public String toString ()
Standard toString()
| Returns | |
|---|---|
String |
a string representation of the object. |