A2uiFormatCurrencyFunction

public final class A2uiFormatCurrencyFunction implements A2uiFunction

Formats a number as a currency string.

Use this A2uiFunction to display monetary values.

Summary

Public fields
static final @NonNull A2uiFormatCurrencyFunction

Public constructors

Public methods
Object
execute(
    @NonNull Map<@NonNull String, @NonNull Object> args,
    @NonNull A2uiExecutionContext executionContext
)

Formats the monetary number into a currency string based on args.
@NonNull A2uiFunctionDefinition

The definition of the function.

Public fields

INSTANCE

public static final @NonNull A2uiFormatCurrencyFunction INSTANCE

Public constructors

A2uiFormatCurrencyFunction

Added in 1.0.0-alpha01
public A2uiFormatCurrencyFunction(@NonNull A2uiLocaleProvider localeProvider)

Public methods

execute

public Object execute(
    @NonNull Map<@NonNull String, @NonNull Object> args,
    @NonNull A2uiExecutionContext executionContext
)

Formats the monetary number into a currency string based on args.

Parameters
@NonNull Map<@NonNull String, @NonNull Object> args

arguments conforming of the schema within definition
@NonNull A2uiExecutionContext executionContext

context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings
Returns
Object

the formatted currency string, or null if required values are missing

getDefinition

public @NonNull A2uiFunctionDefinition getDefinition()

The definition of the function.