ICU-66108.tar.gz

[apple/icu.git] / icuSources / common / ustrenum.h

diff --git a/icuSources/common/ustrenum.h b/icuSources/common/ustrenum.h
index ba3a135f9f4c841f287d336c4c01207ae7d959ed..a82162e2bde014ec5be38a5813e8e105100200fb 100644 (file)
--- a/icuSources/common/ustrenum.h
+++ b/icuSources/common/ustrenum.h
@@ -1,6 +1,8 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
 **********************************************************************
-* Copyright (c) 2002, International Business Machines
+* Copyright (c) 2002-2014, International Business Machines
 * Corporation and others.  All Rights Reserved.
 **********************************************************************
 * Author: Alan Liu
@@ -14,14 +16,72 @@
 #include "unicode/uenum.h"
 #include "unicode/strenum.h"
 
+//----------------------------------------------------------------------
+U_NAMESPACE_BEGIN
+
 /**
- * Given a StringEnumeration, wrap it in a UEnumeration.  The
- * StringEnumeration is adopted; after this call, the caller must not
- * delete it (regardless of error status).
+ * A wrapper to make a UEnumeration into a StringEnumeration.  The
+ * wrapper adopts the UEnumeration is wraps.
  */
-U_CAPI UEnumeration* U_EXPORT2
-uenum_openStringEnumeration(StringEnumeration* adopted, UErrorCode* ec);
+class U_COMMON_API UStringEnumeration : public StringEnumeration {
+
+public:
+    /**
+     * Constructor.  This constructor adopts its UEnumeration
+     * argument.
+     * @param uenum a UEnumeration object.  This object takes
+     * ownership of 'uenum' and will close it in its destructor.  The
+     * caller must not call uenum_close on 'uenum' after calling this
+     * constructor.
+     */
+    UStringEnumeration(UEnumeration* uenum);
+
+    /**
+     * Destructor.  This closes the UEnumeration passed in to the
+     * constructor.
+     */
+    virtual ~UStringEnumeration();
+
+    /**
+     * Return the number of elements that the iterator traverses.
+     * @param status the error code.
+     * @return number of elements in the iterator.
+     */
+    virtual int32_t count(UErrorCode& status) const;
+
+    virtual const char* next(int32_t *resultLength, UErrorCode& status);
+
+    /**
+     * Returns the next element a UnicodeString*.  If there are no
+     * more elements, returns NULL.
+     * @param status the error code.
+     * @return a pointer to the string, or NULL.
+     */
+    virtual const UnicodeString* snext(UErrorCode& status);
+
+    /**
+     * Resets the iterator.
+     * @param status the error code.
+     */
+    virtual void reset(UErrorCode& status);
+
+    /**
+     * ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
+     */
+    virtual UClassID getDynamicClassID() const;
+
+    /**
+     * ICU4C "poor man's RTTI", returns a UClassID for this ICU class.
+     */
+    static UClassID U_EXPORT2 getStaticClassID();
+
+    static UStringEnumeration * U_EXPORT2 fromUEnumeration(
+            UEnumeration *enumToAdopt, UErrorCode &status);
+private:
+    UEnumeration *uenum; // owned
+};
+
+U_NAMESPACE_END
 
-/* _USTRENUM_H_ */
 #endif
-/*eof*/
+