ICU 60.1  60.1
Public Member Functions | Friends
icu::AlphabeticIndex::Bucket Class Reference

An index "bucket" with a label string and type. More...

#include <alphaindex.h>

Inheritance diagram for icu::AlphabeticIndex::Bucket:
icu::UObject icu::UMemory

Public Member Functions

virtual ~Bucket ()
 Destructor. More...
 
const UnicodeStringgetLabel () const
 Returns the label string. More...
 
UAlphabeticIndexLabelType getLabelType () const
 Returns whether this bucket is a normal, underflow, overflow, or inflow bucket. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 
virtual UClassID getDynamicClassID () const
 ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. More...
 

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

◆ ~Bucket()

virtual icu::AlphabeticIndex::Bucket::~Bucket ( )
virtual

Destructor.

Stable:
ICU 51

Member Function Documentation

◆ getLabel()

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.

◆ getLabelType()

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: