Go to the documentation of this file.
57 #if !UCONFIG_NO_COLLATION
70 class StringEnumeration;
72 #if !UCONFIG_NO_SERVICE
76 class CollatorFactory;
268 virtual Collator* clone(
void)
const = 0;
337 virtual EComparisonResult compare(
const UnicodeString& source,
368 virtual EComparisonResult compare(
const UnicodeString& source,
370 int32_t length)
const;
423 virtual EComparisonResult compare(
const char16_t* source, int32_t sourceLength,
424 const char16_t* target, int32_t targetLength)
443 virtual UCollationResult compare(
const char16_t* source, int32_t sourceLength,
444 const char16_t* target, int32_t targetLength,
520 virtual CollationKey& getCollationKey(
const char16_t*source,
521 int32_t sourceLength,
528 virtual int32_t hashCode(
void)
const = 0;
589 virtual ECollationStrength getStrength(
void)
const;
609 virtual void setStrength(ECollationStrength newStrength);
626 virtual int32_t getReorderCodes(int32_t *dest,
627 int32_t destCapacity,
645 virtual void setReorderCodes(
const int32_t* reorderCodes,
646 int32_t reorderCodesLength,
669 static int32_t U_EXPORT2 getEquivalentReorderCodes(int32_t reorderCode,
671 int32_t destCapacity,
684 const Locale& displayLocale,
709 static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
791 static Locale U_EXPORT2 getFunctionalEquivalent(
const char* keyword,
const Locale& locale,
794 #if !UCONFIG_NO_SERVICE
923 virtual uint32_t setVariableTop(
const char16_t *varTop, int32_t len,
UErrorCode &status) = 0;
953 virtual void setVariableTop(uint32_t varTop,
UErrorCode &status) = 0;
962 virtual uint32_t getVariableTop(
UErrorCode &status)
const = 0;
982 virtual Collator* safeClone(
void)
const;
1002 int32_t resultLength)
const = 0;
1023 virtual int32_t getSortKey(
const char16_t*source, int32_t sourceLength,
1024 uint8_t*result, int32_t resultLength)
const = 0;
1063 static int32_t U_EXPORT2 getBound(
const uint8_t *source,
1064 int32_t sourceLength,
1066 uint32_t noOfLevels,
1068 int32_t resultLength,
1085 #ifndef U_HIDE_DEPRECATED_API
1116 virtual void setLocales(
const Locale& requestedLocale,
const Locale& validLocale,
const Locale& actualLocale);
1141 virtual int32_t internalGetShortDefinitionString(
const char *locale,
1151 const char *left, int32_t leftLength,
1152 const char *right, int32_t rightLength,
1160 internalNextSortKeyPart(
1162 uint8_t *dest, int32_t count,
UErrorCode &errorCode)
const;
1164 #ifndef U_HIDE_INTERNAL_API
1167 return reinterpret_cast<Collator *
>(uc);
1171 return reinterpret_cast<const Collator *
>(uc);
1175 return reinterpret_cast<UCollator *
>(
this);
1179 return reinterpret_cast<const UCollator *
>(
this);
1181 #endif // U_HIDE_INTERNAL_API
1189 friend class CFactory;
1190 friend class SimpleCFactory;
1191 friend class ICUCollatorFactory;
1192 friend class ICUCollatorService;
1197 #if !UCONFIG_NO_SERVICE
1230 virtual UBool visible(
void)
const;
1252 const Locale& displayLocale,
@ UCOL_IDENTICAL
Identical collation strength.
@ UCOL_QUATERNARY
Quaternary collation strength.
@ UCOL_EQUAL
string a == string b
Collation keys are generated by the Collator class.
UColAttribute
Attributes that collation service understands.
Basic definitions for ICU, for both C and C++ APIs.
static const Collator * fromUCollator(const UCollator *uc)
A mutable set of Unicode characters and multicharacter strings.
ECollationStrength
Base letter represents a primary difference.
int8_t UBool
The ICU boolean type.
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
@ UCOL_LESS
string a < string b
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
@ UCOL_PRIMARY
Primary collation strength.
The Collator class performs locale-sensitive string comparison.
UColAttributeValue
Enum containing attribute values for controling collation behavior.
UCollationResult
UCOL_LESS is returned if source string is compared to be less than target string in the ucol_strcoll(...
@ UCOL_SECONDARY
Secondary collation strength.
C++ API: StringPiece: Read-only byte string wrapper class.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
UCollator * toUCollator()
UObject is the common ICU "boilerplate" class.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Base class for 'pure' C++ implementations of uenum api.
virtual UClassID getDynamicClassID() const
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
UColBoundMode
enum that is taken by ucol_getBound API See below for explanation do not change the values assigned...
UNormalizationMode
Constants for normalization modes.
const UCollator * toUCollator() const
struct UCollator UCollator
structure representing a collator object instance
UBool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
C API: Unicode Normalization.
C API for code unit iteration.
@ UCOL_TERTIARY
Tertiary collation strength.
C API: Unicode Character Iteration.
static Collator * fromUCollator(UCollator *uc)
uint8_t UVersionInfo[U_MAX_VERSION_LENGTH]
The binary form of a version on ICU APIs is an array of 4 uint8_t.
C++ API: Locale ID object.
C++ API: Common ICU base class UObject.
#define U_NAMESPACE_BEGIN
A string-like object that points to a sized piece of memory.
A factory, used with registerFactory, the creates multiple collators and provides display names for t...
EComparisonResult
LESS is returned if source string is compared to be less than target string in the compare() method.
A Locale object represents a specific geographical, political, or cultural region.
@ UCOL_GREATER
string a > string b
UColReorderCode
Enum containing the codes for reordering segments of the collation table that are not script codes.
const typedef void * URegistryKey
Opaque type returned by registerInstance, registerFactory and unregister for service registration.