A2uiFormatNumberFunction

public final class A2uiFormatNumberFunction implements A2uiFunction

Formats a number with grouping and decimal precision.

Use this A2uiFunction to format numeric values for display.

Summary

Public fields
static final @NonNull A2uiFormatNumberFunction

Public constructors

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

Formats the given number using precision options in args.
@NonNull A2uiFunctionDefinition

The definition of the function.

Public fields

INSTANCE

public static final @NonNull A2uiFormatNumberFunction INSTANCE

Public constructors

A2uiFormatNumberFunction

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

Public methods

execute

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

Formats the given number using precision options in args.

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

arguments containing "value" (number) and optional decimal or grouping flags
@NonNull A2uiExecutionContext executionContext

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

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

getDefinition

public @NonNull A2uiFunctionDefinition getDefinition()

The definition of the function.