ICU 75.1 75.1
|
The mutable Builder class allows each part of the MessageFormatter to be initialized separately; calling its build()
method yields an immutable MessageFormatter.
More...
#include <messageformat2.h>
Public Member Functions | |
Builder & | setLocale (const Locale &locale) |
Sets the locale to use for formatting. | |
Builder & | setPattern (const UnicodeString &pattern, UParseError &parseError, UErrorCode &status) |
Sets the pattern (contents of the message) and parses it into a data model. | |
Builder & | setFunctionRegistry (const MFFunctionRegistry &functionRegistry) |
Sets a custom function registry. | |
Builder & | setDataModel (MFDataModel &&dataModel) |
Sets a data model. | |
MessageFormatter | build (UErrorCode &status) const |
Constructs a new immutable MessageFormatter using the pattern or data model that was previously set, and the locale (if it was previously set) or default locale (otherwise). | |
Builder (UErrorCode &status) | |
Default constructor. | |
virtual | ~Builder () |
Destructor. | |
Public Member Functions inherited from icu::UObject | |
virtual | ~UObject () |
Destructor. | |
virtual UClassID | getDynamicClassID () const |
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. | |
Friends | |
class | MessageFormatter |
The mutable Builder class allows each part of the MessageFormatter to be initialized separately; calling its build()
method yields an immutable MessageFormatter.
Not copyable or movable.
Definition at line 148 of file messageformat2.h.
icu::message2::MessageFormatter::Builder::Builder | ( | UErrorCode & | status | ) |
Default constructor.
Returns a Builder with the default locale and with no data model or pattern set. Either setPattern()
or setDataModel()
has to be called before calling build()
.
status | Input/output error code. |
|
virtual |
Destructor.
MessageFormatter icu::message2::MessageFormatter::Builder::build | ( | UErrorCode & | status | ) | const |
Constructs a new immutable MessageFormatter using the pattern or data model that was previously set, and the locale (if it was previously set) or default locale (otherwise).
The builder object (this
) can still be used after calling build()
.
status | Input/output error code. If neither the pattern nor the data model is set, set to failure code. |
Builder & icu::message2::MessageFormatter::Builder::setDataModel | ( | MFDataModel && | dataModel | ) |
Sets a data model.
If a pattern was previously set, it is removed.
dataModel | Data model to format. Passed by move. |
Builder & icu::message2::MessageFormatter::Builder::setFunctionRegistry | ( | const MFFunctionRegistry & | functionRegistry | ) |
Sets a custom function registry.
functionRegistry | Reference to the function registry to use. functionRegistry is not copied, and the caller must ensure its lifetime contains the lifetime of the MessageFormatter object built by this builder. |
Sets the locale to use for formatting.
locale | The desired locale. |
Builder & icu::message2::MessageFormatter::Builder::setPattern | ( | const UnicodeString & | pattern, |
UParseError & | parseError, | ||
UErrorCode & | status | ||
) |
Sets the pattern (contents of the message) and parses it into a data model.
If a data model was previously set, it is removed.
pattern | A string in MessageFormat 2.0 syntax. |
parseError | Struct to receive information on the position of an error within the pattern. |
status | Input/output error code. If the pattern cannot be parsed, set to failure code. |
|
friend |
Definition at line 150 of file messageformat2.h.