Gecko [ tanishkshah.com ]

Name	Size	Permission	Date
alphaindex.h	26.43 KB	-rw-r--r--	2026-05-29 16:59
appendable.h	8.54 KB	-rw-r--r--	2026-05-29 16:59
basictz.h	9.99 KB	-rw-r--r--	2026-05-29 16:59
brkiter.h	28.52 KB	-rw-r--r--	2026-05-29 16:59
bytestream.h	11.79 KB	-rw-r--r--	2026-05-29 16:59
bytestrie.h	20.83 KB	-rw-r--r--	2026-05-29 16:59
bytestriebuilder.h	7.44 KB	-rw-r--r--	2026-05-29 16:59
calendar.h	110.47 KB	-rw-r--r--	2026-05-29 16:59
caniter.h	7.47 KB	-rw-r--r--	2026-05-29 16:59
casemap.h	25.42 KB	-rw-r--r--	2026-05-29 16:59
char16ptr.h	10.79 KB	-rw-r--r--	2026-05-29 16:59
chariter.h	23.79 KB	-rw-r--r--	2026-05-29 16:59
choicfmt.h	23.99 KB	-rw-r--r--	2026-05-29 16:59
coleitr.h	13.78 KB	-rw-r--r--	2026-05-29 16:59
coll.h	59.5 KB	-rw-r--r--	2026-05-29 16:59
compactdecimalformat.h	6.88 KB	-rw-r--r--	2026-05-29 16:59
curramt.h	3.67 KB	-rw-r--r--	2026-05-29 16:59
currpinf.h	7.3 KB	-rw-r--r--	2026-05-29 16:59
currunit.h	4.02 KB	-rw-r--r--	2026-05-29 16:59
datefmt.h	41.29 KB	-rw-r--r--	2026-05-29 16:59
dbbi.h	1.19 KB	-rw-r--r--	2026-05-29 16:59
dcfmtsym.h	21.27 KB	-rw-r--r--	2026-05-29 16:59
decimfmt.h	87.45 KB	-rw-r--r--	2026-05-29 16:59
displayoptions.h	7.08 KB	-rw-r--r--	2026-05-29 16:59
docmain.h	7.66 KB	-rw-r--r--	2026-05-29 16:59
dtfmtsym.h	41.04 KB	-rw-r--r--	2026-05-29 16:59
dtintrv.h	3.84 KB	-rw-r--r--	2026-05-29 16:59
dtitvfmt.h	49.2 KB	-rw-r--r--	2026-05-29 16:59
dtitvinf.h	18.54 KB	-rw-r--r--	2026-05-29 16:59
dtptngen.h	29.28 KB	-rw-r--r--	2026-05-29 16:59
dtrule.h	8.66 KB	-rw-r--r--	2026-05-29 16:59
edits.h	20.74 KB	-rw-r--r--	2026-05-29 16:59
enumset.h	2.08 KB	-rw-r--r--	2026-05-29 16:59
errorcode.h	4.84 KB	-rw-r--r--	2026-05-29 16:59
fieldpos.h	8.69 KB	-rw-r--r--	2026-05-29 16:59
filteredbrk.h	5.37 KB	-rw-r--r--	2026-05-29 16:59
fmtable.h	24.36 KB	-rw-r--r--	2026-05-29 16:59
format.h	12.78 KB	-rw-r--r--	2026-05-29 16:59
formattednumber.h	6.25 KB	-rw-r--r--	2026-05-29 16:59
formattedvalue.h	9.75 KB	-rw-r--r--	2026-05-29 16:59
fpositer.h	3.03 KB	-rw-r--r--	2026-05-29 16:59
gender.h	3.35 KB	-rw-r--r--	2026-05-29 16:59
gregocal.h	30.05 KB	-rw-r--r--	2026-05-29 16:59
icudataver.h	1.02 KB	-rw-r--r--	2026-05-29 16:59
icuplug.h	12.1 KB	-rw-r--r--	2026-05-29 16:59
idna.h	12.93 KB	-rw-r--r--	2026-05-29 16:59
listformatter.h	8.59 KB	-rw-r--r--	2026-05-29 16:59
localebuilder.h	11.09 KB	-rw-r--r--	2026-05-29 16:59
localematcher.h	26.86 KB	-rw-r--r--	2026-05-29 16:59
localpointer.h	19.52 KB	-rw-r--r--	2026-05-29 16:59
locdspnm.h	7.12 KB	-rw-r--r--	2026-05-29 16:59
locid.h	53.98 KB	-rw-r--r--	2026-05-29 16:59
measfmt.h	11.41 KB	-rw-r--r--	2026-05-29 16:59
measunit.h	133.12 KB	-rw-r--r--	2026-05-29 16:59
measure.h	4.63 KB	-rw-r--r--	2026-05-29 16:59
messageformat2.h	21.59 KB	-rw-r--r--	2026-05-29 16:59
messageformat2_arguments.h	3.84 KB	-rw-r--r--	2026-05-29 16:59
messageformat2_data_model.h	96.61 KB	-rw-r--r--	2026-05-29 16:59
messageformat2_data_model_names.h	784 B	-rw-r--r--	2026-05-29 16:59
messageformat2_formattable.h	39.37 KB	-rw-r--r--	2026-05-29 16:59
messageformat2_function_registry.h	18.07 KB	-rw-r--r--	2026-05-29 16:59
messagepattern.h	33.79 KB	-rw-r--r--	2026-05-29 16:59
msgfmt.h	44.94 KB	-rw-r--r--	2026-05-29 16:59
normalizer2.h	34.68 KB	-rw-r--r--	2026-05-29 16:59
normlzr.h	30.79 KB	-rw-r--r--	2026-05-29 16:59
nounit.h	2.24 KB	-rw-r--r--	2026-05-29 16:59
numberformatter.h	90.72 KB	-rw-r--r--	2026-05-29 16:59
numberrangeformatter.h	25.68 KB	-rw-r--r--	2026-05-29 16:59
numfmt.h	50.16 KB	-rw-r--r--	2026-05-29 16:59
numsys.h	7.22 KB	-rw-r--r--	2026-05-29 16:59
parseerr.h	3.08 KB	-rw-r--r--	2026-05-29 16:59
parsepos.h	5.56 KB	-rw-r--r--	2026-05-29 16:59
platform.h	27.19 KB	-rw-r--r--	2026-05-29 16:59
plurfmt.h	25.46 KB	-rw-r--r--	2026-05-29 16:59
plurrule.h	20.63 KB	-rw-r--r--	2026-05-29 16:59
ptypes.h	2.16 KB	-rw-r--r--	2026-05-29 16:59
putil.h	6.32 KB	-rw-r--r--	2026-05-29 16:59
rbbi.h	31.73 KB	-rw-r--r--	2026-05-29 16:59
rbnf.h	57.19 KB	-rw-r--r--	2026-05-29 16:59
rbtz.h	15.75 KB	-rw-r--r--	2026-05-29 16:59
regex.h	83.83 KB	-rw-r--r--	2026-05-29 16:59
region.h	9.2 KB	-rw-r--r--	2026-05-29 16:59
reldatefmt.h	22.69 KB	-rw-r--r--	2026-05-29 16:59
rep.h	9.38 KB	-rw-r--r--	2026-05-29 16:59
resbund.h	18.02 KB	-rw-r--r--	2026-05-29 16:59
schriter.h	6.09 KB	-rw-r--r--	2026-05-29 16:59
scientificnumberformatter.h	6.44 KB	-rw-r--r--	2026-05-29 16:59
search.h	22.21 KB	-rw-r--r--	2026-05-29 16:59
selfmt.h	14.35 KB	-rw-r--r--	2026-05-29 16:59
simpleformatter.h	12.6 KB	-rw-r--r--	2026-05-29 16:59
simplenumberformatter.h	8.87 KB	-rw-r--r--	2026-05-29 16:59
simpletz.h	45.62 KB	-rw-r--r--	2026-05-29 16:59
smpdtfmt.h	57.57 KB	-rw-r--r--	2026-05-29 16:59
sortkey.h	11.13 KB	-rw-r--r--	2026-05-29 16:59
std_string.h	1.05 KB	-rw-r--r--	2026-05-29 16:59
strenum.h	9.96 KB	-rw-r--r--	2026-05-29 16:59
stringoptions.h	5.79 KB	-rw-r--r--	2026-05-29 16:59
stringpiece.h	10.29 KB	-rw-r--r--	2026-05-29 16:59
stringtriebuilder.h	15.53 KB	-rw-r--r--	2026-05-29 16:59
stsearch.h	21.43 KB	-rw-r--r--	2026-05-29 16:59
symtable.h	4.28 KB	-rw-r--r--	2026-05-29 16:59
tblcoll.h	38.79 KB	-rw-r--r--	2026-05-29 16:59
timezone.h	45.59 KB	-rw-r--r--	2026-05-29 16:59
tmunit.h	3.37 KB	-rw-r--r--	2026-05-29 16:59
tmutamt.h	4.9 KB	-rw-r--r--	2026-05-29 16:59
tmutfmt.h	7.42 KB	-rw-r--r--	2026-05-29 16:59
translit.h	65.81 KB	-rw-r--r--	2026-05-29 16:59
tzfmt.h	44.76 KB	-rw-r--r--	2026-05-29 16:59
tznames.h	16.85 KB	-rw-r--r--	2026-05-29 16:59
tzrule.h	34.81 KB	-rw-r--r--	2026-05-29 16:59
tztrans.h	6.11 KB	-rw-r--r--	2026-05-29 16:59
ubidi.h	89.61 KB	-rw-r--r--	2026-05-29 16:59
ubiditransform.h	12.71 KB	-rw-r--r--	2026-05-29 16:59
ubrk.h	24.43 KB	-rw-r--r--	2026-05-29 16:59
ucal.h	63.95 KB	-rw-r--r--	2026-05-29 16:59
ucasemap.h	15.27 KB	-rw-r--r--	2026-05-29 16:59
ucat.h	5.35 KB	-rw-r--r--	2026-05-29 16:59
uchar.h	152.33 KB	-rw-r--r--	2026-05-29 16:59
ucharstrie.h	22.59 KB	-rw-r--r--	2026-05-29 16:59
ucharstriebuilder.h	7.48 KB	-rw-r--r--	2026-05-29 16:59
uchriter.h	13.24 KB	-rw-r--r--	2026-05-29 16:59
uclean.h	11.21 KB	-rw-r--r--	2026-05-29 16:59
ucnv.h	83.34 KB	-rw-r--r--	2026-05-29 16:59
ucnv_cb.h	6.58 KB	-rw-r--r--	2026-05-29 16:59
ucnv_err.h	20.98 KB	-rw-r--r--	2026-05-29 16:59
ucnvsel.h	6.24 KB	-rw-r--r--	2026-05-29 16:59
ucol.h	67.35 KB	-rw-r--r--	2026-05-29 16:59
ucoleitr.h	9.82 KB	-rw-r--r--	2026-05-29 16:59
uconfig.h	12.56 KB	-rw-r--r--	2026-05-29 16:59
ucpmap.h	5.54 KB	-rw-r--r--	2026-05-29 16:59
ucptrie.h	22.51 KB	-rw-r--r--	2026-05-29 16:59
ucsdet.h	14.69 KB	-rw-r--r--	2026-05-29 16:59
ucurr.h	16.72 KB	-rw-r--r--	2026-05-29 16:59
udat.h	62.66 KB	-rw-r--r--	2026-05-29 16:59
udata.h	15.63 KB	-rw-r--r--	2026-05-29 16:59
udateintervalformat.h	11.93 KB	-rw-r--r--	2026-05-29 16:59
udatpg.h	30.13 KB	-rw-r--r--	2026-05-29 16:59
udisplaycontext.h	5.94 KB	-rw-r--r--	2026-05-29 16:59
udisplayoptions.h	8.86 KB	-rw-r--r--	2026-05-29 16:59
uenum.h	7.79 KB	-rw-r--r--	2026-05-29 16:59
ufieldpositer.h	4.41 KB	-rw-r--r--	2026-05-29 16:59
uformattable.h	10.97 KB	-rw-r--r--	2026-05-29 16:59
uformattednumber.h	8.09 KB	-rw-r--r--	2026-05-29 16:59
uformattedvalue.h	12.25 KB	-rw-r--r--	2026-05-29 16:59
ugender.h	2.06 KB	-rw-r--r--	2026-05-29 16:59
uidna.h	34.12 KB	-rw-r--r--	2026-05-29 16:59
uiter.h	22.75 KB	-rw-r--r--	2026-05-29 16:59
uldnames.h	10.48 KB	-rw-r--r--	2026-05-29 16:59
ulistformatter.h	10.78 KB	-rw-r--r--	2026-05-29 16:59
uloc.h	55.38 KB	-rw-r--r--	2026-05-29 16:59
ulocale.h	6.31 KB	-rw-r--r--	2026-05-29 16:59
ulocbuilder.h	16.69 KB	-rw-r--r--	2026-05-29 16:59
ulocdata.h	11.3 KB	-rw-r--r--	2026-05-29 16:59
umachine.h	15.25 KB	-rw-r--r--	2026-05-29 16:59
umisc.h	1.34 KB	-rw-r--r--	2026-05-29 16:59
umsg.h	24.25 KB	-rw-r--r--	2026-05-29 16:59
umutablecptrie.h	8.3 KB	-rw-r--r--	2026-05-29 16:59
unifilt.h	4 KB	-rw-r--r--	2026-05-29 16:59
unifunct.h	4.05 KB	-rw-r--r--	2026-05-29 16:59
unimatch.h	6.1 KB	-rw-r--r--	2026-05-29 16:59
unirepl.h	3.38 KB	-rw-r--r--	2026-05-29 16:59
uniset.h	70.18 KB	-rw-r--r--	2026-05-29 16:59
unistr.h	184.51 KB	-rw-r--r--	2026-05-29 16:59
unorm.h	20.55 KB	-rw-r--r--	2026-05-29 16:59
unorm2.h	25.66 KB	-rw-r--r--	2026-05-29 16:59
unum.h	55.16 KB	-rw-r--r--	2026-05-29 16:59
unumberformatter.h	19.68 KB	-rw-r--r--	2026-05-29 16:59
unumberoptions.h	5.23 KB	-rw-r--r--	2026-05-29 16:59
unumberrangeformatter.h	15.35 KB	-rw-r--r--	2026-05-29 16:59
unumsys.h	7.26 KB	-rw-r--r--	2026-05-29 16:59
uobject.h	10.6 KB	-rw-r--r--	2026-05-29 16:59
upluralrules.h	8.79 KB	-rw-r--r--	2026-05-29 16:59
uregex.h	71.99 KB	-rw-r--r--	2026-05-29 16:59
uregion.h	9.81 KB	-rw-r--r--	2026-05-29 16:59
ureldatefmt.h	16.98 KB	-rw-r--r--	2026-05-29 16:59
urename.h	142.22 KB	-rw-r--r--	2026-05-29 16:59
urep.h	5.38 KB	-rw-r--r--	2026-05-29 16:59
ures.h	36.65 KB	-rw-r--r--	2026-05-29 16:59
uscript.h	28.95 KB	-rw-r--r--	2026-05-29 16:59
usearch.h	39.21 KB	-rw-r--r--	2026-05-29 16:59
uset.h	63.03 KB	-rw-r--r--	2026-05-29 16:59
usetiter.h	9.63 KB	-rw-r--r--	2026-05-29 16:59
ushape.h	18 KB	-rw-r--r--	2026-05-29 16:59
usimplenumberformatter.h	7.31 KB	-rw-r--r--	2026-05-29 16:59
uspoof.h	80 KB	-rw-r--r--	2026-05-29 16:59
usprep.h	8.19 KB	-rw-r--r--	2026-05-29 16:59
ustdio.h	38.58 KB	-rw-r--r--	2026-05-29 16:59
ustream.h	1.89 KB	-rw-r--r--	2026-05-29 16:59
ustring.h	72.16 KB	-rw-r--r--	2026-05-29 16:59
ustringtrie.h	3.15 KB	-rw-r--r--	2026-05-29 16:59
utext.h	58.1 KB	-rw-r--r--	2026-05-29 16:59
utf.h	8.65 KB	-rw-r--r--	2026-05-29 16:59
utf16.h	23.35 KB	-rw-r--r--	2026-05-29 16:59
utf32.h	763 B	-rw-r--r--	2026-05-29 16:59
utf8.h	31.65 KB	-rw-r--r--	2026-05-29 16:59
utf_old.h	45.85 KB	-rw-r--r--	2026-05-29 16:59
utfiterator.h	95.02 KB	-rw-r--r--	2026-05-29 16:59
utfstring.h	4.89 KB	-rw-r--r--	2026-05-29 16:59
utmscale.h	13.78 KB	-rw-r--r--	2026-05-29 16:59
utrace.h	17.18 KB	-rw-r--r--	2026-05-29 16:59
utrans.h	25.54 KB	-rw-r--r--	2026-05-29 16:59
utypes.h	36.73 KB	-rw-r--r--	2026-05-29 16:59
uvernum.h	6.33 KB	-rw-r--r--	2026-05-29 16:59
uversion.h	8.21 KB	-rw-r--r--	2026-05-29 16:59
vtzone.h	20.68 KB	-rw-r--r--	2026-05-29 16:59

