ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
UCharsTrie::Iterator Class Reference

Iterator for all of the (string, value) pairs in a UCharsTrie. More...

#include <ucharstrie.h>

Inheritance diagram for UCharsTrie::Iterator:
UMemory

Public Member Functions

 Iterator (const UChar *trieUChars, int32_t maxStringLength, UErrorCode &errorCode)
 Iterates from the root of a UChar-serialized UCharsTrie.
 Iterator (const UCharsTrie &trie, int32_t maxStringLength, UErrorCode &errorCode)
 Iterates from the current state of the specified UCharsTrie.
 ~Iterator ()
 Destructor.
Iteratorreset ()
 Resets this iterator to its initial state.
UBool hasNext () const
UBool next (UErrorCode &errorCode)
 Finds the next (string, value) pair if there is one.
const UnicodeStringgetString () const
int32_t getValue () const

Detailed Description

Iterator for all of the (string, value) pairs in a UCharsTrie.

Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Definition at line 268 of file ucharstrie.h.


Constructor & Destructor Documentation

UCharsTrie::Iterator::Iterator ( const UChar trieUChars,
int32_t  maxStringLength,
UErrorCode errorCode 
)

Iterates from the root of a UChar-serialized UCharsTrie.

Parameters:
trieUCharsThe trie UChars.
maxStringLengthIf 0, the iterator returns full strings. Otherwise, the iterator returns strings with this maximum length.
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8
UCharsTrie::Iterator::Iterator ( const UCharsTrie trie,
int32_t  maxStringLength,
UErrorCode errorCode 
)

Iterates from the current state of the specified UCharsTrie.

Parameters:
trieThe trie whose state will be copied for iteration.
maxStringLengthIf 0, the iterator returns full strings. Otherwise, the iterator returns strings with this maximum length.
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Destructor.

Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Member Function Documentation

Returns:
The string for the last successful next().
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Definition at line 335 of file ucharstrie.h.

Returns:
The value for the last successful next().
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Definition at line 340 of file ucharstrie.h.

Returns:
TRUE if there are more elements.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Finds the next (string, value) pair if there is one.

If the string is truncated to the maximum length and does not have a real value, then the value is set to -1. In this case, this "not a real value" is indistinguishable from a real value of -1.

Parameters:
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
TRUE if there is another element.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Resets this iterator to its initial state.

Returns:
*this
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines