ICU 4.8.1.1  4.8.1.1
Data Structures | Public Member Functions
UCharsTrieBuilder Class Reference

Builder class for UCharsTrie. More...

#include <ucharstriebuilder.h>

Inheritance diagram for UCharsTrieBuilder:
StringTrieBuilder UObject UMemory

Data Structures

class  UCTLinearMatchNode

Public Member Functions

 UCharsTrieBuilder (UErrorCode &errorCode)
 Constructs an empty builder.
virtual ~UCharsTrieBuilder ()
 Destructor.
UCharsTrieBuilderadd (const UnicodeString &s, int32_t value, UErrorCode &errorCode)
 Adds a (string, value) pair.
UCharsTriebuild (UStringTrieBuildOption buildOption, UErrorCode &errorCode)
 Builds a UCharsTrie for the add()ed data.
UnicodeStringbuildUnicodeString (UStringTrieBuildOption buildOption, UnicodeString &result, UErrorCode &errorCode)
 Builds a UCharsTrie for the add()ed data and UChar-serializes it.
UCharsTrieBuilderclear ()
 Removes all (string, value) pairs.

Detailed Description

Builder class for UCharsTrie.

This class is not intended for public subclassing.

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

Definition at line 33 of file ucharstriebuilder.h.


Constructor & Destructor Documentation

Constructs an empty builder.

Parameters:
errorCodeStandard ICU error code.
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

UCharsTrieBuilder& UCharsTrieBuilder::add ( const UnicodeString s,
int32_t  value,
UErrorCode errorCode 
)

Adds a (string, value) pair.

The string must be unique. The string contents will be copied; the builder does not keep a reference to the input UnicodeString or its buffer.

Parameters:
sThe input string.
valueThe value associated with this string.
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:
*this
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8
UCharsTrie* UCharsTrieBuilder::build ( UStringTrieBuildOption  buildOption,
UErrorCode errorCode 
)

Builds a UCharsTrie for the add()ed data.

Once built, no further data can be add()ed until clear() is called.

This method passes ownership of the builder's internal result array to the new trie object. Another call to any build() variant will re-serialize the trie. After clear() has been called, a new array will be used as well.

Parameters:
buildOptionBuild option, see UStringTrieBuildOption.
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:
A new UCharsTrie for the add()ed data.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8
UnicodeString& UCharsTrieBuilder::buildUnicodeString ( UStringTrieBuildOption  buildOption,
UnicodeString result,
UErrorCode errorCode 
)

Builds a UCharsTrie for the add()ed data and UChar-serializes it.

Once built, no further data can be add()ed until clear() is called.

Multiple calls to buildUnicodeString() set the UnicodeStrings to the builder's same UChar array, without rebuilding. If buildUnicodeString() is called after build(), the trie will be re-serialized into a new array. If build() is called after buildUnicodeString(), the trie object will become the owner of the previously returned array. After clear() has been called, a new array will be used as well.

Parameters:
buildOptionBuild option, see UStringTrieBuildOption.
resultA UnicodeString which will be set to the UChar-serialized UCharsTrie for the add()ed data.
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:
result
Draft:
This API may be changed in the future versions and was introduced in ICU 4.8

Removes all (string, value) pairs.

New data can then be add()ed and a new trie can be built.

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

Definition at line 111 of file ucharstriebuilder.h.


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