summaryrefslogtreecommitdiffstats
path: root/intl/icu/source/common/ustrenum.h
diff options
context:
space:
mode:
Diffstat (limited to 'intl/icu/source/common/ustrenum.h')
-rw-r--r--intl/icu/source/common/ustrenum.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/intl/icu/source/common/ustrenum.h b/intl/icu/source/common/ustrenum.h
new file mode 100644
index 000000000..c893cd193
--- /dev/null
+++ b/intl/icu/source/common/ustrenum.h
@@ -0,0 +1,87 @@
+// Copyright (C) 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
+/*
+**********************************************************************
+* Copyright (c) 2002-2014, International Business Machines
+* Corporation and others. All Rights Reserved.
+**********************************************************************
+* Author: Alan Liu
+* Created: November 11 2002
+* Since: ICU 2.4
+**********************************************************************
+*/
+#ifndef _USTRENUM_H_
+#define _USTRENUM_H_
+
+#include "unicode/uenum.h"
+#include "unicode/strenum.h"
+
+//----------------------------------------------------------------------
+U_NAMESPACE_BEGIN
+
+/**
+ * A wrapper to make a UEnumeration into a StringEnumeration. The
+ * wrapper adopts the UEnumeration is wraps.
+ */
+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
+
+#endif
+