icu::message2::FunctionOptions Class Reference

Structure encapsulating named options passed to a custom selector or formatter. More...

#include <messageformat2_formattable.h>

Inheritance diagram for icu::message2::FunctionOptions:

Public Member Functions
FunctionOptionsMap	getOptions () const
	Returns a map of all name-value pairs provided as options to this function.
FunctionOptions	mergeOptions (const FunctionOptions &other, UErrorCode &) const
	Returns a new FunctionOptions object containing all the key-value pairs from this and other.
	FunctionOptions ()
	Default constructor.
virtual	~FunctionOptions ()
	Destructor.
FunctionOptions &	operator= (FunctionOptions) noexcept
	Assignment operator.
	FunctionOptions (const FunctionOptions &)
	Copy constructor.
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
class	StandardFunctions
void	swap (FunctionOptions &f1, FunctionOptions &f2) noexcept
	Non-member swap function.

Detailed Description

Structure encapsulating named options passed to a custom selector or formatter.

This class is immutable, movable and copyable.

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

Definition at line 491 of file messageformat2_formattable.h.

Constructor & Destructor Documentation

FunctionOptions() [1/2]

icu::message2::FunctionOptions::FunctionOptions ( )

inline

Default constructor.

Returns an empty mapping.

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

Definition at line 530 of file messageformat2_formattable.h.

Referenced by FunctionOptions(), mergeOptions(), operator=(), and swap.

~FunctionOptions()

virtual icu::message2::FunctionOptions::~FunctionOptions ( )

virtual

Destructor.

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

FunctionOptions() [2/2]

icu::message2::FunctionOptions::FunctionOptions

(

const FunctionOptions &

)

Copy constructor.

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

References FunctionOptions().

Member Function Documentation

getOptions()

FunctionOptionsMap icu::message2::FunctionOptions::getOptions ( ) const

inline

Returns a map of all name-value pairs provided as options to this function.

The syntactic order of options is not guaranteed to be preserved.

Returns

A map from strings to FunctionValue objects representing the results of resolving each option value.

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

Definition at line 504 of file messageformat2_formattable.h.

mergeOptions()

FunctionOptions icu::message2::FunctionOptions::mergeOptions	(	const FunctionOptions &	other,
		UErrorCode &	) const

Returns a new FunctionOptions object containing all the key-value pairs from this and other.

When this and other define options with the same name, this takes preference.

Returns

The result of merging this and other.

Internal

Do not use. This API is for internal use only. ICU 79 technology preview

Deprecated

This API is for technology preview only.

References FunctionOptions().

operator=()

FunctionOptions & icu::message2::FunctionOptions::operator= ( FunctionOptions )

noexcept

Assignment operator.

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

References FunctionOptions().

Friends And Related Symbol Documentation

MessageFormatter

friend class MessageFormatter

friend

Definition at line 571 of file messageformat2_formattable.h.

StandardFunctions

friend class StandardFunctions

friend

Definition at line 572 of file messageformat2_formattable.h.

swap

void swap ( FunctionOptions & f1, FunctionOptions & f2 )

friend

Non-member swap function.

Parameters

f1	will get f2's contents
f2	will get f1's contents

Internal

Do not use. This API is for internal use only. ICU 75 technology preview

Deprecated

This API is for technology preview only.

Definition at line 546 of file messageformat2_formattable.h.

References FunctionOptions(), and swap.

Referenced by swap.

---

The documentation for this class was generated from the following file:

• i18n/unicode/messageformat2_formattable.h