A2uiPluralizeFunction


public final class A2uiPluralizeFunction implements A2uiFunction


Chooses a plural string form based on a numeric value.

Use this A2uiFunction to get localized plural categories.

Summary

Public constructors

A2uiPluralizeFunction(
    @NonNull A2uiMessageFormatter messageFormatter,
    @NonNull A2uiLocaleProvider localeProvider
)

Public methods

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

Returns the matching plural form based on count in args.

@NonNull A2uiFunctionDefinition

The definition of the function.

Public constructors

A2uiPluralizeFunction

Added in 1.0.0-alpha01
public A2uiPluralizeFunction(
    @NonNull A2uiMessageFormatter messageFormatter,
    @NonNull A2uiLocaleProvider localeProvider
)

Public methods

execute

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

Returns the matching plural form based on count in args.

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

arguments containing the count "value" and plural form strings

@NonNull A2uiExecutionContext executionContext

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

Returns
Object

the selected plural form, or null if count or default fallback is missing

getDefinition

public @NonNull A2uiFunctionDefinition getDefinition()

The definition of the function.