Rename

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
 *****************************************************************************
 * Copyright (C) 1996-2014, International Business Machines Corporation and others.
 * All Rights Reserved.
 *****************************************************************************
 *
 * File sortkey.h
 *
 * Created by: Helena Shih
 *
 * Modification History:
 *
 *  Date         Name          Description
 *
 *  6/20/97     helena      Java class name change.
 *  8/18/97     helena      Added internal API documentation.
 *  6/26/98     erm         Changed to use byte arrays and memcmp.
 *****************************************************************************
 */

#ifndef SORTKEY_H
#define SORTKEY_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

/**
 * \file 
 * \brief C++ API: Keys for comparing strings multiple times. 
 */
 
#if !UCONFIG_NO_COLLATION

#include "unicode/uobject.h"
#include "unicode/unistr.h"
#include "unicode/coll.h"

U_NAMESPACE_BEGIN

/* forward declaration */
class RuleBasedCollator;
class CollationKeyByteSink;

/**
 *
 * Collation keys are generated by the Collator class. Use the CollationKey objects
 * instead of Collator to compare strings multiple times. A CollationKey
 * preprocesses the comparison information from the Collator object to
 * make the comparison faster. If you are not going to comparing strings
 * multiple times, then using the Collator object is generally faster,
 * since it only processes as much of the string as needed to make a
 * comparison.
 * For example (with strength == tertiary)
 * When comparing "Abernathy" to "Baggins-Smythworthy", Collator
 * only needs to process a couple of characters, while a comparison
 * with CollationKeys will process all of the characters. On the other hand,
 * if you are doing a sort of a number of fields, it is much faster to use
 * CollationKeys, since you will be comparing strings multiple times.
 * Typical use of CollationKeys are in databases, where you store a CollationKey
 * in a hidden field, and use it for sorting or indexing.
 *
 * Example of use:
 * <pre>
 * \code
 * UErrorCode success = U_ZERO_ERROR;
 * Collator* myCollator = Collator::createInstance(success);
 * CollationKey* keys = new CollationKey [3];
 * myCollator->getCollationKey("Tom", keys[0], success );
 * myCollator->getCollationKey("Dick", keys[1], success );
 * myCollator->getCollationKey("Harry", keys[2], success );
 *
 * // Inside body of sort routine, compare keys this way:
 * CollationKey tmp;
 * if(keys[0].compareTo( keys[1] ) > 0 ) {
 * tmp = keys[0]; keys[0] = keys[1]; keys[1] = tmp;
 * }
 * //...
 * \endcode
 * </pre>
 * Because Collator::compare()'s algorithm is complex, it is faster to sort
 * long lists of words by retrieving collation keys with Collator::getCollationKey().
 * You can then cache the collation keys and compare them using CollationKey::compareTo().
 * 
 * Note: <code>Collator</code>s with different Locale,
 * CollationStrength and DecompositionMode settings will return different
 * CollationKeys for the same set of strings. Locales have specific
 * collation rules, and the way in which secondary and tertiary differences
 * are taken into account, for example, will result in different CollationKeys
 * for same strings.
 *

* @see          Collator
 * @see          RuleBasedCollator
 * @version      1.3 12/18/96
 * @author       Helena Shih
 * @stable ICU 2.0
 */
