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

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.

Draft:
This API may be changed in the future versions and was introduced in ICU 51

Definition at line 200 of file alphaindex.h.

Constructor & Destructor Documentation

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

Destructor.

Draft:
This API may be changed in the future versions and was introduced in ICU 51

Member Function Documentation

const UnicodeString& icu::AlphabeticIndex::Bucket::getLabel ( ) const
inline

Returns the label string.

Returns
the label string for the bucket
Draft:
This API may be changed in the future versions and was introduced in ICU 51

Definition at line 214 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
Draft:
This API may be changed in the future versions and was introduced in ICU 51

Definition at line 221 of file alphaindex.h.


The documentation for this class was generated from the following file: