ICU 63.1  63.1
strenum.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 *
6 * Copyright (C) 2002-2012, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 */
11 
12 #ifndef STRENUM_H
13 #define STRENUM_H
14 
15 #include "unicode/uobject.h"
16 #include "unicode/unistr.h"
17 
24 
58 public:
63  virtual ~StringEnumeration();
64 
80  virtual StringEnumeration *clone() const;
81 
99  virtual int32_t count(UErrorCode& status) const = 0;
100 
131  virtual const char* next(int32_t *resultLength, UErrorCode& status);
132 
156  virtual const char16_t* unext(int32_t *resultLength, UErrorCode& status);
157 
178  virtual const UnicodeString* snext(UErrorCode& status);
179 
192  virtual void reset(UErrorCode& status) = 0;
193 
201  virtual UBool operator==(const StringEnumeration& that)const;
209  virtual UBool operator!=(const StringEnumeration& that)const;
210 
211 protected:
221  char charsBuffer[32];
227  char *chars;
232  int32_t charsCapacity;
233 
239 
248  void ensureCharsCapacity(int32_t capacity, UErrorCode &status);
249 
272  UnicodeString *setChars(const char *s, int32_t length, UErrorCode &status);
273 };
274 
276 
277 /* STRENUM_H */
278 #endif
icu::StringEnumeration::next
virtual const char * next(int32_t *resultLength, UErrorCode &status)
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:225
icu::StringEnumeration::unistr
UnicodeString unistr
UnicodeString field for use with default implementations and subclasses.
Definition: strenum.h:216
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition: utypes.h:300
icu::StringEnumeration::count
virtual int32_t count(UErrorCode &status) const =0
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:290
icu::StringEnumeration::unext
virtual const char16_t * unext(int32_t *resultLength, UErrorCode &status)
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:220
icu::StringEnumeration::~StringEnumeration
virtual ~StringEnumeration()
Destructor.
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition: utypes.h:401
icu::StringEnumeration
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:57
icu::StringEnumeration::chars
char * chars
char * buffer for use with default implementations and subclasses.
Definition: strenum.h:227
icu::StringEnumeration::reset
virtual void reset(UErrorCode &status)=0
icu::StringEnumeration::ensureCharsCapacity
void ensureCharsCapacity(int32_t capacity, UErrorCode &status)
Ensures that chars is at least as large as the requested capacity.
icu::StringEnumeration::operator!=
virtual UBool operator!=(const StringEnumeration &that) const
Compares this enumeration to other to check if both are not equal.
icu::StringEnumeration::charsCapacity
int32_t charsCapacity
Capacity of chars, for use with default implementations and subclasses.
Definition: strenum.h:232
icu::StringEnumeration::setChars
UnicodeString * setChars(const char *s, int32_t length, UErrorCode &status)
Converts s to Unicode and sets unistr to the result.
icu::StringEnumeration::clone
virtual StringEnumeration * clone() const
Clone this object, an instance of a subclass of StringEnumeration.
uobject.h
C++ API: Common ICU base class UObject.
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
icu::StringEnumeration::snext
virtual const UnicodeString * snext(UErrorCode &status)
icu::StringEnumeration::StringEnumeration
StringEnumeration()
Default constructor for use with default implementations and subclasses.
icu::StringEnumeration::operator==
virtual UBool operator==(const StringEnumeration &that) const
Compares this enumeration to other to check if both are equal.
unistr.h
C++ API: Unicode String.