class U_I18N_API CollationKey : public UObject {
public:
    /**
    * This creates an empty collation key based on the null string.  An empty
    * collation key contains no sorting information.  When comparing two empty
    * collation keys, the result is Collator::EQUAL.  Comparing empty collation key
    * with non-empty collation key is always Collator::LESS.
    * @stable ICU 2.0
    */
    CollationKey();

/**
    * Creates a collation key based on the collation key values.
    * @param values the collation key values
    * @param count number of collation key values, including trailing nulls.
    * @stable ICU 2.0
    */
    CollationKey(const  uint8_t*    values,
                int32_t     count);

/**
    * Copy constructor.
    * @param other    the object to be copied.
    * @stable ICU 2.0
    */
    CollationKey(const CollationKey& other);

/**
    * Sort key destructor.
    * @stable ICU 2.0
    */
    virtual ~CollationKey();

/**
    * Assignment operator
    * @param other    the object to be copied.
    * @stable ICU 2.0
    */
    const   CollationKey&   operator=(const CollationKey& other);

/**
    * Compare if two collation keys are the same.
    * @param source the collation key to compare to.
    * @return Returns true if two collation keys are equal, false otherwise.
    * @stable ICU 2.0
    */
    bool                    operator==(const CollationKey& source) const;

/**
    * Compare if two collation keys are not the same.
    * @param source the collation key to compare to.
    * @return Returns true if two collation keys are different, false otherwise.
    * @stable ICU 2.0
    */
    bool                    operator!=(const CollationKey& source) const;

/**
    * Test to see if the key is in an invalid state. The key will be in an
    * invalid state if it couldn't allocate memory for some operation.
    * @return Returns true if the key is in an invalid, false otherwise.
    * @stable ICU 2.0
    */
    UBool isBogus() const;

/**
    * Returns a pointer to the collation key values. The storage is owned
    * by the collation key and the pointer will become invalid if the key
    * is deleted.
    * @param count the output parameter of number of collation key values,
    * including any trailing nulls.
    * @return a pointer to the collation key values.
    * @stable ICU 2.0
    */
    const    uint8_t*       getByteArray(int32_t& count) const;

#ifdef U_USE_COLLATION_KEY_DEPRECATES
    /**
    * Extracts the collation key values into a new array. The caller owns
    * this storage and should free it.
    * @param count the output parameter of number of collation key values,
    * including any trailing nulls.
    * @obsolete ICU 2.6. Use getByteArray instead since this API will be removed in that release.
    */
    uint8_t*                toByteArray(int32_t& count) const;
#endif

#ifndef U_HIDE_DEPRECATED_API 
    /**
    * Convenience method which does a string(bit-wise) comparison of the
    * two collation keys.
    * @param target target collation key to be compared with
    * @return Returns Collator::LESS if sourceKey &lt; targetKey,
    * Collator::GREATER if sourceKey > targetKey and Collator::EQUAL
    * otherwise.
    * @deprecated ICU 2.6 use the overload with error code
    */
    Collator::EComparisonResult compareTo(const CollationKey& target) const;
#endif  /* U_HIDE_DEPRECATED_API */

/**
    * Convenience method which does a string(bit-wise) comparison of the
    * two collation keys.
    * @param target target collation key to be compared with
    * @param status error code
    * @return Returns UCOL_LESS if sourceKey &lt; targetKey,
    * UCOL_GREATER if sourceKey > targetKey and UCOL_EQUAL
    * otherwise.
    * @stable ICU 2.6
    */
    UCollationResult compareTo(const CollationKey& target, UErrorCode &status) const;

/**
 * Creates an integer that is unique to the collation key. NOTE: this
 * is not the same as String.hashCode.
 * Example of use:
 * <pre>
 * . UErrorCode status = U_ZERO_ERROR;
 * . Collator *myCollation = Collator::createInstance(Locale::US, status);
 * . if (U_FAILURE(status)) return;
 * . CollationKey key1, key2;
 * . UErrorCode status1 = U_ZERO_ERROR, status2 = U_ZERO_ERROR;
 * . myCollation->getCollationKey("abc", key1, status1);
 * . if (U_FAILURE(status1)) { delete myCollation; return; }
 * . myCollation->getCollationKey("ABC", key2, status2);
 * . if (U_FAILURE(status2)) { delete myCollation; return; }
 * . // key1.hashCode() != key2.hashCode()
 * </pre>
 * @return the hash value based on the string's collation order.
 * @see UnicodeString#hashCode
 * @stable ICU 2.0
 */
 int32_t hashCode() const;

/**
     * ICU "poor man's RTTI", returns a UClassID for the actual class.
     * @stable ICU 2.2
     */
    virtual UClassID getDynamicClassID() const override;

/**
     * ICU "poor man's RTTI", returns a UClassID for this class.
     * @stable ICU 2.2
     */
    static UClassID U_EXPORT2 getStaticClassID();

private:
    /**
     * Replaces the current bytes buffer with a new one of newCapacity
     * and copies length bytes from the old buffer to the new one.
     * @return the new buffer, or nullptr if the allocation failed
     */
    uint8_t *reallocate(int32_t newCapacity, int32_t length);
    /**
     * Set a new length for a new sort key in the existing fBytes.
     */
    void setLength(int32_t newLength);

uint8_t *getBytes() {
 return (fFlagAndLength >= 0) ? fUnion.fStackBuffer : fUnion.fFields.fBytes;
 }
 const uint8_t *getBytes() const {
 return (fFlagAndLength >= 0) ? fUnion.fStackBuffer : fUnion.fFields.fBytes;
 }
 int32_t getCapacity() const {
 return fFlagAndLength >= 0 ? static_cast<int32_t>(sizeof(fUnion)) : fUnion.fFields.fCapacity;
 }
 int32_t getLength() const { return fFlagAndLength & 0x7fffffff; }

/**
    * Set the CollationKey to a "bogus" or invalid state
    * @return this CollationKey
    */
    CollationKey& setToBogus();
    /**
    * Resets this CollationKey to an empty state
    * @return this CollationKey
    */
    CollationKey& reset();

/**
    * Allow private access to RuleBasedCollator
    */
    friend  class           RuleBasedCollator;
    friend  class           CollationKeyByteSink;

// Class fields. sizeof(CollationKey) is intended to be 48 bytes
    // on a machine with 64-bit pointers.
    // We use a union to maximize the size of the internal buffer,
    // similar to UnicodeString but not as tight and complex.

// (implicit) *vtable;
    /**
     * Sort key length and flag.
     * Bit 31 is set if the buffer is heap-allocated.
     * Bits 30..0 contain the sort key length.
     */
    int32_t fFlagAndLength;
    /**
    * Unique hash value of this CollationKey.
    * Special value 2 if the key is bogus.
    */
    mutable int32_t fHashCode;
    /**
     * fUnion provides 32 bytes for the internal buffer or for
     * pointer+capacity.
     */
    union StackBufferOrFields {
        /** fStackBuffer is used iff fFlagAndLength>=0, else fFields is used */
        uint8_t fStackBuffer[32];
        struct {
            uint8_t *fBytes;
            int32_t fCapacity;
        } fFields;
    } fUnion;
};

inline bool
CollationKey::operator!=(const CollationKey& other) const
{
    return !(*this == other);
}

inline UBool
CollationKey::isBogus() const
{
    return fHashCode == 2;  // kBogusHashCode
}

inline const uint8_t*
CollationKey::getByteArray(int32_t &count) const
{
    count = getLength();
    return getBytes();
}

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_COLLATION */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif