Search  

---

sortkey.h

Go to the documentation of this file.

/*
* Copyright (C) {1996-2003}, 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 !UCONFIG_NO_COLLATION

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

U_NAMESPACE_BEGIN

/* forward declaration */
class RuleBasedCollator;

class U_I18N_API CollationKey : public UObject {
public:
    CollationKey();


    CollationKey(const  uint8_t*    values,
                int32_t     count);

    CollationKey(const CollationKey& other);

    ~CollationKey();

    const   CollationKey&   operator=(const CollationKey& other);

    UBool                   operator==(const CollationKey& source) const;

    UBool                   operator!=(const CollationKey& source) const;


    UBool                   isBogus(void) const;

    const    uint8_t*       getByteArray(int32_t& count) const;

#ifdef U_USE_COLLATION_KEY_DEPRECATES
    uint8_t*                toByteArray(int32_t& count) const;
#endif

    Collator::EComparisonResult compareTo(const CollationKey& target) const;

    UCollationResult compareTo(const CollationKey& target, UErrorCode &status) const;

    int32_t                 hashCode(void) const;

    virtual UClassID getDynamicClassID() const;

    static UClassID getStaticClassID();

private:
    void adopt(uint8_t *values, int32_t count);

    /*
    * Creates a collation key with a string.
    */

    CollationKey&           ensureCapacity(int32_t newSize);
    CollationKey&           setToBogus(void);
    CollationKey&           reset(void);
    
    friend  class           RuleBasedCollator;
    UBool                   fBogus;
    int32_t                 fCount;
    int32_t                 fCapacity;
    int32_t                 fHashCode;
    uint8_t*                fBytes;

};

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

inline UBool
CollationKey::isBogus() const
{
    return fBogus;
}

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

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_COLLATION */

#endif

---