# A2uiFormatCurrencyFunction

Artifact: [androidx.a2ui:a2ui-model](https://developer.android.com/jetpack/androidx/releases/a2ui) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction.kt+class:androidx.a2ui.model.catalog.functions.A2uiFormatCurrencyFunction) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

*** ** * ** ***


```
public final class A2uiFormatCurrencyFunction implements A2uiFunction
```

<br />

*** ** * ** ***

Formats a number as a currency string.

Use this `https://developer.android.com/reference/androidx/a2ui/model/catalog/A2uiFunction` to display monetary values.

## Summary

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction` | `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#INSTANCE()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#A2uiFormatCurrencyFunction(androidx.a2ui.model.catalog.functions.A2uiLocaleProvider)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiLocaleProvider localeProvider)` |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/java/lang/Object.html` | `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Object.html> args, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/protocol/A2uiExecutionContext executionContext )` Formats the monetary number into a currency string based on `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/catalog/A2uiFunctionDefinition` | `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#getDefinition()()` The definition of the function. |

## Public fields

### INSTANCE

```
public static final @NonNull A2uiFormatCurrencyFunction INSTANCE
```

## Public constructors

### A2uiFormatCurrencyFunction

Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

```
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 `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Object.html> args` | arguments conforming of the schema within `https://developer.android.com/reference/androidx/a2ui/model/catalog/functions/A2uiFormatCurrencyFunction#definition()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/protocol/A2uiExecutionContext executionContext` | context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings |

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/Object.html` | the formatted currency string, or null if required values are missing |

### getDefinition

```
public @NonNull A2uiFunctionDefinition getDefinition()
```

The definition of the function.