icu::AlphabeticIndex::Bucket Class Reference
An index "bucket" with a label string and type. More...
#include <alphaindex.h>
Inheritance diagram for icu::AlphabeticIndex::Bucket:
Public Member Functions | |
| virtual | ~Bucket () |
| Destructor. | |
| const UnicodeString & | getLabel () const |
| Returns the label string. | |
| UAlphabeticIndexLabelType | getLabelType () const |
| Returns whether this bucket is a normal, underflow, overflow, or inflow bucket. | |
Friends | |
| class | AlphabeticIndex |
| class | BucketList |
Detailed Description
An index "bucket" with a label string and type.
It is referenced by getBucketIndex(), and returned by ImmutableIndex.getBucket().
The Bucket class is not intended for public subclassing.
- Stable:
- ICU 51
Definition at line 199 of file alphaindex.h.
Constructor & Destructor Documentation
| virtual icu::AlphabeticIndex::Bucket::~Bucket | ( | ) | [virtual] |
Destructor.
- Stable:
- ICU 51
Member Function Documentation
| const UnicodeString& icu::AlphabeticIndex::Bucket::getLabel | ( | ) | const [inline] |
Returns the label string.
- Returns:
- the label string for the bucket
- Stable:
- ICU 51
Definition at line 213 of file alphaindex.h.
| UAlphabeticIndexLabelType icu::AlphabeticIndex::Bucket::getLabelType | ( | ) | const [inline] |
Returns whether this bucket is a normal, underflow, overflow, or inflow bucket.
- Returns:
- the bucket label type
- Stable:
- ICU 51
Definition at line 220 of file alphaindex.h.
The documentation for this class was generated from the following file:
