Java Money

https://javamoney.github.io/
Admin
This project provides documentation for the Java Money API, a comprehensive framework for handling...
Tokens:138,777
Snippets:1,399
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### CurrencyQueryBuilder.of()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencyQueryBuilder.html

Creates a new instance of CurrencyQueryBuilder. This is the starting point for building currency queries.

```APIDOC
## Method: of

### Description
Creates a new instance of `CurrencyQueryBuilder`.

### Method Signature
`public static CurrencyQueryBuilder of()`

### Returns
A new `CurrencyQueryBuilder` instance, never null.
```

--------------------------------

### MonetaryAmountsSingletonSpi.getAmountFactories()

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the currently registered MonetaryAmount implementation classes.

```APIDOC
## getAmountFactories()

### Description
Get the currently registered `MonetaryAmount` implementation classes.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### MonetaryAmountsSingletonQuerySpi.getAmountFactories()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/MonetaryAmountFactoryQuery.html

Get the MonetaryAmountFactory implementation class, that best matches to cover the given MonetaryContext.

```APIDOC
## MonetaryAmountsSingletonQuerySpi.getAmountFactories()

### Description
Get the `MonetaryAmountFactory` implementation class, that best matches to cover the given `MonetaryContext`.

### Method
(Not specified, likely a method on an SPI implementation)

### Endpoint
(Not applicable, this is an SDK method)

### Parameters
- **query** (MonetaryAmountFactoryQuery) - The query to match the `MonetaryContext`.

### Request Example
(Not applicable)

### Response
#### Success Response
- **Collection<MonetaryAmountFactory<? extends MonetaryAmount>>** - A collection of matching `MonetaryAmountFactory` implementations.
```

--------------------------------

### MonetaryAmountsSingletonQuerySpi.getAmountFactories(MonetaryAmountFactoryQuery)

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the MonetaryAmountFactory implementation class that best matches the given MonetaryContext.

```APIDOC
## getAmountFactories(MonetaryAmountFactoryQuery)

### Description
Get the `MonetaryAmountFactory` implementation class, that best matches to cover the given `MonetaryContext`.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Get Default Fraction Digits

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the number of fractional digits typically used by a currency.

```APIDOC
## getDefaultFractionDigits()

### Description
Gets the number of fractional digits typically used by this currency.

### Method
Method in interface javax.money.CurrencyUnit

### Response
#### Success Response (200)
- **int** - The default number of fractional digits.
```

--------------------------------

### AmountFormatQuery Creation and Initialization

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/class-use/AmountFormatQuery.html

Demonstrates how to create new AmountFormatQuery instances or initialize builders with existing queries.

```APIDOC
## AmountFormatQueryBuilder.build()

### Description
Creates a new `AmountFormatQuery` instance from the builder's current state.

### Method
`build()`

### Returns
A new `AmountFormatQuery` instance.
```

```APIDOC
## AmountFormatQuery.of(Locale locale, String... providers)

### Description
Creates a simple format query based on a single Locale and optional provider names.

### Method
`static AmountFormatQuery of(java.util.Locale locale, java.lang.String... providers)`

### Parameters
#### Path Parameters
- **locale** (java.util.Locale) - Required - The locale to base the query on.
- **providers** (java.lang.String...) - Optional - The names of the providers to include.

### Returns
A new `AmountFormatQuery` instance.
```

```APIDOC
## AmountFormatQueryBuilder.of(AmountFormatQuery formatQuery)

### Description
Creates a new `AmountFormatQueryBuilder` and initializes it with the values from the given `AmountFormatQuery`.

### Method
`static AmountFormatQueryBuilder of(AmountFormatQuery formatQuery)`

### Parameters
#### Path Parameters
- **formatQuery** (AmountFormatQuery) - Required - The `AmountFormatQuery` to initialize the builder with.

### Returns
A new `AmountFormatQueryBuilder` instance.
```

--------------------------------

### Get Default Rounding

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the default rounding mechanism, which dynamically delegates rounding based on the current currency.

```APIDOC
## getDefaultRounding()

### Description
Get the default rounding, which delegates rounding dynamically depending on the current currency.

### Method
Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi

### Response
#### Success Response (200)
- **MonetaryRounding** - The default rounding object.
```

--------------------------------

### Static Factory Method Example

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryAmount.html

Illustrates the recommended static 'from' method for converting a MonetaryAmount to a concrete implementation instance, promoting interoperability.

```java
public final class MyMoney implements MonetaryAmount{
  ...
  public static MyMoney from(MonetaryAmount amount)(...)
}
```

--------------------------------

### Get ExchangeRate using CurrencyUnit

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ExchangeRateProvider.html

Accesses an ExchangeRate between a base and term CurrencyUnit. This is a default method providing a convenient way to get exchange rates.

```java
default ExchangeRate getExchangeRate(CurrencyUnit base, CurrencyUnit term)
```

--------------------------------

### Using MonetaryQuery

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryQuery.html

Demonstrates the two equivalent ways to use a MonetaryQuery. The second approach, using MonetaryAmount.query(MonetaryQuery), is recommended for better readability.

```java
// these two lines are equivalent, but the second approach is recommended
 monetary = thisQuery.queryFrom(monetary);
 // Recommended approach
 monetary = monetary.query(thisQuery);
 
```

--------------------------------

### Bootstrap

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/package-summary.html

This singleton provides access to the services available in the current runtime environment and context.

```APIDOC
## Bootstrap

### Description
This singleton provides access to the services available in the current runtime environment and context.

### Class
`Bootstrap`
```

--------------------------------

### Get Default MonetaryAmountFactory

Source: https://javamoney.github.io/apidocs/java.money/javax/money/Monetary.html

Accesses the default MonetaryAmountFactory as defined by the system's SPI configuration. This provides a convenient way to get a commonly used factory.

```java
MonetaryAmountFactory<?> defaultAmountFactory = Monetary.getDefaultAmountFactory();
```

--------------------------------

### Creating a MonetaryContextBuilder

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/MonetaryContextBuilder.html

Demonstrates the different ways to create a new MonetaryContextBuilder instance.

```APIDOC
## Static Factory Methods for MonetaryContextBuilder

### Description
These static methods provide entry points for creating new `MonetaryContextBuilder` instances.

### Methods

#### `MonetaryContextBuilder.of()`
Creates a new builder, hereby the target implementation type is required.

#### `MonetaryContextBuilder.of(java.lang.Class<? extends MonetaryAmount> amountType)`
Creates a new builder, hereby the target implementation type is required.

#### `MonetaryContextBuilder.of(MonetaryContext monetaryContext)`
Creates a new builder, using an existing `MonetaryContext` as a template.
```

--------------------------------

### Get Provider Name Method

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ExchangeRateProviderSupplier.html

This method returns the provider name. Its signature is identical to java.util.function.Supplier's get() method in Java 8. The returned name must not be null.

```java
java.lang.String get()
```

--------------------------------

### getLocale() - AmountFormatQuery

Source: https://javamoney.github.io/apidocs/index-all.html

Gets a Locale to be applied.

```APIDOC
## getLocale()

### Description
Gets a Locale to be applied.

### Method
Instance method

### Endpoint
N/A (Class method)

### Parameters
None

### Response
- `Locale`: The locale to be applied.
```

--------------------------------

### CurrencyProviderSpi

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/package-summary.html

SPI (core) to be registered using the `Bootstrap`, which allows to register/provide additional currencies into the system automatically on startup.

```APIDOC
## CurrencyProviderSpi

### Description
SPI (core) to be registered using the `Bootstrap`, which allows to register/provide additional currencies into the system automatically on startup.

### Interface
`CurrencyProviderSpi`
```

--------------------------------

### CurrencyQuery Creation

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/CurrencyQuery.html

Demonstrates how to create a CurrencyQuery instance using CurrencyQueryBuilder.

```APIDOC
## CurrencyQueryBuilder.build()

### Description
Creates a new instance of `CurrencyQuery`.

### Method
[Method Signature]

### Parameters
None

### Response
#### Success Response
- **CurrencyQuery** - A new instance of `CurrencyQuery`.

### Response Example
```java
CurrencyQuery query = CurrencyQueryBuilder.of(existingQuery).build();
```

## CurrencyQueryBuilder.of(CurrencyQuery)

### Description
Creates a new instance of `CurrencyQueryBuilder` initialized with the given `CurrencyQuery`.

### Method
[Method Signature]

### Parameters
#### Path Parameters
- **currencyQuery** (CurrencyQuery) - Required - The `CurrencyQuery` to initialize the builder with.

### Response
#### Success Response
- **CurrencyQueryBuilder** - A new instance of `CurrencyQueryBuilder`.

### Response Example
```java
CurrencyQueryBuilder builder = CurrencyQueryBuilder.of(existingQuery);
```
```

--------------------------------

### MonetaryContext.getAmountType()

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the MonetaryAmount implementation class.

```APIDOC
## getAmountType()

### Description
Get the MonetaryAmount implementation class.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### getType(String)

Source: https://javamoney.github.io/apidocs/index-all.html

Get the current attribute type.

```APIDOC
## getType(String)

### Description
Get the current attribute type.

### Method
Method call (class: javax.money.AbstractContext)

### Parameters
* **key** (String) - Required - The key of the attribute whose type to get.
```

--------------------------------

### Creating a Builder from an Existing Context

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/MonetaryContextBuilder.html

Shows how to create a new builder initialized with the data from an existing MonetaryContext.

```APIDOC
## Creating a Builder from an Existing MonetaryContext

### Description
This method allows you to obtain a `MonetaryContextBuilder` pre-populated with the configuration of an existing `MonetaryContext`.

### Method

#### `MonetaryContext.toBuilder()`
Creates a new builder instances, initialized with the data from this one.
```

--------------------------------

### getTermCurrency()

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the second currency at fault in a CurrencyConversionException.

```APIDOC
## getTermCurrency()

### Description
Gets the second currency at fault.

### Method
Method call (exception: javax.money.convert.CurrencyConversionException)
```

--------------------------------

### Creating a RoundingQueryBuilder

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/RoundingQueryBuilder.html

Demonstrates how to create a new RoundingQueryBuilder instance using static factory methods.

```APIDOC
## RoundingQueryBuilder

### Description
Provides static factory methods to create new instances of RoundingQueryBuilder.

### Methods
#### `static RoundingQueryBuilder of()`
Creates a new, empty RoundingQueryBuilder.

#### `static RoundingQueryBuilder of(RoundingQuery roundingQuery)`
Creates a new RoundingQueryBuilder initialized with the data from the provided RoundingQuery.
```

--------------------------------

### getTargetType()

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the target implementation type required.

```APIDOC
## getTargetType()

### Description
Gets the target implementation type required.

### Method
Method call (class: javax.money.AbstractQuery)
```

--------------------------------

### AmountFormatQueryBuilder Configuration Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/class-use/AmountFormatQueryBuilder.html

Instance methods to configure the AmountFormatQueryBuilder.

```APIDOC
## AmountFormatQueryBuilder.setFormatName(String formatName)

### Description
Sets a style's id for the query.

### Method
`AmountFormatQueryBuilder`

### Parameters
#### Path Parameters
- **formatName** (java.lang.String) - Required - The format style id to set.
```

```APIDOC
## AmountFormatQueryBuilder.setLocale(Locale locale)

### Description
Sets a Locale to be applied to the formatter.

### Method
`AmountFormatQueryBuilder`

### Parameters
#### Path Parameters
- **locale** (java.util.Locale) - Required - The locale to set.
```

```APIDOC
## AmountFormatQueryBuilder.setMonetaryAmountFactory(MonetaryAmountFactory<?> monetaryFactory)

### Description
Sets the `MonetaryAmountFactory` to be used to create amounts during parsing.

### Method
`AmountFormatQueryBuilder`

### Parameters
#### Path Parameters
- **monetaryFactory** (MonetaryAmountFactory<?>) - Required - The `MonetaryAmountFactory` to set.
```

```APIDOC
## AmountFormatQueryBuilder.setMonetaryQuery(MonetaryAmountFactoryQuery monetaryQuery)

### Description
Sets the `MonetaryContext` to be used when amounts are parsed.

### Method
`AmountFormatQueryBuilder`

### Parameters
#### Path Parameters
- **monetaryQuery** (MonetaryAmountFactoryQuery) - Required - The `MonetaryContext` query to set.
```

--------------------------------

### getServices

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/ServiceProvider.html

Access a list of services, given its type. The bootstrap mechanism should order the instance for precedence, hereby the most significant should be first in order. If no such services are found, an empty list should be returned.

```APIDOC
## getServices

### Description
Access a list of services, given its type. The bootstrap mechanism should order the instance for precedence, hereby the most significant should be first in order. If no such services are found, an empty list should be returned.

### Method
<T> java.util.List<T>

### Parameters
#### Path Parameters
* **serviceType** (java.lang.Class<T>) - Required - the service type.

### Returns
The instance to be used, never `null`
```

--------------------------------

### ProviderContext Methods

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the deferred flag from a ProviderContext.

```APIDOC
## getRateTypes()

### Description
Get the deferred flag.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A
```

--------------------------------

### getFormatName() - AmountFormatQuery

Source: https://javamoney.github.io/apidocs/index-all.html

Gets a style's id.

```APIDOC
## getFormatName()

### Description
Gets a style's id.

### Method
Instance method

### Endpoint
N/A (Class method)

### Parameters
None

### Response
- `String`: The style's id.
```

--------------------------------

### Create MonetaryAmountFactoryQueryBuilder

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryAmountFactoryQueryBuilder.html

Creates a new instance of MonetaryAmountFactoryQueryBuilder. This is the entry point for building a query.

```java
public static MonetaryAmountFactoryQueryBuilder of()
```

--------------------------------

### getDefaultProviderChain

Source: https://javamoney.github.io/apidocs/java.money/javax/money/DefaultMonetaryRoundingsSingletonSpi.html

Get the default providers list to be used.

```APIDOC
## getDefaultProviderChain()

### Description
Get the default providers list to be used.

### Method
`public java.util.List<java.lang.String> getDefaultProviderChain()`

### Returns
The default provider list and ordering, not null.

### See Also
`RoundingQueryBuilder`
```

--------------------------------

### CurrencyQueryBuilder.of(CurrencyQuery)

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencyQueryBuilder.html

Creates a new instance of CurrencyQueryBuilder, initializing it with an existing CurrencyQuery.

```APIDOC
## Method: of

### Description
Creates a new instance of `CurrencyQueryBuilder`.

### Parameters
#### Path Parameters
* **currencyQuery** (CurrencyQuery) - The `CurrencyQuery` used for initializing this builder.

### Method Signature
`public static CurrencyQueryBuilder of(CurrencyQuery currencyQuery)`

### Returns
A new `CurrencyQueryBuilder` instance, never null.
```

--------------------------------

### getProviderNames

Source: https://javamoney.github.io/apidocs/java.money/javax/money/DefaultMonetaryRoundingsSingletonSpi.html

Get the names of all current registered providers.

```APIDOC
## getProviderNames()

### Description
Get the names of all current registered providers.

### Method
`public java.util.Set<java.lang.String> getProviderNames()`

### Returns
The names of all current registered providers, never null.
```

--------------------------------

### Convert CurrencyContext to Builder

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencyContext.html

Demonstrates how to convert an existing CurrencyContext instance into a CurrencyContextBuilder for modification.

```java
public CurrencyContextBuilder toBuilder()
```

--------------------------------

### AbstractQueryBuilder Constructor

Source: https://javamoney.github.io/apidocs/java.money/javax/money/AbstractQueryBuilder.html

Initializes the query builder with default settings.

```APIDOC
## Constructor AbstractQueryBuilder

### Description
Initializes the query builder, as a default query builder.

### Method
`public AbstractQueryBuilder()`
```

--------------------------------

### ConversionQuery Methods

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the rate types set from a ConversionQuery.

```APIDOC
## getRateTypes()

### Description
Get the rate types set.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A
```

--------------------------------

### Configuring Rounding with RoundingQueryBuilder

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/RoundingQueryBuilder.html

Illustrates how to configure a RoundingQueryBuilder by setting currency, rounding name, and scale.

```APIDOC
## RoundingQueryBuilder Configuration

### Description
Methods to configure the target currency, rounding name, and scale for a rounding query.

### Methods
#### `RoundingQueryBuilder setCurrency(CurrencyUnit currencyUnit)`
Sets the target `CurrencyUnit`, which defines a rounding targeting a concrete `CurrencyUnit`.

#### `RoundingQueryBuilder setRoundingName(java.lang.String roundingName)`
Sets the rounding names of the `MonetaryRounding` instances.

#### `RoundingQueryBuilder setScale(int scale)`
Sets the target scale.
```

--------------------------------

### CurrencySupplier Methods

Source: https://javamoney.github.io/apidocs/index-all.html

Provides methods to get the corresponding CurrencyUnit.

```APIDOC
## getCurrency

### Description
Gets the corresponding `CurrencyUnit`.

### Method
`getCurrency()`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- `CurrencyUnit` - The corresponding currency unit.

#### Response Example
None
```

--------------------------------

### MonetaryContextBuilder.build()

Source: https://javamoney.github.io/apidocs/index-all.html

Creates a new instance of MonetaryAmountFactoryQuery.

```APIDOC
## MonetaryContextBuilder.build()

### Description
Creates a new instance of `MonetaryAmountFactoryQuery`.

### Method
N/A (Class Method)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **MonetaryAmountFactoryQuery** - A new MonetaryAmountFactoryQuery instance.
```

--------------------------------

### getScale()

Source: https://javamoney.github.io/apidocs/index-all.html

Returns the scale of this MonetaryAmount or gets the target scale from a RoundingQuery.

```APIDOC
## getScale()

### Description
Returns the _scale_ of this `MonetaryAmount`. Also used in `RoundingQuery` to get the target scale.

### Method
Method call (class: javax.money.NumberValue, javax.money.RoundingQuery)
```

--------------------------------

### Bootstrap.init

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/Bootstrap.html

Replaces the current ServiceProvider in use. This method should be called before accessing any monetary services if a custom provider is needed.

```APIDOC
## Bootstrap.init

### Description
Replaces the current `ServiceProvider` in use. This method should be called before accessing any monetary services if a custom provider is needed.

### Method
`static ServiceProvider init(ServiceProvider serviceProvider)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `serviceProvider` (ServiceProvider) - The new `ServiceProvider` to use.

### Returns
* `ServiceProvider` - The previously removed `ServiceProvider`, or `null` if none was set.

### See Also
None
```

--------------------------------

### AmountFormatQueryBuilder.build()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/AmountFormatQueryBuilder.html

Creates a new AmountFormatQuery instance based on the current builder configuration.

```APIDOC
## AmountFormatQueryBuilder.build()

### Description
Creates a new AmountFormatQuery instance.

### Method
AmountFormatQuery

### Response
#### Success Response
- **AmountFormatQuery** - A new AmountFormatQuery instance, never null.
```

--------------------------------

### DefaultMonetaryRoundingsSingletonSpi Methods

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the names of all currently registered providers from DefaultMonetaryRoundingsSingletonSpi.

```APIDOC
## getProviderNames()

### Description
Get the names of all current registered providers.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A
```

--------------------------------

### build

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ConversionQueryBuilder.html

Creates a new instance of ConversionQuery.

```APIDOC
## Method build

```java
public ConversionQuery build()
```

Creates a new instance of `ConversionQuery`.

Specified by:
`build` in class `AbstractQueryBuilder<ConversionQueryBuilder, ConversionQuery>`

Returns:
a new `ConversionQuery` instance.
```

--------------------------------

### getFormatProviderNames() - MonetaryFormats

Source: https://javamoney.github.io/apidocs/index-all.html

Get the names of the currently registered format providers.

```APIDOC
## getFormatProviderNames()

### Description
Get the names of the currently registered format providers.

### Method
Static

### Endpoint
N/A (Static method)

### Parameters
None

### Response
- `Set<String>`: A set of format provider names.
```

--------------------------------

### getAvailableLocales(String...)

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/MonetaryFormats.html

Get all available locales. This equals to MonetaryAmountFormatProviderSpi.getAvailableLocales().

```APIDOC
## getAvailableLocales(String...)

### Description
Get all available locales. This equals to `MonetaryAmountFormatProviderSpi.getAvailableLocales()`.

### Method
public static java.util.Set<java.util.Locale> getAvailableLocales(java.lang.String... providers)

### Parameters
#### Path Parameters
- **providers** (java.lang.String...) - Optional - The providers to be used, if not set the providers as defined by #getDefaultCurrencyProviderChain() are used.

### Returns
- java.util.Set<java.util.Locale> - all available locales, never `null`.
```

--------------------------------

### AmountFormatContextBuilder.create()

Source: https://javamoney.github.io/apidocs/index-all.html

Creates a new `AmountFormatContextBuilder`. This is a static factory method for initializing the builder.

```APIDOC
## Static Method create(AmountFormatQuery)

### Description
Creates a new `AmountFormatContextBuilder`.

### Method Signature
`create(AmountFormatQuery)`

### Class
`javax.money.format.AmountFormatContextBuilder`
```

--------------------------------

### getDefaultConversionProviderChain()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/MonetaryConversions.html

Get the default provider chain used for currency conversions.

```APIDOC
## getDefaultConversionProviderChain()

### Description
Get the default provider used.

### Method
static

### Response
#### Success Response
- **List<String>** - The default provider chain.
```

--------------------------------

### getCurrency

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ExchangeRate.html

Get the term (target) CurrencyUnit. This is the currency to which the exchange is being made.

```APIDOC
## getCurrency

### Description
Get the term (target) `CurrencyUnit`.

### Method Signature
`CurrencyUnit getCurrency()`

### Returns
the term `CurrencyUnit`.
```

--------------------------------

### AmountFormatContextBuilder Configuration Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/class-use/AmountFormatContextBuilder.html

Instance methods to configure the properties of an AmountFormatContextBuilder.

```APIDOC
## AmountFormatContextBuilder.setFormatName(String formatName)

### Description
Sets a format's name.

### Method
instance

### Parameters
#### Path Parameters
- **formatName** (String) - Required - The name of the format.

### Response
#### Success Response (200)
- **AmountFormatContextBuilder** - The current builder instance for chaining.

## AmountFormatContextBuilder.setLocale(Locale locale)

### Description
Sets a Locale to be applied.

### Method
instance

### Parameters
#### Path Parameters
- **locale** (Locale) - Required - The locale to set.

### Response
#### Success Response (200)
- **AmountFormatContextBuilder** - The current builder instance for chaining.

## AmountFormatContextBuilder.setMonetaryAmountFactory(MonetaryAmountFactory monetaryAmountBuilder)

### Description
Sets the `MonetaryContext` to be used, when amount's are parsed.

### Method
instance

### Parameters
#### Path Parameters
- **monetaryAmountBuilder** (MonetaryAmountFactory) - Required - The factory to use for creating monetary amounts.

### Response
#### Success Response (200)
- **AmountFormatContextBuilder** - The current builder instance for chaining.

## AmountFormatContext.toBuilder()

### Description
Creates a new builder instances, initialized with the data from this one.

### Method
instance

### Response
#### Success Response (200)
- **AmountFormatContextBuilder** - A new builder instance initialized with the current context's data.
```

--------------------------------

### build()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/AbstractContextBuilder.html

Creates a new AbstractContext instance with the data accumulated in this builder.

```APIDOC
## Method: build()

### Description
Creates a new `AbstractContext` with the data from this Builder instance.

### Returns
- **C** - A new `AbstractContext`. never `null`.

### Code
```java
public abstract C build()
```
```

--------------------------------

### getBaseCurrency

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ExchangeRate.html

Get the base (source) CurrencyUnit. This is the currency from which the exchange is being made.

```APIDOC
## getBaseCurrency

### Description
Get the base (source) `CurrencyUnit`.

### Method Signature
`CurrencyUnit getBaseCurrency()`

### Returns
the base `CurrencyUnit`.
```

--------------------------------

### CurrencyQueryBuilder.build()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencyQueryBuilder.html

Creates a new instance of CurrencyQuery based on the builder's configuration.

```APIDOC
## Method: build

### Description
Creates a new instance of `CurrencyQuery`.

### Method Signature
`public CurrencyQuery build()`

### Returns
A new `CurrencyQuery` instance, never null.
```

--------------------------------

### getRoundingName()

Source: https://javamoney.github.io/apidocs/index-all.html

Get the (custom) rounding id. This method is available on RoundingContext and RoundingQuery.

```APIDOC
## getRoundingName()

### Description
Get the (custom) rounding id. This method is available on `RoundingContext` to get the rounding id, and on `RoundingQuery` to get the target rounding name.

### Method
Method call (class: javax.money.RoundingContext, javax.money.RoundingQuery)
```

--------------------------------

### MonetaryConversionsSingletonSpi Methods

Source: https://javamoney.github.io/apidocs/index-all.html

Gets all currently registered provider names for monetary conversions.

```APIDOC
## getProviderNames()

### Description
Get all currently registered provider names.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A
```

--------------------------------

### ConversionContext to Builder

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/class-use/ConversionContextBuilder.html

Shows how to obtain a ConversionContextBuilder from an existing ConversionContext instance.

```APIDOC
## ConversionContext to Builder

### Description
Method to obtain a builder from an existing `ConversionContext`.

### Methods

#### `ConversionContext toBuilder()`
* **Description**: Creates a conversion query builder with the context data from this context instance.
* **Returns**: A new `ConversionContextBuilder` instance initialized with the current context's data.
```

--------------------------------

### Get Default Amount Type

Source: https://javamoney.github.io/apidocs/index-all.html

Retrieves the default MonetaryAmount implementation class.

```APIDOC
## getDefaultAmountType()

### Description
Access the default `MonetaryAmount` implementation class that is accessible from this `MonetaryAmount` singleton.

### Method
Static method or Interface method

### Response
#### Success Response (200)
- **Class<? extends MonetaryAmount>** - The default amount type class.
```

--------------------------------

### Bootstrap.getServices

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/Bootstrap.html

Retrieves a collection of all services of the specified type available in the current runtime environment.

```APIDOC
## Bootstrap.getServices

### Description
Retrieves a collection of all services of the specified type available in the current runtime environment. This is a delegate method for `ServiceProvider.getServices(Class)`.

### Method
`static <T> Collection<T> getServices(Class<T> serviceType)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `serviceType` (Class<T>) - The type of the services to retrieve.

### Returns
* `Collection<T>` - A collection of services of the specified type found in the runtime environment.

### See Also
* `ServiceProvider.getServices(Class)`
```

--------------------------------

### Creating Rounding Instance with Default Rounding

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/RoundingQueryBuilder.html

Shows how to obtain a RoundingQueryBuilder pre-configured with `RoundingMode.UP`.

```APIDOC
## DefaultMonetaryRoundingsSingletonSpi

### Description
Provides access to default rounding configurations.

### Methods
#### `RoundingQueryBuilder createRoundingQueryBuilder()`
Creates an rounding instance using `RoundingMode.UP` rounding.
```

--------------------------------

### Get Default Amount Factory

Source: https://javamoney.github.io/apidocs/index-all.html

Accesses the default MonetaryAmountFactory, as defined by the MonetaryAmountsSingletonSpi.

```APIDOC
## getDefaultAmountFactory()

### Description
Access the default `MonetaryAmountFactory` as defined by `MonetaryAmountsSingletonSpi.getDefaultAmountFactory()`.

### Method
Static method or Interface method

### Response
#### Success Response (200)
- **MonetaryAmountFactory** - The default amount factory.
```

--------------------------------

### Get Currency Provider Names

Source: https://javamoney.github.io/apidocs/index-all.html

Queries for the names of all available currency providers.

```APIDOC
## getCurrencyProviderNames()

### Description
Query all currencies matching the given query. This method seems to be mislabeled in the source and likely intended to query provider names.

### Method
Static method in class javax.money.Monetary

### Response
#### Success Response (200)
- **List<String>** - A list of currency provider names.
```

--------------------------------

### Applying Currency Conversion to MonetaryAmount

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/CurrencyConversion.html

Demonstrates how to apply a CurrencyConversion to a MonetaryAmount using the with() method. Ensure the conversion is obtained using MonetaryConversions.getConversion().

```java
MonetaryAmount amount = ...;
CurrencyConversion conversion = MonetaryConversions.getConversion("CHF");
MonetaryAmount amountInCHF = amount.with(conversion);
```

--------------------------------

### MonetaryAmountFactoryProviderSpi.getAmountType()

Source: https://javamoney.github.io/apidocs/index-all.html

Gets the concrete amount type created by MonetaryAmountFactory instances provided.

```APIDOC
## getAmountType()

### Description
Get the concrete amount type created by `MonetaryAmountFactory` instances provided.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### ConversionContextBuilder Creation

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/class-use/ConversionContextBuilder.html

Demonstrates how to create new instances of ConversionContextBuilder using static factory methods. These methods allow for creating a builder from scratch or initializing it with existing ConversionContext values.

```APIDOC
## ConversionContextBuilder Creation

### Description
Methods for creating new `ConversionContextBuilder` instances.

### Methods

#### `static ConversionContextBuilder create(ProviderContext context, RateType rateType)`
* **Description**: Creates a new Builder, hereby using the given `ConversionContext`'s values as defaults.
* **Parameters**:
  * `context` (ProviderContext) - The context to use for defaults.
  * `rateType` (RateType) - The rate type to set.

#### `static ConversionContextBuilder of()`
* **Description**: Creates a new `ConversionContextBuilder` instance.

#### `static ConversionContextBuilder of(ConversionContext conversionContext)`
* **Description**: Creates a new `ConversionContextBuilder` instance, initialized with the provided `ConversionContext`.
* **Parameters**:
  * `conversionContext` (ConversionContext) - The `ConversionContext` to initialize the builder with.
```

--------------------------------

### getProviderName

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/RoundingProviderSpi.html

Gets the unique name of this rounding provider. The returned name will not be null.

```APIDOC
## getProviderName

### Description
Get the provider's unique name.

### Method
default java.lang.String

### Response
#### Success Response
- `java.lang.String` - The provider's unique name, not `null`.
```

--------------------------------

### AmountFormatContextBuilder.build()

Source: https://javamoney.github.io/apidocs/index-all.html

Creates a new instance of AmountFormatContext that configures a .MonetaryAmountFormat.

```APIDOC
## AmountFormatContextBuilder.build()

### Description
Creates a new instance of `AmountFormatContext` that configures a `.MonetaryAmountFormat`.

### Method
N/A (Class Method)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **AmountFormatContext** - A new AmountFormatContext instance.
```

--------------------------------

### getCurrency()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencySupplier.html

Gets the corresponding CurrencyUnit. This method is the functional method of the CurrencySupplier interface.

```APIDOC
## getCurrency()

### Description
Gets the corresponding `CurrencyUnit`. This method is the functional method of the `CurrencySupplier` interface.

### Method
`CurrencyUnit getCurrency()`

### Returns
- `CurrencyUnit` - the corresponding `CurrencyUnit`, not null.
```

--------------------------------

### AmountFormatQueryBuilder.of()

Source: https://javamoney.github.io/apidocs/index-all.html

Provides static factory methods for creating AmountFormatQueryBuilder instances. These methods allow for building amount format queries, with options to initialize from locale defaults or an existing AmountFormatQuery.

```APIDOC
## AmountFormatQueryBuilder.of()

### Description
Factory methods for creating `AmountFormatQueryBuilder` instances.

### Method
static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
`AmountFormatQueryBuilder` instance

#### Response Example
None
```

--------------------------------

### AmountFormatContextBuilder.of()

Source: https://javamoney.github.io/apidocs/index-all.html

Provides static factory methods for creating AmountFormatContextBuilder instances. These methods allow for building amount format contexts, with options to initialize from a locale or an existing AmountFormatContext.

```APIDOC
## AmountFormatContextBuilder.of()

### Description
Factory methods for creating `AmountFormatContextBuilder` instances.

### Method
static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
`AmountFormatContextBuilder` instance

#### Response Example
None
```

--------------------------------

### getCurrencyCodes

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencyQuery.html

Gets the currency codes or a regular expression to select currency codes.

```APIDOC
## getCurrencyCodes

### Description
Gets the currency codes, or the regular expression to select codes.

### Method
public

### Returns
java.util.Collection<java.lang.String> - the target currency codes or the regular expression, never null.
```

--------------------------------

### CurrencyContextBuilder Factory Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/CurrencyContextBuilder.html

These static methods provide entry points for creating new CurrencyContextBuilder instances.

```APIDOC
## CurrencyContextBuilder.of(String provider)

### Description
Creates a new builder instance, initializing it with the given currency provider. This is a factory method to start building a `CurrencyContext`.

### Method
`static CurrencyContextBuilder`

### Parameters
#### Path Parameters
- **provider** (java.lang.String) - Required - The identifier of the currency provider to use.
```

```APIDOC
## CurrencyContextBuilder.of(CurrencyContext context)

### Description
Creates a new builder instance, initializing it with the values from an existing `CurrencyContext`. This allows for modification of an existing context.

### Method
`static CurrencyContextBuilder`

### Parameters
#### Path Parameters
- **context** (CurrencyContext) - Required - The `CurrencyContext` to copy values from.
```

--------------------------------

### getNumberType

Source: https://javamoney.github.io/apidocs/java.money/javax/money/NumberValue.html

Gets the numeric implementation type of the NumberValue. This indicates the base type of the number.

```APIDOC
## getNumberType

### Description
Gets the numeric implementation type of the NumberValue. This indicates the base type of the number.

### Method
```java
public abstract java.lang.Class<?> getNumberType()
```

### Returns
the numeric implementation type, not `null`.
```

--------------------------------

### getService

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/ServiceProvider.html

Access a single service, given its type. The bootstrap mechanism should order the instance for precedence, hereby the most significant should be first in order and returned. If no such services are found, null is returned.

```APIDOC
## getService

### Description
Access a single service, given its type. The bootstrap mechanism should order the instance for precedence, hereby the most significant should be first in order and returned. If no such services are found, null is returned.

### Method
default <T> T

### Parameters
#### Path Parameters
* **serviceType** (java.lang.Class<T>) - Required - the service type.

### Returns
The instance, (with highest precedence) or `null`, if no such service is available.
```

--------------------------------

### ConversionContext Instance Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ConversionContext.html

Methods for retrieving information about the current conversion context.

```APIDOC
## ConversionContext Instance Methods

### `getProviderName()`

Get the provider of this rate.

### `getRateType()`

Get the deferred flag.

### `toBuilder()`

Creates a conversion query builder with the context data from this context instance.

### `toQueryBuilder()`

Creates a query builder based on this context.
```

--------------------------------

### MonetaryAmountFactoryQueryBuilder.build()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/MonetaryAmountFactoryQuery.html

Creates a new instance of MonetaryAmountFactoryQuery based on the values of this Builder.

```APIDOC
## MonetaryAmountFactoryQueryBuilder.build()

### Description
Creates a new instance of `MonetaryAmountFactoryQuery` based on the values of this Builder.

### Method
(Not specified, likely a builder method)

### Endpoint
(Not applicable, this is an SDK method)

### Parameters
(No parameters specified for this method)

### Request Example
(Not applicable)

### Response
#### Success Response
- **MonetaryAmountFactoryQuery** - A new instance of `MonetaryAmountFactoryQuery`.
```

--------------------------------

### getNumber()

Source: https://javamoney.github.io/apidocs/java.money/javax/money/NumberSupplier.html

Gets the corresponding NumberValue from the supplier. This method is the functional method of the NumberSupplier interface.

```APIDOC
## getNumber()

### Description
Gets the corresponding `NumberValue`.

### Method
`NumberValue`

### Returns
the corresponding `NumberValue`, not null.
```

--------------------------------

### Monetary.getAmountFactories() (static)

Source: https://javamoney.github.io/apidocs/index-all.html

Accesses all currently available MonetaryAmount implementation classes.

```APIDOC
## getAmountFactories()

### Description
Access all currently available `MonetaryAmount` implementation classes that are accessible from this `MonetaryAmount` singleton.

### Method
N/A (Static method)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Get MonetaryContext Precision

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryContext.html

Retrieves the precision setting of the MonetaryContext. This value is always non-negative.

```java
public int getPrecision()
```

--------------------------------

### MonetaryAmountFactoryQueryBuilder Configuration Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/MonetaryAmountFactoryQueryBuilder.html

These methods allow configuring the scale and precision for the monetary amount factory query.

```APIDOC
## MonetaryAmountFactoryQueryBuilder.setFixedScale(boolean fixedScale)

### Description
Sets the flag if the scale should be fixed, meaning minimal scale and maximal scale are always equally sized.

### Method
instance

### Endpoint
N/A (Java Method)

### Parameters
- **fixedScale** (boolean) - `true` if the scale should be fixed, `false` otherwise.

### Response
- MonetaryAmountFactoryQueryBuilder: The builder instance for chaining.
```

```APIDOC
## MonetaryAmountFactoryQueryBuilder.setMaxScale(int maxScale)

### Description
Sets the maximal scale to be supported.

### Method
instance

### Endpoint
N/A (Java Method)

### Parameters
- **maxScale** (int) - The maximum scale to support. Must be non-negative.

### Response
- MonetaryAmountFactoryQueryBuilder: The builder instance for chaining.
```

```APIDOC
## MonetaryAmountFactoryQueryBuilder.setPrecision(int precision)

### Description
Sets the required precision. The value 0 models unlimited precision.

### Method
instance

### Endpoint
N/A (Java Method)

### Parameters
- **precision** (int) - The required precision. 0 for unlimited precision.

### Response
- MonetaryAmountFactoryQueryBuilder: The builder instance for chaining.
```

--------------------------------

### getDefaultRounding

Source: https://javamoney.github.io/apidocs/java.money/javax/money/DefaultMonetaryRoundingsSingletonSpi.html

Get the default rounding, which delegates rounding dynamically depending on the current currency.

```APIDOC
## getDefaultRounding()

### Description
Get the default rounding, which delegates rounding dynamically depending on the current currency.

### Method
`public MonetaryRounding getDefaultRounding()`

### Returns
The default rounding, never null.
```

--------------------------------

### ConversionContextBuilder Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/ConversionContextBuilder.html

Provides documentation for the instance methods of ConversionContextBuilder.

```APIDOC
## Method: ConversionContextBuilder.setRateType(RateType rateType)

### Description
Set the historic value.

### Method
`public ConversionContextBuilder setRateType(RateType rateType)`

### Parameters
* **rateType** (RateType) - the rate type

### Returns
this, for chaining.
```

```APIDOC
## Method: ConversionContextBuilder.build()

### Description
Creates a new `ConversionContext` with the data from this Builder instance.

### Method
`public ConversionContext build()`

### Returns
a new `ConversionContext`. never `null`.
```

--------------------------------

### Get Default Monetary Context

Source: https://javamoney.github.io/apidocs/index-all.html

Returns the default MonetaryContext used when no specific context is provided.

```APIDOC
## getDefaultMonetaryContext()

### Description
Returns the default `MonetaryContext` used, when no `MonetaryContext` is provided.

### Method
Method in interface javax.money.MonetaryAmountFactory or javax.money.spi.MonetaryAmountFactoryProviderSpi

### Response
#### Success Response (200)
- **MonetaryContext** - The default monetary context.
```

--------------------------------

### CurrencyQueryBuilder Configuration Methods

Source: https://javamoney.github.io/apidocs/java.money/javax/money/class-use/CurrencyQueryBuilder.html

These methods allow you to configure the criteria for your currency queries.

```APIDOC
## CurrencyQueryBuilder.setCountries(Locale... countries)

### Description
Sets the country or countries for which currencies should be requested. This filters currencies based on their associated countries.

### Method
Instance method

### Parameters
#### Path Parameters
- **countries** (Locale...) - Required - One or more Locale objects representing the countries.

### Returns
`CurrencyQueryBuilder` - The current builder instance for chaining.

## CurrencyQueryBuilder.setCurrencyCodes(String... codes)

### Description
Sets the currency code(s) or a regular expression to select currency codes. This allows filtering by specific currency codes or patterns.

### Method
Instance method

### Parameters
#### Path Parameters
- **codes** (String...) - Required - One or more currency codes or a regular expression string.

### Returns
`CurrencyQueryBuilder` - The current builder instance for chaining.

## CurrencyQueryBuilder.setNumericCodes(int... codes)

### Description
Sets the numeric code(s) for filtering currencies. This allows filtering by the ISO 4217 numeric currency codes.

### Method
Instance method

### Parameters
#### Path Parameters
- **codes** (int...) - Required - One or more numeric currency codes.

### Returns
`CurrencyQueryBuilder` - The current builder instance for chaining.
```

--------------------------------

### Get Default Format Provider Chain

Source: https://javamoney.github.io/apidocs/index-all.html

Retrieves the default provider chain for monetary formatting.

```APIDOC
## getDefaultFormatProviderChain()

### Description
Get the default provider chain, identified by the unique provider names in order as evaluated and used.

### Method
Static method in class javax.money.format.MonetaryFormats

### Response
#### Success Response (200)
- **List<String>** - The ordered list of default format provider names.
```

--------------------------------

### Equivalent Usage of MonetaryOperator

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryOperator.html

Demonstrates two equivalent ways to apply a MonetaryOperator to a MonetaryAmount. The second approach using MonetaryAmount.with() is recommended for clarity.

```java
 // these two lines are equivalent, but the second approach is recommended
 monetary = thisOperator.apply(monetary);
 monetary = monetary.with(thisOperator);
 
```

--------------------------------

### Get Default Currency Provider Chain

Source: https://javamoney.github.io/apidocs/index-all.html

Queries the default provider chain for currency management.

```APIDOC
## getDefaultCurrencyProviderChain()

### Description
Query the list and ordering of provider names modelling the default provider chain to be used, if no provider chain was explicitly set.

### Method
Static method in class javax.money.Monetary

### Response
#### Success Response (200)
- **List<String>** - The ordered list of default currency provider names.
```

--------------------------------

### Get Default Conversion Provider Chain

Source: https://javamoney.github.io/apidocs/index-all.html

Retrieves the default provider used for currency conversions.

```APIDOC
## getDefaultConversionProviderChain()

### Description
Get the default provider used for currency conversions.

### Method
Static method in class javax.money.convert.MonetaryConversions

### Response
#### Success Response (200)
- **ExchangeRateProvider** - The default conversion provider.
```

--------------------------------

### Create AmountFormatQueryBuilder from Existing Query

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/AmountFormatQueryBuilder.html

Use this static factory method to create a new AmountFormatQueryBuilder initialized with the values from an existing AmountFormatQuery. The provided formatQuery should not be null.

```java
public static AmountFormatQueryBuilder of(AmountFormatQuery formatQuery)
```

--------------------------------

### Ensuring same type return for MonetaryAmount implementations

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryAmount.html

Shows an example of a custom `MyMoney` class implementing `MonetaryAmount` and its `with` method, which correctly returns the concrete type `MyMoney`. This enables a fluent API for custom monetary types.

```java
public final class MyMoney implements MonetaryAmount{
  ...
  public MyMoney with(MonetaryOperator operator){
    ...
  }

  ...
 }
```

--------------------------------

### Accessing CurrencyConversion via ExchangeRateProvider

Source: https://javamoney.github.io/apidocs/java.money/javax/money/convert/class-use/CurrencyConversion.html

Default methods on ExchangeRateProvider to get a CurrencyConversion that can be applied as a MonetaryOperator.

```APIDOC
## Accessing CurrencyConversion via ExchangeRateProvider

### Description
Default methods on `ExchangeRateProvider` to obtain a `CurrencyConversion` instance, which can be used as a `MonetaryOperator`.

### Methods

#### `ExchangeRateProvider.getCurrencyConversion(String termCode)`
* **Description**: Access a `CurrencyConversion` that can be applied as a `MonetaryOperator` to an amount.
* **Parameters**:
  * `termCode` (String) - The currency code of the target currency.

#### `ExchangeRateProvider.getCurrencyConversion(ConversionQuery conversionQuery)`
* **Description**: Access a `CurrencyConversion` that can be applied as a `MonetaryOperator` to an amount.
* **Parameters**:
  * `conversionQuery` (ConversionQuery) - The query defining the conversion parameters.

#### `ExchangeRateProvider.getCurrencyConversion(CurrencyUnit term)`
* **Description**: Access a `CurrencyConversion` that can be applied as a `MonetaryOperator` to an amount.
* **Parameters**:
  * `term` (CurrencyUnit) - The target currency unit.
```

--------------------------------

### Build MonetaryContext Instance

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryContextBuilder.html

Constructs and returns a new MonetaryContext instance based on the builder's current configuration. This method finalizes the context setup.

```java
public MonetaryContext build()
```

--------------------------------

### Get Currency Context

Source: https://javamoney.github.io/apidocs/java.money/javax/money/CurrencyUnit.html

Returns the CurrencyContext, which contains additional information about the currency unit, such as its provider.

```java
CurrencyContext getContext()
```

--------------------------------

### getKeys(Class<?>) - AbstractContext

Source: https://javamoney.github.io/apidocs/index-all.html

Get the present keys of all entries with a given type, checking hereby if assignable.

```APIDOC
## getKeys(Class<?> type)

### Description
Get the present keys of all entries with a given type, checking hereby if assignable.

### Method
Instance method

### Endpoint
N/A (Class method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **type** (Class<?>) - Required - The type of entries to get keys for.
```

--------------------------------

### AbstractContextBuilder Constructor

Source: https://javamoney.github.io/apidocs/java.money/javax/money/AbstractContextBuilder.html

Initializes a new instance of the AbstractContextBuilder class.

```APIDOC
## Constructor: AbstractContextBuilder

### Description
Initializes a new instance of the AbstractContextBuilder class.

### Method
Constructor

### Code
```java
public AbstractContextBuilder()
```
```

--------------------------------

### Get Currency Conversion

Source: https://javamoney.github.io/apidocs/index-all.html

Obtains a CurrencyConversion object that can be applied as a MonetaryOperator, based on different query criteria.

```APIDOC
## getCurrencyConversion(String or ConversionQuery or CurrencyUnit)

### Description
Access a `CurrencyConversion` that can be applied as a `MonetaryOperator` to an amount.

### Method
Method in interface javax.money.convert.ExchangeRateProvider

### Parameters
#### Path Parameters
- **identifier** (String or ConversionQuery or CurrencyUnit) - Required - The identifier for the conversion (e.g., currency code, query object, or target currency unit).

### Response
#### Success Response (200)
- **CurrencyConversion** - The currency conversion object.
```

--------------------------------

### Customizing MonetaryAmountFormat Pattern

Source: https://javamoney.github.io/apidocs/java.money/javax/money/format/MonetaryAmountFormat.html

Demonstrates how to obtain a MonetaryAmountFormat instance for a locale and customize its pattern using a builder.

```java
MonetaryAmountFormat f = MonetaryFormats.getInstance(loc);
 f.setStyle(f.getStyle().toBuilder().setPattern("###.##;(###.##)").build());
```

--------------------------------

### Get Currency Code

Source: https://javamoney.github.io/apidocs/index-all.html

Retrieves the unique currency code for a given CurrencyUnit or an unknown currency exception.

```APIDOC
## getCurrencyCode()

### Description
Gets the unique currency code. The effective code depends on the currency or indicates the invalid code in case of an exception.

### Method
Method in interface javax.money.CurrencyUnit or exception javax.money.UnknownCurrencyException

### Response
#### Success Response (200)
- **String** - The currency code.
```

--------------------------------

### Example of using MonetaryOperator with MonetaryAmount

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryAmount.html

Demonstrates how to use the `with` method to apply monetary operators like multiplication and rounding to a MonetaryAmount. This method returns an instance of the same type, ensuring type safety.

```java
MonetaryAmount money = money.with(amountMultipliedBy(2));
money = money.with(amountRoundedToNearestWholeUnit());
```

--------------------------------

### Get Available Locales

Source: https://javamoney.github.io/apidocs/java.money/javax/money/spi/MonetaryFormatsSingletonSpi.html

Retrieves all available locales supported by format providers. This method is equivalent to MonetaryAmountFormatProviderSpi.getAvailableLocales().

```java
java.util.Set<java.util.Locale> getAvailableLocales(java.lang.String... providers)
```

--------------------------------

### Build MonetaryAmountFactoryQuery

Source: https://javamoney.github.io/apidocs/java.money/javax/money/MonetaryAmountFactoryQueryBuilder.html

Constructs and returns a new MonetaryAmountFactoryQuery instance based on the current builder configuration. Note that the builder supports creating multiple query instances from a single builder, but the contained keys and values are not deep-copied.

```java
public MonetaryAmountFactoryQuery build()
```
Tokens:
Raw