JavaMoney

+ +

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages

A

abs() - Method in interface javax.money.MonetaryAmount
abs() - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is the absolute value of this - MonetaryAmount, and whose scale is this.scale().
+ MonetaryAmount, and whose scale is this.getContext().getMaxScale().

AbstractContext - Class in javax.money

Represents a general context of data targeting an item of type Q.

AbstractContext(AbstractContextBuilder<?, ?>) - Constructor for class javax.money.AbstractContext

Private constructor, used by AbstractContextBuilder.

AbstractContextBuilder<B extends AbstractContextBuilder,C extends AbstractContext> - Class in javax.money

This interface defines the common generic parts of a query.

AbstractContextBuilder() - Constructor for class javax.money.AbstractContextBuilder

AbstractQuery - Class in javax.money

Represents a general context of data targeting an item of type Q.

AbstractQuery(AbstractQueryBuilder) - Constructor for class javax.money.AbstractQuery

Constructor, using a builder.

AbstractQueryBuilder<B extends AbstractQueryBuilder,C extends AbstractQuery> - Class in javax.money

This abstract class defines the common generic parts of a query.

AbstractQueryBuilder() - Constructor for class javax.money.AbstractQueryBuilder

Initializes the query builder, as a default query builder.

add(MonetaryAmount) - Method in interface javax.money.MonetaryAmount

Returns a MonetaryAmount whose value is this + augend, and whose scale is

max(this.getContext().getMaxScale(),
+ augend.getContext().getMaxScale())

ALWAYS - javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy

Returns a MonetaryAmount whose value is this + amount, and whose scale is

max(this.scale(),
- amount.scale()

Always include this factory (and the corresponding amount type) within queries.

AmountFormatContext - Class in javax.money.format

The AmountFormatContext provides details about a MonetaryAmountFormat.

AmountFormatContextBuilder - Class in javax.money.format

Builder class for creating new instances of AmountFormatContext adding detailed +

Builder class for creating new instances of AmountFormatContext adding detailed information - about a MonetaryAmountFormat instance.

+ about a MonetaryAmountFormat instance.

AmountFormatQuery - Class in javax.money.format

Query for accessing instances of MonetaryAmountFormat.

AmountFormatQueryBuilder - Class in javax.money.format

Builder for queries for accessing/configuring MonetaryAmountFormat instances.

ANY_CONVERSION - Static variable in class javax.money.convert.ConversionContext

ANY - javax.money.convert.RateType

Any type of rates.

ANY_CONVERSION - Static variable in class javax.money.convert.ConversionContext

ConversionContext that queries any conversion available.

apply(MonetaryAmount) - Method in interface javax.money.MonetaryOperator

Applies the operator on the given amount.

- +

B

Bootstrap - Class in javax.money.spi
Bootstrap - Class in javax.money.spi: This singleton provides access to the services available in the current runtime environment and context.
build() - Method in class javax.money.AbstractContextBuilder
build() - Method in class javax.money.AbstractContextBuilder: -
Creates a new AbstractContext with the data from this Builder +
Creates a new AbstractContext with the data from this Builder instance.
build() - Method in class javax.money.AbstractQueryBuilder
build() - Method in class javax.money.AbstractQueryBuilder: -
Creates a new AbstractQuery with the data from this Builder +
Creates a new AbstractQuery with the data from this Builder instance.
build() - Method in class javax.money.convert.ConversionContextBuilder
build() - Method in class javax.money.convert.ConversionContextBuilder: -
Creates a new ConversionContext with the data from this +
Creates a new ConversionContext with the data from this Builder instance.
build() - Method in class javax.money.convert.ConversionQueryBuilder
build() - Method in class javax.money.convert.ConversionQueryBuilder: -
Creates a new instance of ConversionQuery.
+
Creates a new instance of ConversionQuery.
build() - Method in class javax.money.convert.ProviderContextBuilder
build() - Method in class javax.money.convert.ProviderContextBuilder: -
Creates a new ProviderContext with the data from this Builder +
Creates a new ProviderContext with the data from this Builder instance.
build() - Method in class javax.money.CurrencyContextBuilder
build() - Method in class javax.money.CurrencyContextBuilder: -
Creates a new instance of CurrencyContext.
+
Creates a new instance of CurrencyContext.
build() - Method in class javax.money.CurrencyQueryBuilder
build() - Method in class javax.money.CurrencyQueryBuilder: -
Creates a new instance of CurrencyQuery.
+
Creates a new instance of CurrencyQuery.
build() - Method in class javax.money.format.AmountFormatContextBuilder
build() - Method in class javax.money.format.AmountFormatContextBuilder: -
Creates a new instance of AmountFormatContext that configures a .MonetaryAmountFormat.
+
Creates a new instance of AmountFormatContext that configures a .MonetaryAmountFormat.
build() - Method in class javax.money.format.AmountFormatQueryBuilder
build() - Method in class javax.money.format.AmountFormatQueryBuilder: -
Creates a new AmountFormatQuery instance.
+
Creates a new AmountFormatQuery instance.
build() - Method in class javax.money.MonetaryAmountFactoryQueryBuilder
build() - Method in class javax.money.MonetaryAmountFactoryQueryBuilder: -
Creates a new instance of MonetaryAmountFactoryQuery based on the values of this +
Creates a new instance of MonetaryAmountFactoryQuery based on the values of this Builder.
build() - Method in class javax.money.MonetaryContextBuilder
build() - Method in class javax.money.MonetaryContextBuilder: -
Creates a new instance of MonetaryAmountFactoryQuery.
+
Creates a new instance of MonetaryAmountFactoryQuery.
build() - Method in class javax.money.RoundingContextBuilder
build() - Method in class javax.money.RoundingContextBuilder: -
Creates a new instance of RoundingContext.
+
Creates a new instance of RoundingContext.
build() - Method in class javax.money.RoundingQueryBuilder
build() - Method in class javax.money.RoundingQueryBuilder: -
Creates a new instance of RoundingQuery.
+
Creates a new instance of RoundingQuery.

- +

C

compareTo(NumberValue) - Method in class javax.money.NumberValue
compareTo(NumberValue) - Method in class javax.money.NumberValue
ConversionContext - Class in javax.money.convert
ConversionContext - Class in javax.money.convert: -
This class models a context for which a ExchangeRate is valid.
+
This class models a context for which a ExchangeRate is valid.
ConversionContextBuilder - Class in javax.money.convert
ConversionContextBuilder - Class in javax.money.convert: -
Builder class to of ConversionContext instances.
+
Builder class to of ConversionContext instances.
ConversionContextBuilder() - Constructor for class javax.money.convert.ConversionContextBuilder
ConversionContextBuilder() - Constructor for class javax.money.convert.ConversionContextBuilder: Create a new Builder instance without any provider, e.g.
ConversionQuery - Class in javax.money.convert
ConversionQuery - Class in javax.money.convert: -
Query for accessing CurrencyConversion instances.
+
Query for accessing CurrencyConversion instances.
ConversionQueryBuilder - Class in javax.money.convert
ConversionQueryBuilder - Class in javax.money.convert: -
Builder class for creating new instances of ConversionQuery adding detailed - information about a CurrencyConversion instance.
+
Builder class for creating new instances of ConversionQuery adding detailed + information about a CurrencyConversion instance.
create(ProviderContext, RateType) - Static method in class javax.money.convert.ConversionContextBuilder
create() - Method in interface javax.money.MonetaryAmountFactory: -
Create a new Builder, hereby using the given - ConversionContext's values as defaults.
+
Creates a new instance of MonetaryAmount, using the current data set on this factory.
create(ProviderContext) - Static method in class javax.money.convert.ProviderContextBuilder
create(ProviderContext) - Static method in class javax.money.convert.ProviderContextBuilder: -
Create a new ProviderContextBuilder, hereby using the given ProviderContext +
Create a new ProviderContextBuilder, hereby using the given ProviderContext 's values as defaults.
create(AmountFormatQuery) - Static method in class javax.money.format.AmountFormatContextBuilder
create(ProviderContext, RateType) - Static method in class javax.money.convert.ConversionContextBuilder: -
Creates a new AmountFormatContextBuilder.
+
Create a new Builder, hereby using the given + ConversionContext's values as defaults.
create() - Method in interface javax.money.MonetaryAmountFactory
create(AmountFormatQuery) - Static method in class javax.money.format.AmountFormatContextBuilder: -
Creates a new instance of MonetaryAmount, using the current data set on this factory.
+
Creates a new AmountFormatContextBuilder.
createMonetaryAmountFactory() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi
createMonetaryAmountFactory() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi: -
Access a MonetaryAmountFactory given the required context.
+
Access a MonetaryAmountFactory given the required context.
CurrencyContext - Class in javax.money
createRoundingQueryBuilder() - Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi: -
This class models the attributable context of CurrencyUnit instances.
+
Creates an rounding instance using RoundingMode.UP rounding.
CurrencyContextBuilder - Class in javax.money
CurrencyContext - Class in javax.money: -
Builder class for creating new instances of CurrencyContext adding detailed information - about a CurrencyUnit instance.
+
This class models the attributable context of CurrencyUnit instances.
CurrencyConversion - Interface in javax.money.convert
CurrencyContextBuilder - Class in javax.money: -
This interface defines a CurrencyConversion that is converting a MonetaryAmount to another - MonetaryAmount with a different target CurrencyUnit.
+
Builder class for creating new instances of CurrencyContext adding detailed information + about a CurrencyUnit instance.
CurrencyConversionException - Exception in javax.money.convert
CurrencyConversion - Interface in javax.money.convert: +
This interface defines a CurrencyConversion that is converting a MonetaryAmount to another + MonetaryAmount with a different target CurrencyUnit.
+
CurrencyConversionException - Exception in javax.money.convert: Exception thrown when a monetary conversion operation fails.
CurrencyConversionException(CurrencyUnit, CurrencyUnit, ConversionContext, String) - Constructor for exception javax.money.convert.CurrencyConversionException
CurrencyConversionException(CurrencyUnit, CurrencyUnit, ConversionContext) - Constructor for exception javax.money.convert.CurrencyConversionException: Constructs an CurrencyConversionException with the specified - detail message, timestamp, source and target currency.
+ source and target currency.
CurrencyConversionException(CurrencyUnit, CurrencyUnit, ConversionContext) - Constructor for exception javax.money.convert.CurrencyConversionException
CurrencyConversionException(CurrencyUnit, CurrencyUnit, ConversionContext, String) - Constructor for exception javax.money.convert.CurrencyConversionException: Constructs an CurrencyConversionException with the specified - source and target currency.
+ detail message, timestamp, source and target currency.
CurrencyConversionException(CurrencyUnit, CurrencyUnit, ConversionContext, String, Throwable) - Constructor for exception javax.money.convert.CurrencyConversionException
CurrencyConversionException(CurrencyUnit, CurrencyUnit, ConversionContext, String, Throwable) - Constructor for exception javax.money.convert.CurrencyConversionException: Constructs a new exception with the specified source and target currency, detail message and cause.
CurrencyProviderSpi - Interface in javax.money.spi
CurrencyProviderSpi - Interface in javax.money.spi: -
SPI (core) to be registered using the Bootstrap, which allows to +
SPI (core) to be registered using the Bootstrap, which allows to register/provide additional currencies into the system automatically on startup.
CurrencyQuery - Class in javax.money
CurrencyQuery - Class in javax.money: -
This class models a query for accessing instances of CurrencyUnit.
+
This class models a query for accessing instances of CurrencyUnit.
CurrencyQueryBuilder - Class in javax.money
CurrencyQueryBuilder - Class in javax.money: -
Builder for queries for accessing CurrencyUnit instances.
+
Builder for queries for accessing CurrencyUnit instances.
CurrencySupplier - Interface in javax.money
CurrencySupplier - Interface in javax.money: -
Represents a supplier of CurrencyUnit-valued results.
+
Represents a supplier of CurrencyUnit-valued results.
CurrencyUnit - Interface in javax.money
CurrencyUnit - Interface in javax.money: A unit of currency.

- +

D

DefaultMonetaryFormatsSingletonSpi() - Constructor for class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
DefaultMonetaryFormatsSingletonSpi() - Constructor for class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
DEFERRED_CONVERSION - Static variable in class javax.money.convert.ConversionContext
DefaultMonetaryRoundingsSingletonSpi - Class in javax.money: +
This class models the accessor for rounding instances, modeled as + MonetaryOperator.
+
DefaultMonetaryRoundingsSingletonSpi() - Constructor for class javax.money.DefaultMonetaryRoundingsSingletonSpi
DEFERRED - javax.money.convert.RateType: +
Deferred rates are basically also current rates, but have some fixed delay, e.g.
+
DEFERRED_CONVERSION - Static variable in class javax.money.convert.ConversionContext: -
ConversionContext quering for any deferred rates.
+
ConversionContext querying for any deferred rates.
divide(long) - Method in interface javax.money.MonetaryAmount
DIRECT_REFERENCE_ONLY - javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy: +
Only consider this factory, when the implementation type is specified explicitly in the + MonetaryContext required.
+
divide(double) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this / - divisor, and whose preferred scale is this.scale() - - divisor.scale(); if the exact quotient cannot be represented an ArithmeticException + divisor, and whose preferred scale is this.getContext().getMaxScale() - + divisor.getContext().getMaxScale(); if the exact quotient cannot be represented an ArithmeticException is thrown.
divide(double) - Method in interface javax.money.MonetaryAmount
divide(long) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this / - divisor, and whose preferred scale is this.scale() - - divisor.scale(); if the exact quotient cannot be represented an ArithmeticException + divisor, and whose preferred scale is this.getContext().getMaxScale() - + divisor.getContext().getMaxScale(); if the exact quotient cannot be represented an ArithmeticException is thrown.
divide(Number) - Method in interface javax.money.MonetaryAmount
divide(Number) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this / - divisor, and whose preferred scale is this.scale() - - divisor.scale(); if the exact quotient cannot be represented an ArithmeticException + divisor, and whose preferred scale is this.getContext().getMaxScale() - + divisor.getContext().getMaxScale(); if the exact quotient cannot be represented an ArithmeticException is thrown.
divideAndRemainder(long) - Method in interface javax.money.MonetaryAmount
divideAndRemainder(double) - Method in interface javax.money.MonetaryAmount: Returns a two-element MonetaryAmount array containing the result of divideToIntegralValue followed by the result of remainder on the two operands.
divideAndRemainder(double) - Method in interface javax.money.MonetaryAmount
divideAndRemainder(long) - Method in interface javax.money.MonetaryAmount: Returns a two-element MonetaryAmount array containing the result of divideToIntegralValue followed by the result of remainder on the two operands.
divideAndRemainder(Number) - Method in interface javax.money.MonetaryAmount
divideAndRemainder(Number) - Method in interface javax.money.MonetaryAmount: Returns a two-element MonetaryAmount array containing the result of divideToIntegralValue followed by the result of remainder on the two operands.
divideToIntegralValue(long) - Method in interface javax.money.MonetaryAmount
divideToIntegralValue(double) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is the integer part of the quotient this / divisor rounded down.
divideToIntegralValue(double) - Method in interface javax.money.MonetaryAmount
divideToIntegralValue(long) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is the integer part of the quotient this / divisor rounded down.
divideToIntegralValue(Number) - Method in interface javax.money.MonetaryAmount
divideToIntegralValue(Number) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is the integer part of the quotient this / divisor rounded down.
doubleValueExact() - Method in class javax.money.NumberValue
doubleValueExact() - Method in class javax.money.NumberValue: Access the numeric value as double.

- +

E

equals(Object) - Method in class javax.money.AbstractContext
equals(Object) - Method in class javax.money.AbstractContext
ExchangeRate - Interface in javax.money.convert
ExchangeRate - Interface in javax.money.convert: This class models an exchange rate, which defines the factor the numeric value of a base amount in some currency 'A' must be multiplied to get the corresponding amount in the terminating currency 'B'.
ExchangeRateProvider - Interface in javax.money.convert
ExchangeRateProvider - Interface in javax.money.convert: This interface defines access to the exchange rates provided by a provider.
ExchangeRateProviderSupplier - Interface in javax.money.convert
ExchangeRateProviderSupplier - Interface in javax.money.convert: -
A supplier of ExchangeRateProvider name that references an implementation.
+
A supplier of ExchangeRateProvider name that references an implementation.

- +

F

format(MonetaryAmount) - Method in interface javax.money.format.MonetaryAmountFormat
format(MonetaryAmount) - Method in interface javax.money.format.MonetaryAmountFormat: -
Formats the given MonetaryAmount to a String.
+
Formats the given MonetaryAmount to a String.
from(ProviderContext, RateType) - Static method in class javax.money.convert.ConversionContext
from(ProviderContext, RateType) - Static method in class javax.money.convert.ConversionContext: -
Creates a new ConversionContext for the given ProviderContext and the given RateType.
+
Creates a new ConversionContext for the given ProviderContext and the given RateType.
from(MonetaryAmountFactoryQuery, Class<? extends MonetaryAmount>) - Static method in class javax.money.MonetaryContext
from(MonetaryAmountFactoryQuery, Class<? extends MonetaryAmount>) - Static method in class javax.money.MonetaryContext: -
This method allows to easily of a new MonetaryContext instance from a given .MonetaryAmountFactoryQuery.
+
This method allows to easily of a new MonetaryContext instance from a given .MonetaryAmountFactoryQuery.
from(MonetaryContext, Class<? extends MonetaryAmount>) - Static method in class javax.money.MonetaryContext
from(MonetaryContext, Class<? extends MonetaryAmount>) - Static method in class javax.money.MonetaryContext: Creates a new MonetaryContext).

- +

G

get(String, Class<T>) - Method in class javax.money.AbstractContext
get() - Method in interface javax.money.convert.ExchangeRateProviderSupplier: -
Access an attribute.
+
Get the provider name.
get(Class<T>) - Method in class javax.money.AbstractContext
get(Class<T>) - Method in class javax.money.AbstractContext: Access an attribute, hereby using the class name as key.
get() - Method in interface javax.money.convert.ExchangeRateProviderSupplier
get(String, Class<T>) - Method in class javax.money.AbstractContext: -
Get the provider name.
+
Access an attribute.
getAmountFactories() - Static method in class javax.money.Monetary
getAmountFactories() - Static method in class javax.money.Monetary: -
Access all currently available MonetaryAmount implementation classes that are - accessible from this MonetaryAmount singleton.
+
Access all currently available MonetaryAmount implementation classes that are + accessible from this MonetaryAmount singleton.
getAmountFactories(MonetaryAmountFactoryQuery) - Static method in class javax.money.Monetary
getAmountFactories() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi: -
Returns all factory instances that match the query.
+
Get the currently registered MonetaryAmount implementation classes.
getAmountFactories(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi
getAmountFactories(MonetaryAmountFactoryQuery) - Static method in class javax.money.Monetary: -
Get the MonetaryAmountFactory implementation class, that best matches to cover the given - MonetaryContext.
+
Returns all factory instances that match the query.
getAmountFactories() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi
getAmountFactories(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi: -
Get the currently registered MonetaryAmount implementation classes.
+
Get the MonetaryAmountFactory implementation class, that best matches to cover the given + MonetaryContext.
getAmountFactory(Class<T>) - Static method in class javax.money.Monetary
getAmountFactory(Class<T>) - Static method in class javax.money.Monetary: -
Access an MonetaryAmountFactory for the given MonetaryAmount implementation +
Access an MonetaryAmountFactory for the given MonetaryAmount implementation type.
getAmountFactory(MonetaryAmountFactoryQuery) - Static method in class javax.money.Monetary
getAmountFactory(Class<T>) - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi: -
Executes the query and returns the factory found, if there is only one factory.
+
Access the MonetaryAmountFactory for the given amountType .
getAmountFactory(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi
getAmountFactory(MonetaryAmountFactoryQuery) - Static method in class javax.money.Monetary: -
Executes the query and returns the MonetaryAmountFactory implementation type found, - if there is only one type.
+
Executes the query and returns the factory found, if there is only one factory.
getAmountFactory(Class<T>) - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi
getAmountFactory(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi: -
Access the MonetaryAmountFactory for the given amountType .
+
Executes the query and returns the MonetaryAmountFactory implementation type found, + if there is only one type.
getAmountFormat(Locale, String...) - Static method in class javax.money.format.MonetaryFormats
getAmountFormat(String, String...) - Static method in class javax.money.format.MonetaryFormats: -
Access the default MonetaryAmountFormat given a Locale.
+
Access the a MonetaryAmountFormat given its styleId.
getAmountFormat(AmountFormatQuery) - Static method in class javax.money.format.MonetaryFormats
getAmountFormat(String, String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: -
Access the default MonetaryAmountFormat given a Locale.
+
Access the default MonetaryAmountFormat given a Locale.
getAmountFormat(String, String...) - Static method in class javax.money.format.MonetaryFormats
getAmountFormat(Locale, String...) - Static method in class javax.money.format.MonetaryFormats: -
Access the a MonetaryAmountFormat given its styleId.
+
Access the default MonetaryAmountFormat given a Locale.
getAmountFormat(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getAmountFormat(Locale, String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: -
Access an MonetaryAmountFormat given a .AmountFormatQuery.
+
Access the default MonetaryAmountFormat given a Locale.
getAmountFormat(Locale, String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getAmountFormat(AmountFormatQuery) - Static method in class javax.money.format.MonetaryFormats: -
Access the default MonetaryAmountFormat given a Locale.
+
Access the default MonetaryAmountFormat given a Locale.
getAmountFormat(String, String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getAmountFormat(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: -
Access the default MonetaryAmountFormat given a Locale.
+
Access an MonetaryAmountFormat given a .AmountFormatQuery.
getAmountFormats(AmountFormatQuery) - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
getAmountFormats(AmountFormatQuery) - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi: -
Access an MonetaryAmountFormat given a .AmountFormatContext.
+
Access an MonetaryAmountFormat given a .AmountFormatContext.
getAmountFormats(AmountFormatQuery) - Static method in class javax.money.format.MonetaryFormats
getAmountFormats(AmountFormatQuery) - Static method in class javax.money.format.MonetaryFormats: -
Access all MonetaryAmountFormat instances that match the given a AmountFormatQuery.
+
Access all MonetaryAmountFormat instances that match the given a AmountFormatQuery.
getAmountFormats(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi
getAmountFormats(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi: -
Create a new MonetaryAmountFormat for the given input.
+
Create a new MonetaryAmountFormat for the given input.
getAmountFormats(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getAmountFormats(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: -
Access all MonetaryAmountFormat instances matching the given .AmountFormatQuery.
+
Access all MonetaryAmountFormat instances matching the given .AmountFormatQuery.
getAmountFractionDenominator() - Method in class javax.money.NumberValue
getAmountFractionDenominator() - Method in class javax.money.NumberValue: -
This method allows to extract the denominator part of the current fraction, hereby given - - w = longValue() - n = getFractionNominator() - d = getFractionDenominator() - - - the following must be always true: - - - !(w<0 && n>0) and - !(w>0 && n<0) and - d>0 and - |n| < d // || = absolute value -.
+
This method allows to extract the denominator part of the current fraction, hereby given
getAmountFractionNumerator() - Method in class javax.money.NumberValue
getAmountFractionNumerator() - Method in class javax.money.NumberValue: -
This method allows to extract the numerator part of the current fraction, hereby given - - w = longValue() - n = getFractionNominator() - d = getFractionDenominator() - - - the following must be always true: - - - !(w<0 && n>0) and - !(w>0 && n<0) and - d>0 and - |n| < d // || = absolute value -.
+
This method allows to extract the numerator part of the current fraction, hereby given
getAmountType() - Method in interface javax.money.MonetaryAmountFactory
getAmountType() - Method in interface javax.money.MonetaryAmountFactory: -
Access the MonetaryAmount implementation type.
+
Access the MonetaryAmount implementation type.
getAmountType() - Method in class javax.money.MonetaryContext
getAmountType() - Method in class javax.money.MonetaryContext: Get the MonetaryAmount implementation class.
getAmountType() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi
getAmountType() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi: -
Get the concrete amount type created by MonetaryAmountFactory instances provided.
+
Get the concrete amount type created by MonetaryAmountFactory instances provided.
getAmountType(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi
getAmountType(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi: -
Executes the query and returns the MonetaryAmount implementation type found, +
Executes the query and returns the MonetaryAmount implementation type found, if there is only one type.
getAmountTypes() - Static method in class javax.money.Monetary
getAmountTypes() - Static method in class javax.money.Monetary: -
Access all currently available MonetaryAmount implementation classes that are - accessible from this MonetaryAmount singleton.
+
Access all currently available MonetaryAmount implementation classes that are + accessible from this MonetaryAmount singleton.
getAmountTypes(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi
getAmountTypes() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi: -
Executes the query and returns the MonetaryAmount implementation types found.
+
Get the currently registered MonetaryAmount implementation types.
getAmountTypes() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi
getAmountTypes(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi: -
Get the currently registered MonetaryAmount implementation types.
+
Executes the query and returns the MonetaryAmount implementation types found.
getAvailableFormatNames() - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi
getAvailableFormatNames() - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi: Gets a list with available format names for this format provider.
getAvailableLocales(String...) - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
getAvailableLocales() - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi: -
Get all available locales.
+
Gets a list with available locales for this format provider.
getAvailableLocales(String...) - Static method in class javax.money.format.MonetaryFormats
getAvailableLocales(String...) - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi: Get all available locales.
getAvailableLocales() - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi
getAvailableLocales(String...) - Static method in class javax.money.format.MonetaryFormats: -
Gets a list with available locales for this format provider.
+
Get all available locales.
getAvailableLocales(String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getAvailableLocales(String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: Get all available locales.
getBaseCurrency() - Method in class javax.money.convert.ConversionQuery
getBaseCurrency() - Method in class javax.money.convert.ConversionQuery: Get the base currency.
getBaseCurrency() - Method in exception javax.money.convert.CurrencyConversionException
getBaseCurrency() - Method in exception javax.money.convert.CurrencyConversionException: Gets the first currency at fault.
getBaseCurrency() - Method in interface javax.money.convert.ExchangeRate
getBaseCurrency() - Method in interface javax.money.convert.ExchangeRate: -
Get the base (source) CurrencyUnit.
+
Get the base (source) CurrencyUnit.
getBoolean(String) - Method in class javax.money.AbstractContext
getBoolean(String) - Method in class javax.money.AbstractContext: Access a Boolean attribute.
getContext() - Method in interface javax.money.convert.CurrencyConversion
getContext() - Method in interface javax.money.convert.CurrencyConversion: -
Access the target ConversionContext of this conversion instance.
+
Access the target ConversionContext of this conversion instance.
getContext() - Method in interface javax.money.convert.ExchangeRate
getContext() - Method in interface javax.money.convert.ExchangeRate: -
Access the ConversionContext of ExchangeRate.
+
Access the ConversionContext of ExchangeRate.
getContext() - Method in interface javax.money.convert.ExchangeRateProvider
getContext() - Method in interface javax.money.convert.ExchangeRateProvider: -
Access the ConversionContext for this - ExchangeRateProvider.
+
Access the ConversionContext for this + ExchangeRateProvider.
getContext() - Method in interface javax.money.CurrencyUnit
getContext() - Method in interface javax.money.CurrencyUnit: -
Returns the CurrencyContext of a currency.
+
Returns the CurrencyContext of a currency.
getContext() - Method in interface javax.money.format.MonetaryAmountFormat
getContext() - Method in interface javax.money.format.MonetaryAmountFormat: -
The AmountFormatContext to be applied when a MonetaryAmount is formatted.
+
The AmountFormatContext to be applied when a MonetaryAmount is formatted.
getContext() - Method in interface javax.money.MonetaryAmount
getContext() - Method in interface javax.money.MonetaryAmount: -
Returns the MonetaryContext of this MonetaryAmount.
+
Returns the MonetaryContext of this MonetaryAmount.
getConversion(CurrencyUnit, String...) - Static method in class javax.money.convert.MonetaryConversions
getConversion(String, String...) - Static method in class javax.money.convert.MonetaryConversions: -
Access an instance of CurrencyConversion for the given providers.
+
Access an instance of CurrencyConversion for the given providers.
getConversion(String, String...) - Static method in class javax.money.convert.MonetaryConversions
getConversion(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions: -
Access an instance of CurrencyConversion for the given providers.
+
Access an instance of CurrencyConversion for the given providers.
getConversion(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions
getConversion(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Access an instance of CurrencyConversion for the given providers.
+
Access an instance of CurrencyConversion.
getConversion(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getConversion(CurrencyUnit, String...) - Static method in class javax.money.convert.MonetaryConversions: -
Access an instance of CurrencyConversion.
+
Access an instance of CurrencyConversion for the given providers.
getConversion(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getConversion(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Access an instance of CurrencyConversion.
+
Access an instance of CurrencyConversion.
getConversionContext() - Method in exception javax.money.convert.CurrencyConversionException
getConversionContext() - Method in exception javax.money.convert.CurrencyConversionException: Gets the queried timestamp at fault.
getConversionProviderNames() - Static method in class javax.money.convert.MonetaryConversions
getConversionProviderNames() - Static method in class javax.money.convert.MonetaryConversions: Return the (non localized) names of all providers available in the current context.
getCountries() - Method in class javax.money.CurrencyQuery
getCountries() - Method in class javax.money.CurrencyQuery: Returns the target locales.
getCurrencies(Locale, String...) - Static method in class javax.money.Monetary
getCurrencies(String...) - Static method in class javax.money.Monetary: -
Access a new instance based on the Locale.
+
Access all currencies known.
getCurrencies(String...) - Static method in class javax.money.Monetary
getCurrencies(String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: -
Access all currencies known.
+
Provide access to all currently known currencies.
getCurrencies(CurrencyQuery) - Static method in class javax.money.Monetary
getCurrencies(Locale, String...) - Static method in class javax.money.Monetary: -
Query all currencies matching the given query.
+
Access a new instance based on the Locale.
getCurrencies(CurrencyQuery) - Method in interface javax.money.spi.CurrencyProviderSpi
getCurrencies(Locale, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: -
Return a CurrencyUnit instances matching the given - CurrencyContext.
+
Provide access to all currently known currencies.
getCurrencies(CurrencyQuery) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getCurrencies(CurrencyQuery) - Static method in class javax.money.Monetary: -
Access all currencies matching the given query.
+
Query all currencies matching the given query.
getCurrencies(Locale, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getCurrencies(CurrencyQuery) - Method in interface javax.money.spi.CurrencyProviderSpi: -
Provide access to all currently known currencies.
+
Return a CurrencyUnit instances matching the given + CurrencyContext.
getCurrencies(String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getCurrencies(CurrencyQuery) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: -
Provide access to all currently known currencies.
+
Access all currencies matching the given query.
getCurrency() - Method in class javax.money.convert.ConversionQuery
getCurrency() - Method in class javax.money.convert.ConversionQuery: Get the terminating currency.
getCurrency() - Method in interface javax.money.convert.ExchangeRate
getCurrency() - Method in interface javax.money.convert.ExchangeRate: -
Get the term (target) CurrencyUnit.
+
Get the term (target) CurrencyUnit.
getCurrency() - Method in interface javax.money.CurrencySupplier
getCurrency() - Method in interface javax.money.CurrencySupplier: -
Gets the corresponding CurrencyUnit.
+
Gets the corresponding CurrencyUnit.
getCurrency(String, String...) - Static method in class javax.money.Monetary
getCurrency() - Method in class javax.money.RoundingContext: -
Access a new instance based on the currency code.
+
Get the basic CurrencyUnit, which is based for this rounding type.
getCurrency(Locale, String...) - Static method in class javax.money.Monetary
getCurrency() - Method in class javax.money.RoundingQuery: -
Access a new instance based on the Locale.
+
Sets the target CurrencyUnit.
getCurrency(CurrencyQuery) - Static method in class javax.money.Monetary
getCurrency(String, String...) - Static method in class javax.money.Monetary: -
Query all currencies matching the given query.
+
Access a new instance based on the currency code.
getCurrency() - Method in class javax.money.RoundingContext
getCurrency(String, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: -
Get the basic CurrencyUnit, which is based for this rounding type.
+
Access a new instance based on the currency code.
getCurrency() - Method in class javax.money.RoundingQuery
getCurrency(Locale, String...) - Static method in class javax.money.Monetary: -
Sets the target CurrencyUnit.
+
Access a new instance based on the Locale.
getCurrency(String, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getCurrency(Locale, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: Access a new instance based on the currency code.
getCurrency(Locale, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getCurrency(CurrencyQuery) - Static method in class javax.money.Monetary: -
Access a new instance based on the currency code.
+
Query all currencies matching the given query.
getCurrency(CurrencyQuery) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getCurrency(CurrencyQuery) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: Access a single currency by query.
getCurrencyCode() - Method in interface javax.money.CurrencyUnit
getCurrencyCode() - Method in interface javax.money.CurrencyUnit: Gets the unique currency code, the effective code depends on the currency.
getCurrencyCode() - Method in exception javax.money.UnknownCurrencyException
getCurrencyCode() - Method in exception javax.money.UnknownCurrencyException: Access the invalid currency code.
getCurrencyCodes() - Method in class javax.money.CurrencyQuery
getCurrencyCodes() - Method in class javax.money.CurrencyQuery: Gets the currency codes, or the regular expression to select codes.
getCurrencyConversion(ConversionQuery) - Method in interface javax.money.convert.ExchangeRateProvider
getCurrencyConversion(String) - Method in interface javax.money.convert.ExchangeRateProvider: -
Access a CurrencyConversion that can be applied as a - MonetaryOperator to an amount.
+
Access a CurrencyConversion that can be applied as a + MonetaryOperator to an amount.
getCurrencyConversion(CurrencyUnit) - Method in interface javax.money.convert.ExchangeRateProvider
getCurrencyConversion(ConversionQuery) - Method in interface javax.money.convert.ExchangeRateProvider: -
Access a CurrencyConversion that can be applied as a - MonetaryOperator to an amount.
+
Access a CurrencyConversion that can be applied as a + MonetaryOperator to an amount.
getCurrencyConversion(String) - Method in interface javax.money.convert.ExchangeRateProvider
getCurrencyConversion(CurrencyUnit) - Method in interface javax.money.convert.ExchangeRateProvider: -
Access a CurrencyConversion that can be applied as a - MonetaryOperator to an amount.
+
Access a CurrencyConversion that can be applied as a + MonetaryOperator to an amount.
getCurrencyProviderNames() - Static method in class javax.money.Monetary
getCurrencyProviderNames() - Static method in class javax.money.Monetary: Query all currencies matching the given query.
getDefaultAmountFactory() - Static method in class javax.money.Monetary
getDefaultAmountFactory() - Static method in class javax.money.Monetary: -
Access the default MonetaryAmountFactory as defined by - MonetaryAmountsSingletonSpi.getDefaultAmountFactory().
+
Access the default MonetaryAmountFactory as defined by + MonetaryAmountsSingletonSpi.getDefaultAmountFactory().
getDefaultAmountFactory() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi
getDefaultAmountFactory() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi: -
Access the default MonetaryAmountFactory.
+
Access the default MonetaryAmountFactory.
getDefaultAmountType() - Static method in class javax.money.Monetary
getDefaultAmountType() - Static method in class javax.money.Monetary: -
Access the default MonetaryAmount implementation class that is - accessible from this MonetaryAmount singleton.
+
Access the default MonetaryAmount implementation class that is + accessible from this MonetaryAmount singleton.
getDefaultAmountType() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi
getDefaultAmountType() - Method in interface javax.money.spi.MonetaryAmountsSingletonSpi: -
Access the default MonetaryAmount implementation type.
+
Access the default MonetaryAmount implementation type.
getDefaultConversionProviderChain() - Static method in class javax.money.convert.MonetaryConversions
getDefaultConversionProviderChain() - Static method in class javax.money.convert.MonetaryConversions: Get the default provider used.
getDefaultCurrencyProviderChain() - Static method in class javax.money.Monetary
getDefaultCurrencyProviderChain() - Static method in class javax.money.Monetary: Query the list and ordering of provider names modelling the default provider chain to be used, if no provider chain was explicitly set..
getDefaultFormatProviderChain() - Static method in class javax.money.format.MonetaryFormats
getDefaultFormatProviderChain() - Static method in class javax.money.format.MonetaryFormats: Get the default provider chain, identified by the unique provider names in order as evaluated and used.
getDefaultFractionDigits() - Method in interface javax.money.CurrencyUnit
getDefaultFractionDigits() - Method in interface javax.money.CurrencyUnit: Gets the number of fractional digits typically used by this currency.
getDefaultMonetaryContext() - Method in interface javax.money.MonetaryAmountFactory
getDefaultMonetaryContext() - Method in interface javax.money.MonetaryAmountFactory: -
Returns the default MonetaryContext used, when no MonetaryContext is +
Returns the default MonetaryContext used, when no MonetaryContext is provided.
getDefaultMonetaryContext() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi
getDefaultMonetaryContext() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi: -
Returns the default MonetaryContext used, when no MonetaryContext is +
Returns the default MonetaryContext used, when no MonetaryContext is provided.
getDefaultProviderChain() - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
getDefaultProviderChain() - Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi: +
Get the default providers list to be used.
+
getDefaultProviderChain() - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi: This default implementation simply returns all providers defined in arbitrary order.
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: Get the default provider chain used.
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: Access a list of the currently registered default providers.
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: Get the default provider chain, identified by the unique provider names in order as evaluated and used.
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getDefaultProviderChain() - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: Access a list of the currently registered default providers.
getDefaultRounding() - Static method in class javax.money.Monetary
getDefaultRounding() - Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi: -
Creates a rounding that can be added as MonetaryOperator to +
Get the default rounding, which delegates rounding dynamically depending on the current currency.
+
getDefaultRounding() - Static method in class javax.money.Monetary: +
Creates a rounding that can be added as MonetaryOperator to chained calculations.
getDefaultRounding() - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getDefaultRounding() - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Creates a MonetaryRounding that can be added as MonetaryOperator to +
Creates a MonetaryRounding that can be added as MonetaryOperator to chained calculations.
getDefaultRoundingProviderChain() - Static method in class javax.money.Monetary
getDefaultRoundingProviderChain() - Static method in class javax.money.Monetary: Allows to access the default providers chain used if no provider chain was passed explicitly..
getDouble(String) - Method in class javax.money.AbstractContext
getDouble(String) - Method in class javax.money.AbstractContext: Access a Double attribute.
getErrorIndex() - Method in exception javax.money.format.MonetaryParseException
getErrorIndex() - Method in exception javax.money.format.MonetaryParseException: Returns the index where the error was found.
getExchangeRate(MonetaryAmount) - Method in interface javax.money.convert.CurrencyConversion
getExchangeRate(String, String) - Method in interface javax.money.convert.ExchangeRateProvider: -
Get the ExchangeRate applied for the given MonetaryAmount - .
+
Access a ExchangeRate using the given currencies.
getExchangeRate(ConversionQuery) - Method in interface javax.money.convert.ExchangeRateProvider
getExchangeRate(ConversionQuery) - Method in interface javax.money.convert.ExchangeRateProvider: -
Access a ExchangeRate using the given currencies.
+
Access a ExchangeRate using the given currencies.
getExchangeRate(CurrencyUnit, CurrencyUnit) - Method in interface javax.money.convert.ExchangeRateProvider
getExchangeRate(CurrencyUnit, CurrencyUnit) - Method in interface javax.money.convert.ExchangeRateProvider: -
Access a ExchangeRate using the given currencies.
+
Access a ExchangeRate using the given currencies.
getExchangeRate(String, String) - Method in interface javax.money.convert.ExchangeRateProvider
getExchangeRate(MonetaryAmount) - Method in interface javax.money.convert.CurrencyConversion: -
Access a ExchangeRate using the given currencies.
+
Get the ExchangeRate applied for the given MonetaryAmount + .
getExchangeRateChain() - Method in interface javax.money.convert.ExchangeRate
getExchangeRateChain() - Method in interface javax.money.convert.ExchangeRate: Access the chain of exchange rates.
getExchangeRateProvider() - Method in interface javax.money.convert.CurrencyConversion
getExchangeRateProvider() - Method in interface javax.money.convert.CurrencyConversion: -
Access the underlying ExchangeRateProvider.
+
Access the underlying ExchangeRateProvider.
getExchangeRateProvider(String...) - Static method in class javax.money.convert.MonetaryConversions
getExchangeRateProvider(String...) - Static method in class javax.money.convert.MonetaryConversions: -
Access an instance of CurrencyConversion using the given +
Access an instance of CurrencyConversion using the given providers as a provider chain.
getExchangeRateProvider(ExchangeRateProviderSupplier, ExchangeRateProviderSupplier...) - Static method in class javax.money.convert.MonetaryConversions
getExchangeRateProvider(String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Access an instance of CurrencyConversion using the - ExchangeRateProviderSupplier.
+
Access a compound instance of an ExchangeRateProvider based on the given provider chain.
getExchangeRateProvider(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions
getExchangeRateProvider(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions: -
Access an instance of CurrencyConversion using the given +
Access an instance of CurrencyConversion using the given providers as a provider chain.
getExchangeRateProvider(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getExchangeRateProvider(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Access an instance of ExchangeRateProvider.
+
Access an instance of ExchangeRateProvider.
getExchangeRateProvider(String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getExchangeRateProvider(ExchangeRateProviderSupplier, ExchangeRateProviderSupplier...) - Static method in class javax.money.convert.MonetaryConversions: -
Access a compound instance of an ExchangeRateProvider based on the given provider chain.
+
Access an instance of CurrencyConversion using the + ExchangeRateProviderSupplier.
getExchangeRateProviders(String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getExchangeRateProviders(String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Access the current registered ExchangeRateProvider instances.
+
Access the current registered ExchangeRateProvider instances.
getFactor() - Method in interface javax.money.convert.ExchangeRate
getFactor() - Method in interface javax.money.convert.ExchangeRate: Access the rate's bid factor.
getFactory() - Method in interface javax.money.MonetaryAmount
getFactory() - Method in interface javax.money.MonetaryAmount: Creates a new MonetaryAmountFactory, returning the same implementation type Hereby - this given amount is used as a template, so reusing the CurrencyUnit, its numeric - value, the algorithmic implementation as well as the current MonetaryContext.
+ this given amount is used as a template, so reusing the CurrencyUnit, its numeric + value, the algorithmic implementation as well as the current MonetaryContext.
getFloat(String) - Method in class javax.money.AbstractContext
getFloat(String) - Method in class javax.money.AbstractContext: Access a Float attribute.
getFormatName() - Method in class javax.money.format.AmountFormatContext
getFormatName() - Method in class javax.money.format.AmountFormatContext: -
Access the style's Locale.
+
Access the style's Locale.
getFormatName() - Method in class javax.money.format.AmountFormatQuery
getFormatName() - Method in class javax.money.format.AmountFormatQuery: Gets a style's id.
getFormatProviderNames() - Static method in class javax.money.format.MonetaryFormats
getFormatProviderNames() - Static method in class javax.money.format.MonetaryFormats: Get the names of the currently registered format providers.
getInput() - Method in exception javax.money.format.MonetaryParseException
getInput() - Method in exception javax.money.format.MonetaryParseException: Returns the string that was being parsed.
getInt(String) - Method in class javax.money.AbstractContext
getInt(String) - Method in class javax.money.AbstractContext: Access an Integer attribute.
getKeys(Class<?>) - Method in class javax.money.AbstractContext
getKeys(Class<?>) - Method in class javax.money.AbstractContext: Get the present keys of all entries with a given type, checking hereby if assignable.
getLocale() - Method in class javax.money.format.AmountFormatContext
getLocale() - Method in class javax.money.format.AmountFormatContext: Access the context's Locale.
getLocale() - Method in class javax.money.format.AmountFormatQuery
getLocale() - Method in class javax.money.format.AmountFormatQuery: Gets a Locale to be applied.
getLocale() - Method in exception javax.money.UnknownCurrencyException
getLocale() - Method in exception javax.money.UnknownCurrencyException: -
Access the invalid Locale.
+
Access the invalid Locale.
getLong(String) - Method in class javax.money.AbstractContext
getLong(String) - Method in class javax.money.AbstractContext: Access a Long attribute.
getMaximalMonetaryContext() - Method in interface javax.money.MonetaryAmountFactory
getMaximalMonetaryContext() - Method in interface javax.money.MonetaryAmountFactory: -
Returns the maximal MonetaryContext supported, for requests that exceed these maximal - capabilities, an ArithmeticException must be thrown.
+
Returns the maximal MonetaryContext supported, for requests that exceed these maximal + capabilities, an ArithmeticException must be thrown.
getMaximalMonetaryContext() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi
getMaximalMonetaryContext() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi: -
Returns the maximal MonetaryContext supported, for requests that exceed these maximal - capabilities, an ArithmeticException must be thrown.
+
Returns the maximal MonetaryContext supported, for requests that exceed these maximal + capabilities, an ArithmeticException must be thrown.
getMaxNumber() - Method in interface javax.money.MonetaryAmountFactory
getMaxNumber() - Method in interface javax.money.MonetaryAmountFactory: Get the maximum possible number that this type can represent.
getMaxScale() - Method in class javax.money.MonetaryAmountFactoryQuery
getMaxScale() - Method in class javax.money.MonetaryAmountFactoryQuery: Get the maximal scale to be supported.
getMaxScale() - Method in class javax.money.MonetaryContext
getMaxScale() - Method in class javax.money.MonetaryContext: Get the maximal scale supported, always >= -1.
getMinNumber() - Method in interface javax.money.MonetaryAmountFactory
getMinNumber() - Method in interface javax.money.MonetaryAmountFactory: Get the minimum possible number that this type can represent.
getMonetaryAmountFactory() - Method in class javax.money.format.AmountFormatQuery
getMonetaryAmountFactory() - Method in class javax.money.format.AmountFormatQuery: -
Gets the MonetaryAmountFactoryQuery to be used for accessing .MonetaryAmountFactory, when amount's are parsed.
+
Gets the MonetaryAmountFactoryQuery to be used for accessing .MonetaryAmountFactory, when amount's are parsed.
getNumber() - Method in interface javax.money.NumberSupplier
getNumber() - Method in interface javax.money.NumberSupplier: -
Gets the corresponding NumberValue.
+
Gets the corresponding NumberValue.
getNumberType() - Method in class javax.money.NumberValue
getNumberType() - Method in class javax.money.NumberValue: Get the numeric implementation type, that is the base of this number.
getNumericCode() - Method in interface javax.money.CurrencyUnit
getNumericCode() - Method in interface javax.money.CurrencyUnit: Gets a numeric currency code.
getNumericCodes() - Method in class javax.money.CurrencyQuery
getNumericCodes() - Method in class javax.money.CurrencyQuery: Gets the numeric codes.
getParseFactory() - Method in class javax.money.format.AmountFormatContext
getParseFactory() - Method in class javax.money.format.AmountFormatContext: -
Access the format's MonetaryAmountFactory that is used to of new amounts during +
Access the format's MonetaryAmountFactory that is used to of new amounts during parsing.
getPrecision() - Method in class javax.money.MonetaryAmountFactoryQuery
getPrecision() - Method in class javax.money.MonetaryAmountFactoryQuery: Get the maximal precision to be supported.
getPrecision() - Method in class javax.money.MonetaryContext
getPrecision() - Method in class javax.money.MonetaryContext: Returns the precision setting.
getPrecision() - Method in class javax.money.NumberValue
getPrecision() - Method in class javax.money.NumberValue: Returns the precision of this MonetaryAmount.
getPriority() - Method in interface javax.money.spi.ServiceProvider
getPriority() - Method in interface javax.money.spi.ServiceProvider: This method allows to define a priority for a registered ServiceProvider instance.
getProviderName() - Method in class javax.money.AbstractContext
getProviderName() - Method in class javax.money.AbstractContext: Get the provider name of this context.
getProviderName() - Method in class javax.money.convert.ConversionContext
getProviderName() - Method in class javax.money.convert.ConversionContext: Get the provider of this rate.
getProviderName() - Method in interface javax.money.spi.CurrencyProviderSpi
getProviderName() - Method in interface javax.money.spi.CurrencyProviderSpi: The unique name of this currency provider instance.
getProviderName() - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi
getProviderName() - Method in interface javax.money.spi.MonetaryAmountFormatProviderSpi: Access the provider's name.
getProviderName() - Method in interface javax.money.spi.RoundingProviderSpi
getProviderName() - Method in interface javax.money.spi.RoundingProviderSpi: Get the provider's unique name.
getProviderNames() - Method in class javax.money.AbstractQuery
getProviderNames() - Method in class javax.money.AbstractQuery: Returns the providers and their ordering to be considered.
getProviderNames() - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
getProviderNames() - Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi: +
Get the names of all current registered providers.
+
getProviderNames() - Method in class javax.money.format.MonetaryFormats.DefaultMonetaryFormatsSingletonSpi
getProviderNames() - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
getProviderNames() - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: Get all currently registered provider names.
getProviderNames() - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
getProviderNames() - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: Access a list of the currently registered providers.
getProviderNames() - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
getProviderNames() - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: Get the names of the currently registered format providers.
getProviderNames() - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getProviderNames() - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: Allows to access the names of the current registered rounding providers.
getQueryInclusionPolicy() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi
getQueryInclusionPolicy() - Method in interface javax.money.spi.MonetaryAmountFactoryProviderSpi: Method that determines if this factory should be considered for general evaluation of - matching MonetaryAmount implementation types when calling - Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery).
+ matching MonetaryAmount implementation types when calling + Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery).
getRateType() - Method in class javax.money.convert.ConversionContext
getRateType() - Method in class javax.money.convert.ConversionContext: Get the deferred flag.
getRateTypes() - Method in class javax.money.convert.ConversionQuery
getRateTypes() - Method in class javax.money.convert.ConversionQuery: Get the rate types set.
getRateTypes() - Method in class javax.money.convert.ProviderContext
getRateTypes() - Method in class javax.money.convert.ProviderContext: Get the deferred flag.
getReversed(ExchangeRate) - Method in interface javax.money.convert.ExchangeRateProvider
getReversed(ExchangeRate) - Method in interface javax.money.convert.ExchangeRateProvider: -
The method reverses the ExchangeRate to a rate mapping from term - to base CurrencyUnit.
+
The method reverses the ExchangeRate to a rate mapping from term + to base CurrencyUnit.
getRounding(CurrencyUnit, String...) - Static method in class javax.money.Monetary
getRounding(String, String...) - Static method in class javax.money.Monetary: -
Creates an MonetaryOperator for rounding MonetaryAmount - instances given a currency.
+
Access an MonetaryOperator for custom rounding + MonetaryAmount instances.
getRounding(String, String...) - Static method in class javax.money.Monetary
getRounding(String, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Access an MonetaryOperator for custom rounding - MonetaryAmount instances.
+
Access a MonetaryRounding using the rounding name.
getRounding(RoundingQuery) - Static method in class javax.money.Monetary
getRounding(CurrencyUnit, String...) - Static method in class javax.money.Monetary: -
Access a MonetaryRounding using a possibly complex query.
+
Creates an MonetaryOperator for rounding MonetaryAmount + instances given a currency.
getRounding(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getRounding(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Access a MonetaryRounding for rounding MonetaryAmount +
Access a MonetaryRounding for rounding MonetaryAmount instances given a currency.
getRounding(String, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getRounding(RoundingQuery) - Static method in class javax.money.Monetary: -
Access a MonetaryRounding using the rounding name.
+
Access a MonetaryRounding using a possibly complex query.
getRounding(RoundingQuery) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getRounding(RoundingQuery) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: Query a specific rounding with the given query.
getRounding(RoundingQuery) - Method in interface javax.money.spi.RoundingProviderSpi
getRounding(RoundingQuery) - Method in interface javax.money.spi.RoundingProviderSpi: Evaluate the rounding that match the given query.
getRoundingContext() - Method in interface javax.money.MonetaryRounding
getRoundingContext() - Method in interface javax.money.MonetaryRounding: Access the rounding's context, which gives more details of the rounding instances such as @@ -1154,1138 +1165,1166 @@
G
any other attributes useful to describe the rounding
getRoundingName() - Method in class javax.money.RoundingContext
getRoundingName() - Method in class javax.money.RoundingContext: Get the (custom) rounding id.
getRoundingName() - Method in class javax.money.RoundingQuery
getRoundingName() - Method in class javax.money.RoundingQuery: Gets the target rounding name.
getRoundingNames(String...) - Static method in class javax.money.Monetary
getRoundingNames() - Method in interface javax.money.spi.RoundingProviderSpi: -
Allows to access the names of the current defined roundings.
+
Access the ids of the roundings defined by this provider.
+
getRoundingNames(String...) - Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi: +
Allows to access the identifiers of the current defined roundings.
getRoundingNames(String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getRoundingNames(String...) - Static method in class javax.money.Monetary: Allows to access the names of the current defined roundings.
getRoundingNames() - Method in interface javax.money.spi.RoundingProviderSpi
getRoundingNames(String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Access the ids of the roundings defined by this provider.
+
Allows to access the names of the current defined roundings.
getRoundingProviderNames() - Static method in class javax.money.Monetary
getRoundingProviderNames() - Static method in class javax.money.Monetary: Allows to access the names of the current registered providers.
getRoundings(RoundingQuery) - Static method in class javax.money.Monetary
getRoundings(RoundingQuery) - Method in class javax.money.DefaultMonetaryRoundingsSingletonSpi: +
Query all roundings matching the given RoundingQuery.
+
getRoundings(RoundingQuery) - Static method in class javax.money.Monetary: -
Access multiple MonetaryRounding instances using a possibly complex query
+
Access multiple MonetaryRounding instances using a possibly complex query
getRoundings(RoundingQuery) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
getRoundings(RoundingQuery) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Execute a query for MonetaryRounding.
+
Execute a query for MonetaryRounding.
getScale() - Method in class javax.money.NumberValue
getScale() - Method in class javax.money.NumberValue: Returns the scale of this MonetaryAmount.
getScale() - Method in class javax.money.RoundingQuery
getScale() - Method in class javax.money.RoundingQuery: Gets the target scale.
getService(Class<T>) - Static method in class javax.money.spi.Bootstrap
getService(Class<T>) - Static method in class javax.money.spi.Bootstrap: -
Delegate method for ServiceProvider.getServices(Class).
+
Delegate method for getServices(Class).
getService(Class<T>) - Method in interface javax.money.spi.ServiceProvider
getService(Class<T>) - Method in interface javax.money.spi.ServiceProvider: Access a single service, given its type.
getServices(Class<T>) - Static method in class javax.money.spi.Bootstrap
getServices(Class<T>) - Static method in class javax.money.spi.Bootstrap: -
Delegate method for ServiceProvider.getServices(Class).
+
Delegate method for getServices(Class).
getServices(Class<T>) - Method in interface javax.money.spi.ServiceProvider
getServices(Class<T>) - Method in interface javax.money.spi.ServiceProvider: Access a list of services, given its type.
getTargetType() - Method in class javax.money.AbstractQuery
getTargetType() - Method in class javax.money.AbstractQuery: Gets the target implementation type required.
getTermCurrency() - Method in exception javax.money.convert.CurrencyConversionException
getTermCurrency() - Method in exception javax.money.convert.CurrencyConversionException: Gets the second currency at fault.
getText(String) - Method in class javax.money.AbstractContext
getText(String) - Method in class javax.money.AbstractContext: Access a String attribute.
getType(String) - Method in class javax.money.AbstractContext
getType(String) - Method in class javax.money.AbstractContext: Get the current attribute type.

- +

H

hashCode() - Method in class javax.money.AbstractContext
hashCode() - Method in class javax.money.AbstractContext
HISTORIC_CONVERSION - Static variable in class javax.money.convert.ConversionContext
HISTORIC - javax.money.convert.RateType: -
ConversionContext quering for any historic rates.
+
Historic rates, e.g.
+
HISTORIC_CONVERSION - Static variable in class javax.money.convert.ConversionContext: +
ConversionContext querying for any historic rates.

- +

I

importContext(AbstractContext, boolean) - Method in class javax.money.AbstractContextBuilder
importContext(AbstractContext) - Method in class javax.money.AbstractContextBuilder: -
Apply all attributes on the given context.
+
Apply all attributes on the given context, hereby existing entries are preserved.
importContext(AbstractContext) - Method in class javax.money.AbstractContextBuilder
importContext(AbstractContext, boolean) - Method in class javax.money.AbstractContextBuilder: -
Apply all attributes on the given context, hereby existing entries are preserved.
+
Apply all attributes on the given context.
init(ServiceProvider) - Static method in class javax.money.spi.Bootstrap
init(ServiceProvider) - Static method in class javax.money.spi.Bootstrap: -
Replace the current ServiceProvider in use.
+
Replace the current ServiceProvider in use.
intValueExact() - Method in class javax.money.NumberValue
intValueExact() - Method in class javax.money.NumberValue: Access the numeric value as int.
isAvailable(ConversionQuery) - Method in interface javax.money.convert.ExchangeRateProvider
isAvailable(String, String) - Method in interface javax.money.convert.ExchangeRateProvider: -
Checks if an ExchangeRate between two CurrencyUnit is +
Checks if an ExchangeRate between two CurrencyUnit is available from this provider.
isAvailable(CurrencyUnit, CurrencyUnit) - Method in interface javax.money.convert.ExchangeRateProvider
isAvailable(Locale, String...) - Static method in class javax.money.format.MonetaryFormats: -
Checks if an ExchangeRate between two CurrencyUnit is - available from this provider.
+
Checks if a MonetaryAmountFormat is available for the given Locale and providers.
isAvailable(String, String) - Method in interface javax.money.convert.ExchangeRateProvider
isAvailable(Locale, String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: -
Checks if an ExchangeRate between two CurrencyUnit is - available from this provider.
+
Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.
isAvailable(Locale, String...) - Static method in class javax.money.format.MonetaryFormats
isAvailable(ConversionQuery) - Method in interface javax.money.convert.ExchangeRateProvider: -
Checks if a MonetaryAmountFormat is available for the given Locale and providers.
+
Checks if an ExchangeRate between two CurrencyUnit is + available from this provider.
isAvailable(AmountFormatQuery) - Static method in class javax.money.format.MonetaryFormats
isAvailable(CurrencyUnit, CurrencyUnit) - Method in interface javax.money.convert.ExchangeRateProvider: -
Checks if a MonetaryAmountFormat is available for the given AmountFormatQuery.
+
Checks if an ExchangeRate between two CurrencyUnit is + available from this provider.
isAvailable(MonetaryAmountFactoryQuery) - Static method in class javax.money.Monetary
isAvailable(AmountFormatQuery) - Static method in class javax.money.format.MonetaryFormats: -
Allows to check if any of the getXXX methods return non empty/non null results of .MonetaryAmountFactory.
+
Checks if a MonetaryAmountFormat is available for the given AmountFormatQuery.
isAvailable(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi
isAvailable(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi: -
Checks if an MonetaryAmountFactory is matching the given query.
+
Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.
isAvailable(AmountFormatQuery) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
isAvailable(MonetaryAmountFactoryQuery) - Static method in class javax.money.Monetary: -
Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.
+
Allows to check if any of the getXXX methods return non empty/non null results of .MonetaryAmountFactory.
isAvailable(Locale, String...) - Method in interface javax.money.spi.MonetaryFormatsSingletonSpi
isAvailable(MonetaryAmountFactoryQuery) - Method in interface javax.money.spi.MonetaryAmountsSingletonQuerySpi: -
Checks if a MonetaryAmountFormat is available given a .AmountFormatQuery.
+
Checks if an MonetaryAmountFactory is matching the given query.
isConversionAvailable(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions
isConversionAvailable(String, String...) - Static method in class javax.money.convert.MonetaryConversions: -
Checks if a CurrencyConversion is available for the given parameters.
+
Checks if a CurrencyConversion is available for the given parameters.
isConversionAvailable(String, String...) - Static method in class javax.money.convert.MonetaryConversions
isConversionAvailable(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions: -
Checks if a CurrencyConversion is available for the given parameters.
+
Checks if a CurrencyConversion is available for the given parameters.
isConversionAvailable(CurrencyUnit, String...) - Static method in class javax.money.convert.MonetaryConversions
isConversionAvailable(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Checks if a CurrencyConversion is available for the given parameters.
+
Allows to quickly check, if a CurrencyConversion is accessible for the given + ConversionQuery.
isConversionAvailable(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
isConversionAvailable(CurrencyUnit, String...) - Static method in class javax.money.convert.MonetaryConversions: -
Allows to quickly check, if a CurrencyConversion is accessible for the given - ConversionQuery.
+
Checks if a CurrencyConversion is available for the given parameters.
isConversionAvailable(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
isConversionAvailable(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Allows to quickly check, if a CurrencyConversion is accessible for the given - ConversionQuery.
+
Allows to quickly check, if a CurrencyConversion is accessible for the given + ConversionQuery.
isCurrencyAvailable(String, String...) - Static method in class javax.money.Monetary
isCurrencyAvailable(String, String...) - Static method in class javax.money.Monetary: -
Allows to check if a CurrencyUnit instance is defined, i.e.
+
Allows to check if a CurrencyUnit instance is defined, i.e.
isCurrencyAvailable(Locale, String...) - Static method in class javax.money.Monetary
isCurrencyAvailable(String, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: -
Allows to check if a CurrencyUnit instance is - defined, i.e.
+
Allows to check if a CurrencyUnit instance is defined, i.e.
isCurrencyAvailable(CurrencyQuery) - Method in interface javax.money.spi.CurrencyProviderSpi
isCurrencyAvailable(Locale, String...) - Static method in class javax.money.Monetary: -
Checks if a CurrencyUnit instances matching the given - CurrencyContext is available from this provider.
+
Allows to check if a CurrencyUnit instance is + defined, i.e.
isCurrencyAvailable(String, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
isCurrencyAvailable(Locale, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi: -
Allows to check if a CurrencyUnit instance is defined, i.e.
+
Allows to check if a CurrencyUnit instance is + defined, i.e.
isCurrencyAvailable(Locale, String...) - Method in interface javax.money.spi.MonetaryCurrenciesSingletonSpi
isCurrencyAvailable(CurrencyQuery) - Method in interface javax.money.spi.CurrencyProviderSpi: -
Allows to check if a CurrencyUnit instance is - defined, i.e.
+
Checks if a CurrencyUnit instances matching the given + CurrencyContext is available from this provider.
isDerived() - Method in interface javax.money.convert.ExchangeRate
isDerived() - Method in interface javax.money.convert.ExchangeRate: Allows to evaluate if this exchange rate is a derived exchange rate.
isEmpty() - Method in class javax.money.AbstractContext
isEmpty() - Method in class javax.money.AbstractContext: Checks if the current instance has no attributes set.
isEqualTo(MonetaryAmount) - Method in interface javax.money.MonetaryAmount
isEqualTo(MonetaryAmount) - Method in interface javax.money.MonetaryAmount: -
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing +
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing zeroes and different numeric capabilities.
isExchangeRateProviderAvailable(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions
isExchangeRateProviderAvailable(ConversionQuery) - Static method in class javax.money.convert.MonetaryConversions: -
Checks if a ExchangeRateProvider is available for the given parameters.
+
Checks if a ExchangeRateProvider is available for the given parameters.
isExchangeRateProviderAvailable(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi
isExchangeRateProviderAvailable(ConversionQuery) - Method in interface javax.money.spi.MonetaryConversionsSingletonSpi: -
Allows to quickly check, if a ExchangeRateProvider is accessible for the given - ConversionQuery.
+
Allows to quickly check, if a ExchangeRateProvider is accessible for the given + ConversionQuery.
isFixedScale() - Method in class javax.money.MonetaryAmountFactoryQuery
isFixedScale() - Method in class javax.money.MonetaryAmountFactoryQuery: Get the fixed scale flag to be supported.
isFixedScale() - Method in class javax.money.MonetaryContext
isFixedScale() - Method in class javax.money.MonetaryContext: Allows to check if minScale == maxScale.
isGreaterThan(MonetaryAmount) - Method in interface javax.money.MonetaryAmount
isGreaterThan(MonetaryAmount) - Method in interface javax.money.MonetaryAmount: -
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing +
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing zeroes and different numeric capabilities.
isGreaterThanOrEqualTo(MonetaryAmount) - Method in interface javax.money.MonetaryAmount
isGreaterThanOrEqualTo(MonetaryAmount) - Method in interface javax.money.MonetaryAmount: -
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing +
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing zeroes and different numeric capabilities.
isLessThan(MonetaryAmount) - Method in interface javax.money.MonetaryAmount
isLessThan(MonetaryAmount) - Method in interface javax.money.MonetaryAmount: -
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing +
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing zeroes and different numeric capabilities.
isLessThanOrEqualTo(MonetaryAmount) - Method in interface javax.money.MonetaryAmount
isLessThanOrEqualTo(MonetaryAmount) - Method in interface javax.money.MonetaryAmount: -
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing +
Compares two instances of MonetaryAmount, hereby ignoring non significant trailing zeroes and different numeric capabilities.
isNegative() - Method in interface javax.money.MonetaryAmount
isNegative() - Method in interface javax.money.MonetaryAmount: Checks if a MonetaryAmount is negative.
isNegativeOrZero() - Method in interface javax.money.MonetaryAmount
isNegativeOrZero() - Method in interface javax.money.MonetaryAmount: Checks if a MonetaryAmount is negative or zero.
isPositive() - Method in interface javax.money.MonetaryAmount
isPositive() - Method in interface javax.money.MonetaryAmount: Checks if a MonetaryAmount is positive.
isPositiveOrZero() - Method in interface javax.money.MonetaryAmount
isPositiveOrZero() - Method in interface javax.money.MonetaryAmount: Checks if a MonetaryAmount is positive or zero.
isRoundingAvailable(String, String...) - Static method in class javax.money.Monetary
isRoundingAvailable(String, String...) - Static method in class javax.money.Monetary: -
Checks if a MonetaryRounding is available given a roundingId.
+
Checks if a MonetaryRounding is available given a roundingId.
isRoundingAvailable(CurrencyUnit, String...) - Static method in class javax.money.Monetary
isRoundingAvailable(String, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Checks if a MonetaryRounding is available given a roundingId.
+
Checks if a MonetaryRounding is available given a roundingId.
isRoundingAvailable(RoundingQuery) - Static method in class javax.money.Monetary
isRoundingAvailable(CurrencyUnit, String...) - Static method in class javax.money.Monetary: -
Checks if a MonetaryRounding matching the query is available.
+
Checks if a MonetaryRounding is available given a roundingId.
isRoundingAvailable(RoundingQuery) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
isRoundingAvailable(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Checks if any MonetaryRounding is matching the given query.
+
Checks if a MonetaryRounding is available given a CurrencyUnit.
isRoundingAvailable(String, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
isRoundingAvailable(RoundingQuery) - Static method in class javax.money.Monetary: -
Checks if a MonetaryRounding is available given a roundingId.
+
Checks if a MonetaryRounding matching the query is available.
isRoundingAvailable(CurrencyUnit, String...) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi
isRoundingAvailable(RoundingQuery) - Method in interface javax.money.spi.MonetaryRoundingsSingletonSpi: -
Checks if a MonetaryRounding is available given a CurrencyUnit.
+
Checks if any MonetaryRounding is matching the given query.
isZero() - Method in interface javax.money.MonetaryAmount
isZero() - Method in interface javax.money.MonetaryAmount: Checks if an MonetaryAmount is zero.

- +

J

javax.money - package javax.money
java.money - module java.money
javax.money - package javax.money: Main package of the Money and Currency API.
javax.money.convert - package javax.money.convert
javax.money.convert - package javax.money.convert: Defines the monetary currency conversion API.
javax.money.format - package javax.money.format
javax.money.format - package javax.money.format: Money and Currency format API.
javax.money.spi - package javax.money.spi
javax.money.spi - package javax.money.spi: SPI interfaces of the Money and Currency API, including bootstrap logic.

- +

K

KEY_PROVIDER - Static variable in class javax.money.AbstractContext
KEY_PROVIDER - Static variable in class javax.money.AbstractContext: Key for storing the target providers to be queried
KEY_QUERY_PROVIDERS - Static variable in class javax.money.AbstractQuery
KEY_QUERY_PROVIDERS - Static variable in class javax.money.AbstractQuery: Key for storing the target providers to be queried
KEY_QUERY_TARGET_TYPE - Static variable in class javax.money.AbstractQuery
KEY_QUERY_TARGET_TYPE - Static variable in class javax.money.AbstractQuery: Key name for the target type attribute.
KEY_QUERY_TIMESTAMP - Static variable in class javax.money.AbstractQuery
KEY_QUERY_TIMESTAMP - Static variable in class javax.money.AbstractQuery: Key name for the timestamp attribute.

- +

L

longValueExact() - Method in class javax.money.NumberValue
longValueExact() - Method in class javax.money.NumberValue: Access the numeric value as long.

- +

M

Monetary - Class in javax.money
Monetary - Class in javax.money: -
Factory singleton for CurrencyUnit, MonetaryAmount and - MonetaryRounding instances as provided by the +
Factory singleton for CurrencyUnit, MonetaryAmount and + MonetaryRounding instances as provided by the different registered SPI instances.
MonetaryAmount - Interface in javax.money
MonetaryAmount - Interface in javax.money: Interface defining a monetary amount.
MonetaryAmountFactory<T extends MonetaryAmount> - Interface in javax.money
MonetaryAmountFactory<T extends MonetaryAmount> - Interface in javax.money: -
Factory for MonetaryAmount instances for a given type.
+
Factory for MonetaryAmount instances for a given type.
MonetaryAmountFactoryProviderSpi<T extends MonetaryAmount> - Interface in javax.money.spi
MonetaryAmountFactoryProviderSpi<T extends MonetaryAmount> - Interface in javax.money.spi: -
SPI (core): Implementations of this interface are used by the MonetaryAmountsSingletonSpi to evaluate the - correct MonetaryAmountFactory instances.
+
SPI (core): Implementations of this interface are used by the MonetaryAmountsSingletonSpi to evaluate the + correct MonetaryAmountFactory instances.
MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy - Enum in javax.money.spi
MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy - Enum in javax.money.spi: Determines how the factory should be considered when querying for matching implementation - types calling Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery) .
+ types calling Monetary.getAmountFactory(javax.money.MonetaryAmountFactoryQuery) .
MonetaryAmountFactoryQuery - Class in javax.money
MonetaryAmountFactoryQuery - Class in javax.money: -
Query to lookup instances of MonetaryAmountFactory, which are determined by the (minimal) +
Query to lookup instances of MonetaryAmountFactory, which are determined by the (minimal) capabilities required by the give use case.
MonetaryAmountFactoryQueryBuilder - Class in javax.money
MonetaryAmountFactoryQueryBuilder - Class in javax.money: -
Builder class for creating new instances of MonetaryAmountFactoryQuery that can be passed - to access MonetaryAmountFactory instances using a possible complex query.
+
Builder class for creating new instances of MonetaryAmountFactoryQuery that can be passed + to access MonetaryAmountFactory instances using a possible complex query.
MonetaryAmountFormat - Interface in javax.money.format
MonetaryAmountFormat - Interface in javax.money.format: - Formats instances of MonetaryAmount to a String or an Appendable.
+ Formats instances of MonetaryAmount to a String or an Appendable.
MonetaryAmountFormatProviderSpi - Interface in javax.money.spi
MonetaryAmountFormatProviderSpi - Interface in javax.money.spi: -
SPI (formatting) providing MonetaryAmountFormat instances.
+
SPI (formatting) providing MonetaryAmountFormat instances.
MonetaryAmountsSingletonQuerySpi - Interface in javax.money.spi
MonetaryAmountsSingletonQuerySpi - Interface in javax.money.spi: -
SPI (core) for the backing implementation of the Monetary singleton, implementing +
SPI (core) for the backing implementation of the Monetary singleton, implementing the query functionality for amounts.
MonetaryAmountsSingletonSpi - Interface in javax.money.spi
MonetaryAmountsSingletonSpi - Interface in javax.money.spi: -
SPI (core) for the backing implementation of the Monetary singleton.
+
SPI (core) for the backing implementation of the Monetary singleton.
MonetaryContext - Class in javax.money
MonetaryContext - Class in javax.money: -
This class models the meta data (mostly the numeric capabilities) of a MonetaryAmount in a +
This class models the meta data (mostly the numeric capabilities) of a MonetaryAmount in a platform independent way.
MonetaryContextBuilder - Class in javax.money
MonetaryContextBuilder - Class in javax.money: -
Builder class for creating new instances of MonetaryContext adding detailed information - about a MonetaryAmount instance.
+
Builder class for creating new instances of MonetaryContext adding detailed information + about a MonetaryAmount instance.
MonetaryConversions - Class in javax.money.convert
MonetaryConversions - Class in javax.money.convert: This singleton defines access to the exchange and currency conversion logic of JavaMoney.
MonetaryConversionsSingletonSpi - Interface in javax.money.spi
MonetaryConversionsSingletonSpi - Interface in javax.money.spi: SPI (conversion) that implements the functionality provided by the MonetaryConversions singleton accessor.
MonetaryCurrenciesSingletonSpi - Interface in javax.money.spi
MonetaryCurrenciesSingletonSpi - Interface in javax.money.spi: -
Factory singleton backing interface for Monetary that provides access to - different registered CurrencyProviderSpi instances.
+
Factory singleton backing interface for Monetary that provides access to + different registered CurrencyProviderSpi instances.
MonetaryException - Exception in javax.money
MonetaryException - Exception in javax.money: Exception thrown when an error occurs during monetary operations.
MonetaryException(String) - Constructor for exception javax.money.MonetaryException
MonetaryException(String) - Constructor for exception javax.money.MonetaryException: Creates an instance.
MonetaryException(String, Throwable) - Constructor for exception javax.money.MonetaryException
MonetaryException(String, Throwable) - Constructor for exception javax.money.MonetaryException: Creates an instance with the specified detail message and cause.
MonetaryFormats - Class in javax.money.format
MonetaryFormats - Class in javax.money.format: -
This class models the singleton accessor for MonetaryAmountFormat instances.
+
This class models the singleton accessor for MonetaryAmountFormat instances.
MonetaryFormats.DefaultMonetaryFormatsSingletonSpi - Class in javax.money.format
MonetaryFormats.DefaultMonetaryFormatsSingletonSpi - Class in javax.money.format: -
This class models the singleton accessor for MonetaryAmountFormat instances.
+
This class models the singleton accessor for MonetaryAmountFormat instances.
MonetaryFormatsSingletonSpi - Interface in javax.money.spi
MonetaryFormatsSingletonSpi - Interface in javax.money.spi: -
This interface models the singleton functionality of MonetaryFormats.
+
This interface models the singleton functionality of MonetaryFormats.
MonetaryOperator - Interface in javax.money
MonetaryOperator - Interface in javax.money: -
Represents an operation on a single MonetaryAmount that produces a - result of type MonetaryAmount.
+
Represents an operation on a single MonetaryAmount that produces a + result of type MonetaryAmount.
MonetaryParseException - Exception in javax.money.format
MonetaryParseException - Exception in javax.money.format: Signals that an error has been reached unexpectedly while parsing.
MonetaryParseException(String, CharSequence, int) - Constructor for exception javax.money.format.MonetaryParseException
MonetaryParseException(CharSequence, int) - Constructor for exception javax.money.format.MonetaryParseException: -
Constructs a MonetaryParseException with the specified detail message, - parsed text and index.
+
Constructs a MonetaryParseException with the parsed text and offset.
MonetaryParseException(CharSequence, int) - Constructor for exception javax.money.format.MonetaryParseException
MonetaryParseException(String, CharSequence, int) - Constructor for exception javax.money.format.MonetaryParseException: -
Constructs a MonetaryParseException with the parsed text and offset.
+
Constructs a MonetaryParseException with the specified detail message, + parsed text and index.
MonetaryQuery<R> - Interface in javax.money
MonetaryQuery<R> - Interface in javax.money: Strategy for querying a monetary amount.
MonetaryRounding - Interface in javax.money
MonetaryRounding - Interface in javax.money: Interface representing a monetary rounding.
MonetaryRoundingsSingletonSpi - Interface in javax.money.spi
MonetaryRoundingsSingletonSpi - Interface in javax.money.spi: This class models the accessor for rounding instances, modeled as - MonetaryOperator.
+ MonetaryOperator.
multiply(long) - Method in interface javax.money.MonetaryAmount
multiply(double) - Method in interface javax.money.MonetaryAmount: -
Returns a MonetaryAmount whose value is (this × - multiplicand), and whose scale is this.scale() + - multiplicand.scale().
+
Returns a MonetaryAmount whose value is (this × + multiplicand), and whose scale is this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale().
multiply(double) - Method in interface javax.money.MonetaryAmount
multiply(long) - Method in interface javax.money.MonetaryAmount: -
Returns a MonetaryAmount whose value is (this × - multiplicand), and whose scale is this.scale() + - multiplicand.scale().
+
Returns a MonetaryAmount whose value is (this × + multiplicand), and whose scale is this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale().
multiply(Number) - Method in interface javax.money.MonetaryAmount
multiply(Number) - Method in interface javax.money.MonetaryAmount: -
Returns a MonetaryAmount whose value is (this × - multiplicand), and whose scale is this.scale() + - multiplicand.scale().
+
Returns a MonetaryAmount whose value is (this × + multiplicand), and whose scale is this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale().

- +

N

negate() - Method in interface javax.money.MonetaryAmount
negate() - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is -this, and whose scale is - this.scale().
+ this.getContext().getMaxScale(), with rounding according to the context settings.
NumberSupplier - Interface in javax.money
NEVER - javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy: -
Represents a supplier of NumberValue-valued results.
+
Never consider this factory in a query for a matching MonetaryAmount + implementation.
NumberValue - Class in javax.money
NumberSupplier - Interface in javax.money: -
Instances of this class allow to externalize the numeric value of a MonetaryAmount.
+
+ Represents a supplier of NumberValue-valued results.
NumberValue() - Constructor for class javax.money.NumberValue
numberValue(Class<T>) - Method in class javax.money.NumberValue
numberValue(Class<T>) - Method in class javax.money.NumberValue: Access the numeric value as Number.
numberValueExact(Class<T>) - Method in class javax.money.NumberValue
NumberValue - Class in javax.money: +
Instances of this class allow to externalize the numeric value of a MonetaryAmount.
+
NumberValue() - Constructor for class javax.money.NumberValue
numberValueExact(Class<T>) - Method in class javax.money.NumberValue: Access the numeric value as Number.

- +

O

of(String, RateType) - Static method in class javax.money.convert.ConversionContext
of() - Static method in class javax.money.convert.ConversionContext: -
Simple factory method for ConversionContext.
+
Simple factory method for ConversionContext.
of(RateType) - Static method in class javax.money.convert.ConversionContext
of() - Static method in class javax.money.convert.ConversionContextBuilder: -
Creates a ConversionContext for accessing rates of the given - type, without specifying the rate's provider.
+
Creates a new ConversionContextBuilder instance.
of() - Static method in class javax.money.convert.ConversionContext
of() - Static method in class javax.money.convert.ConversionQueryBuilder: -
Simple factory method for ConversionContext.
+
Creates a new ConversionQueryBuilder instance.
of(ConversionContext) - Static method in class javax.money.convert.ConversionContextBuilder
of() - Static method in class javax.money.CurrencyQueryBuilder: -
Creates a new ConversionContextBuilder instance.
+
Creates a new instance of CurrencyQueryBuilder.
of() - Static method in class javax.money.convert.ConversionContextBuilder
of() - Static method in class javax.money.MonetaryAmountFactoryQueryBuilder: -
Creates a new ConversionContextBuilder instance.
+
Creates a new instance of CurrencyQueryBuilder.
of() - Static method in class javax.money.convert.ConversionQueryBuilder
of() - Static method in class javax.money.MonetaryContextBuilder: -
Creates a new ConversionQueryBuilder instance.
+
Creates a new builder, hereby the target implementation type is required.
of(ConversionQuery) - Static method in class javax.money.convert.ConversionQueryBuilder
of() - Static method in class javax.money.RoundingQueryBuilder
of(Class<? extends MonetaryAmount>) - Static method in class javax.money.MonetaryContextBuilder: -
Creates a new ConversionQueryBuilder instance.
+
Creates a new builder, hereby the target implementation type is required.
of(String, RateType, RateType...) - Static method in class javax.money.convert.ProviderContext
of(String) - Static method in class javax.money.convert.ProviderContext: Creates a new ProviderContext based on the provider id and rate type(s).
of(String) - Static method in class javax.money.convert.ProviderContext
of(String) - Static method in class javax.money.CurrencyContextBuilder: -
Creates a new ProviderContext based on the provider id and rate type(s).
+
Creates a new builder.
of(String, RateType, RateType...) - Static method in class javax.money.convert.ProviderContextBuilder
of(String) - Static method in class javax.money.format.AmountFormatContextBuilder: -
Create a new ProviderContextBuilder instance.
+
Creates a new AmountFormatContextBuilder.
of(String, Collection<RateType>) - Static method in class javax.money.convert.ProviderContextBuilder
of(String) - Static method in class javax.money.format.AmountFormatQueryBuilder: -
Create a new ProviderContextBuilder instance.
+
Creates a new AmountFormatQueryBuilder.
of(String) - Static method in class javax.money.CurrencyContextBuilder
of(String, String) - Static method in class javax.money.RoundingContextBuilder: -
Creates a new builder.
+
Creates a new RoundingContextBuilder.
of(CurrencyContext) - Static method in class javax.money.CurrencyContextBuilder
of(String, Collection<RateType>) - Static method in class javax.money.convert.ProviderContextBuilder: -
Creates a new builder.
+
Create a new ProviderContextBuilder instance.
of() - Static method in class javax.money.CurrencyQueryBuilder
of(String, RateType) - Static method in class javax.money.convert.ConversionContext: -
Creates a new instance of CurrencyQueryBuilder.
+
Simple factory method for ConversionContext.
of(CurrencyQuery) - Static method in class javax.money.CurrencyQueryBuilder
of(String, RateType, RateType...) - Static method in class javax.money.convert.ProviderContext: -
Creates a new instance of CurrencyQueryBuilder.
+
Creates a new ProviderContext based on the provider id and rate type(s).
of(AmountFormatContext) - Static method in class javax.money.format.AmountFormatContextBuilder
of(String, RateType, RateType...) - Static method in class javax.money.convert.ProviderContextBuilder: -
Creates a new AmountFormatContextBuilder.
+
Create a new ProviderContextBuilder instance.
of(String) - Static method in class javax.money.format.AmountFormatContextBuilder
of(Locale) - Static method in class javax.money.format.AmountFormatContextBuilder: -
Creates a new AmountFormatContextBuilder.
+
Creates a new default AmountFormatContextBuilder for a formatter based on the locale specific + defaults.
of(Locale) - Static method in class javax.money.format.AmountFormatContextBuilder
of(Locale) - Static method in class javax.money.format.AmountFormatQueryBuilder: -
Creates a new default AmountFormatContextBuilder for a formatter based on the locale specific +
Creates a new default AmountFormatQueryBuilder for a formatter based on the + locale specific defaults.
of(Locale, String...) - Static method in class javax.money.format.AmountFormatQuery
of(Locale, String...) - Static method in class javax.money.format.AmountFormatQuery: -
Creates a simple format query based on a singlet Locale, similar to (java.util.Locale).
+
Creates a simple format query based on a single Locale, similar to (java.util.Locale).
of(AmountFormatQuery) - Static method in class javax.money.format.AmountFormatQueryBuilder
of(ConversionContext) - Static method in class javax.money.convert.ConversionContextBuilder: -
Creates a new AmountFormatQueryBuilder and initializes it with the values from {@code formatQuery.
+
Creates a new ConversionContextBuilder instance.
of(String) - Static method in class javax.money.format.AmountFormatQueryBuilder
of(ConversionQuery) - Static method in class javax.money.convert.ConversionQueryBuilder: -
Creates a new AmountFormatQueryBuilder.
+
Creates a new ConversionQueryBuilder instance.
of(Locale) - Static method in class javax.money.format.AmountFormatQueryBuilder
of(RateType) - Static method in class javax.money.convert.ConversionContext: -
Creates a new default AmountFormatQueryBuilder for a formatter based on the - locale specific - defaults.
+
Creates a ConversionContext for accessing rates of the given + type, without specifying the rate's provider.
of() - Static method in class javax.money.MonetaryAmountFactoryQueryBuilder
of(CurrencyContext) - Static method in class javax.money.CurrencyContextBuilder: -
Creates a new instance of CurrencyQueryBuilder.
+
Creates a new builder.
of(MonetaryAmountFactoryQuery) - Static method in class javax.money.MonetaryAmountFactoryQueryBuilder
of(CurrencyQuery) - Static method in class javax.money.CurrencyQueryBuilder: -
Creates a new instance of CurrencyQueryBuilder.
+
Creates a new instance of CurrencyQueryBuilder.
of() - Static method in class javax.money.MonetaryContextBuilder
of(AmountFormatContext) - Static method in class javax.money.format.AmountFormatContextBuilder: -
Creates a new builder, hereby the target implementation type is required.
+
Creates a new AmountFormatContextBuilder.
of(MonetaryContext) - Static method in class javax.money.MonetaryContextBuilder
of(AmountFormatQuery) - Static method in class javax.money.format.AmountFormatQueryBuilder: -
Creates a new builder, using an existing MonetaryContext as a template.
+
Creates a new AmountFormatQueryBuilder and initializes it with the values from formatQuery.
of(Class<? extends MonetaryAmount>) - Static method in class javax.money.MonetaryContextBuilder
of(MonetaryAmountFactoryQuery) - Static method in class javax.money.MonetaryAmountFactoryQueryBuilder: -
Creates a new builder, hereby the target implementation type is required.
+
Creates a new instance of CurrencyQueryBuilder.
of(String, String) - Static method in class javax.money.RoundingContextBuilder
of(MonetaryContext) - Static method in class javax.money.MonetaryContextBuilder: -
Creates a new RoundingContextBuilder.
+
Creates a new builder, using an existing MonetaryContext as a template.
of(RoundingContext) - Static method in class javax.money.RoundingContextBuilder
of(RoundingContext) - Static method in class javax.money.RoundingContextBuilder: Creates a new RoundingContextBuilder.
of() - Static method in class javax.money.RoundingQueryBuilder
of(RoundingQuery) - Static method in class javax.money.RoundingQueryBuilder: Creates a new RoundingQueryBuilder.
of(RoundingQuery) - Static method in class javax.money.RoundingQueryBuilder
OTHER - javax.money.convert.RateType: -
Creates a new RoundingQueryBuilder.
+
Any other type of rates.
OTHER_CONVERSION - Static variable in class javax.money.convert.ConversionContext
OTHER_CONVERSION - Static variable in class javax.money.convert.ConversionContext: -
ConversionContext quering for any other rates.
+
ConversionContext querying for any other rates.

- +

P

parse(CharSequence) - Method in interface javax.money.format.MonetaryAmountFormat
parse(CharSequence) - Method in interface javax.money.format.MonetaryAmountFormat: -
Fully parses the text into an instance of MonetaryAmount.
+
Fully parses the text into an instance of MonetaryAmount.
plus() - Method in interface javax.money.MonetaryAmount
plus() - Method in interface javax.money.MonetaryAmount: -
Returns a MonetaryAmount whose value is +this, with rounding according to - the context settings.
+
Returns a MonetaryAmount whose value is +this.
print(Appendable, MonetaryAmount) - Method in interface javax.money.format.MonetaryAmountFormat
print(Appendable, MonetaryAmount) - Method in interface javax.money.format.MonetaryAmountFormat: -
Formats the given MonetaryAmount to a Appendable.
+
Formats the given MonetaryAmount to a Appendable.
ProviderContext - Class in javax.money.convert
ProviderContext - Class in javax.money.convert: -
This class describes what kind of ExchangeRates a .ExchangeRateProvider delivers, including the provider's name, rate type and additional data.
+
This class describes what kind of ExchangeRates a .ExchangeRateProvider delivers, including the provider's name, rate type and additional data.
ProviderContextBuilder - Class in javax.money.convert
ProviderContextBuilder - Class in javax.money.convert: -
Builder class to of ProviderContext instances.
+
Builder class to of ProviderContext instances.

- +

Q

query(MonetaryQuery<R>) - Method in interface javax.money.MonetaryAmount
query(MonetaryQuery<R>) - Method in interface javax.money.MonetaryAmount: Queries this monetary amount for a value.
queryFrom(MonetaryAmount) - Method in interface javax.money.MonetaryQuery
queryFrom(MonetaryAmount) - Method in interface javax.money.MonetaryQuery: Queries the specified monetary amount.

- +

R

RateType - Enum in javax.money.convert
RateType - Enum in javax.money.convert: -
This enumeration defines the different type of rates that can be provided by .ExchangeRateProvider implementations.
+
This enumeration defines the different type of rates that can be provided by .ExchangeRateProvider implementations.
REALTIME_CONVERSION - Static variable in class javax.money.convert.ConversionContext
REALTIME - javax.money.convert.RateType: -
ConversionContext quering for real-time rates.
+
Real-time rates should be as adequate as possible, basically not more than a few milliseconds late.
remainder(long) - Method in interface javax.money.MonetaryAmount
REALTIME_CONVERSION - Static variable in class javax.money.convert.ConversionContext: +
ConversionContext querying for real-time rates.
+
remainder(double) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this % divisor.
remainder(double) - Method in interface javax.money.MonetaryAmount
remainder(long) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this % divisor.
remainder(Number) - Method in interface javax.money.MonetaryAmount
remainder(Number) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this % divisor.
removeAttributes(String...) - Method in class javax.money.AbstractContextBuilder
removeAttributes(String...) - Method in class javax.money.AbstractContextBuilder: Removes an entry of a certain keys.
round(MathContext) - Method in class javax.money.NumberValue
round(MathContext) - Method in class javax.money.NumberValue: -
Access the current NumberValue rounded using the given MathContext.
+
Access the current NumberValue rounded using the given MathContext.
RoundingContext - Class in javax.money
RoundingContext - Class in javax.money: -
This class models the spec/configuration for a rounding, modeled as MonetaryRounding in a +
This class models the spec/configuration for a rounding, modeled as MonetaryRounding in a platform independent way.
RoundingContextBuilder - Class in javax.money
RoundingContextBuilder - Class in javax.money: -
Builder class for creating new instances of RoundingContext adding detailed information - about a MonetaryRounding instance.
+
Builder class for creating new instances of RoundingContext adding detailed information + about a MonetaryRounding instance.
RoundingProviderSpi - Interface in javax.money.spi
RoundingProviderSpi - Interface in javax.money.spi: This SPI allows to extends/override the roundings available for - CurrencyUnit.
+ CurrencyUnit.
RoundingQuery - Class in javax.money
RoundingQuery - Class in javax.money: -
Query for accessing instances of MonetaryRounding.
+
Query for accessing instances of MonetaryRounding.
RoundingQueryBuilder - Class in javax.money
RoundingQueryBuilder - Class in javax.money: Builder used to construct new instances of RoundingQuery}.

- +

S

scaleByPowerOfTen(int) - Method in interface javax.money.MonetaryAmount
scaleByPowerOfTen(int) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose numerical value is equal to ( this * 10ⁿ).
ServiceProvider - Interface in javax.money.spi
ServiceProvider - Interface in javax.money.spi: This class models the component that is managing the lifecycle of the monetary services used by the Money and Currency API.
set(String, int) - Method in class javax.money.AbstractContextBuilder
set(Class<T>, T) - Method in class javax.money.AbstractContextBuilder: -
Sets an Integer attribute.
+
Sets an attribute, using attribute.getClass() as attribute + type.
set(String, boolean) - Method in class javax.money.AbstractContextBuilder
set(Object) - Method in class javax.money.AbstractContextBuilder: -
Sets an Boolean attribute.
+
Sets an attribute, using attribute.getClass() as attribute + type and attribute.getClass().getName() as attribute + name.
set(String, long) - Method in class javax.money.AbstractContextBuilder
set(String, boolean) - Method in class javax.money.AbstractContextBuilder: -
Sets an Long attribute.
+
Sets an Boolean attribute.
set(String, float) - Method in class javax.money.AbstractContextBuilder
set(String, char) - Method in class javax.money.AbstractContextBuilder: -
Sets an Float attribute.
+
Sets an Character attribute.
set(String, double) - Method in class javax.money.AbstractContextBuilder
set(String, double) - Method in class javax.money.AbstractContextBuilder: Sets an Double attribute.
set(String, char) - Method in class javax.money.AbstractContextBuilder
set(String, float) - Method in class javax.money.AbstractContextBuilder: -
Sets an Character attribute.
+
Sets an Float attribute.
set(Object) - Method in class javax.money.AbstractContextBuilder
set(String, int) - Method in class javax.money.AbstractContextBuilder: -
Sets an attribute, using attribute.getClass() as attribute - type and attribute.getClass().getName() as attribute - name.
+
Sets an Integer attribute.
set(String, Object) - Method in class javax.money.AbstractContextBuilder
set(String, long) - Method in class javax.money.AbstractContextBuilder: -
Sets an attribute, using attribute.getClass() as attribute - type.
+
Sets an Long attribute.
set(Class<T>, T) - Method in class javax.money.AbstractContextBuilder
set(String, Object) - Method in class javax.money.AbstractContextBuilder: Sets an attribute, using attribute.getClass() as attribute type.
set(List<String>) - Method in class javax.money.AbstractQueryBuilder
set(List<String>) - Method in class javax.money.AbstractQueryBuilder: Set the providers to be considered.
setAmount(MonetaryAmount) - Method in interface javax.money.MonetaryAmountFactory
setAmount(MonetaryAmount) - Method in interface javax.money.MonetaryAmountFactory: -
Uses an arbitrary MonetaryAmount to initialize this factory.
+
Uses an arbitrary MonetaryAmount to initialize this factory.
setAmountType(Class<? extends MonetaryAmount>) - Method in class javax.money.MonetaryContextBuilder
setAmountType(Class<? extends MonetaryAmount>) - Method in class javax.money.MonetaryContextBuilder: Set the MonetaryAmount implementation class.
setBaseCurrency(CurrencyUnit) - Method in class javax.money.convert.ConversionQueryBuilder
setBaseCurrency(String) - Method in class javax.money.convert.ConversionQueryBuilder: Sets the base currency.
setBaseCurrency(String) - Method in class javax.money.convert.ConversionQueryBuilder
setBaseCurrency(CurrencyUnit) - Method in class javax.money.convert.ConversionQueryBuilder: Sets the base currency.
setContext(MonetaryContext) - Method in interface javax.money.MonetaryAmountFactory
setContext(MonetaryContext) - Method in interface javax.money.MonetaryAmountFactory: -
Sets the MonetaryContext to be used.
+
Sets the MonetaryContext to be used.
setCountries(Locale...) - Method in class javax.money.CurrencyQueryBuilder
setCountries(Locale...) - Method in class javax.money.CurrencyQueryBuilder: Sets the country for which currencies should be requested.
setCurrency(String) - Method in interface javax.money.MonetaryAmountFactory
setCurrency(String) - Method in interface javax.money.MonetaryAmountFactory: -
Sets the CurrencyUnit to be used.
+
Sets the CurrencyUnit to be used.
setCurrency(CurrencyUnit) - Method in interface javax.money.MonetaryAmountFactory
setCurrency(CurrencyUnit) - Method in interface javax.money.MonetaryAmountFactory: -
Sets the CurrencyUnit to be used.
+
Sets the CurrencyUnit to be used.
setCurrency(CurrencyUnit) - Method in class javax.money.RoundingContextBuilder
setCurrency(CurrencyUnit) - Method in class javax.money.RoundingContextBuilder: -
Get the basic CurrencyUnit, which is based for this rounding type.
+
Get the basic CurrencyUnit, which is based for this rounding type.
setCurrency(CurrencyUnit) - Method in class javax.money.RoundingQueryBuilder
setCurrency(CurrencyUnit) - Method in class javax.money.RoundingQueryBuilder: -
Sets the target CurrencyUnit, which defines a rounding targeting a concrete CurrencyUnit.
+
Sets the target CurrencyUnit, which defines a rounding targeting a concrete CurrencyUnit.
setCurrencyCodes(String...) - Method in class javax.money.CurrencyQueryBuilder
setCurrencyCodes(String...) - Method in class javax.money.CurrencyQueryBuilder: Sets the currency code, or the regular expression to select codes.
setFixedScale(boolean) - Method in class javax.money.MonetaryAmountFactoryQueryBuilder
setFixedScale(boolean) - Method in class javax.money.MonetaryAmountFactoryQueryBuilder: Sets the flag if the scale should fixed, meaning minimal scale and maximal scale are always equally sized.
setFixedScale(boolean) - Method in class javax.money.MonetaryContextBuilder
setFixedScale(boolean) - Method in class javax.money.MonetaryContextBuilder: Set the flag if the scale should fixed.
setFormatName(String) - Method in class javax.money.format.AmountFormatContextBuilder
setFormatName(String) - Method in class javax.money.format.AmountFormatContextBuilder: Sets a format's name.
setFormatName(String) - Method in class javax.money.format.AmountFormatQueryBuilder
setFormatName(String) - Method in class javax.money.format.AmountFormatQueryBuilder: Sets a style's id.
setLocale(Locale) - Method in class javax.money.format.AmountFormatContextBuilder
setLocale(Locale) - Method in class javax.money.format.AmountFormatContextBuilder: Sets a Locale to be applied.
setLocale(Locale) - Method in class javax.money.format.AmountFormatQueryBuilder
setLocale(Locale) - Method in class javax.money.format.AmountFormatQueryBuilder: Sets a Locale to be applied.
setMaxScale(int) - Method in class javax.money.MonetaryAmountFactoryQueryBuilder
setMaxScale(int) - Method in class javax.money.MonetaryAmountFactoryQueryBuilder: Sets the maximal scale to be supported.
setMaxScale(int) - Method in class javax.money.MonetaryContextBuilder
setMaxScale(int) - Method in class javax.money.MonetaryContextBuilder: Set the maximal scale to be supported.
setMonetaryAmountFactory(MonetaryAmountFactory) - Method in class javax.money.format.AmountFormatContextBuilder
setMonetaryAmountFactory(MonetaryAmountFactory) - Method in class javax.money.format.AmountFormatContextBuilder: -
Sets the MonetaryContext to be used, when amount's are parsed.
+
Sets the MonetaryContext to be used, when amount's are parsed.
setMonetaryAmountFactory(MonetaryAmountFactory<?>) - Method in class javax.money.format.AmountFormatQueryBuilder
setMonetaryAmountFactory(MonetaryAmountFactory<?>) - Method in class javax.money.format.AmountFormatQueryBuilder: -
Sets the MonetaryAmountFactory to be used to of amounts during parsing.
+
Sets the MonetaryAmountFactory to be used to of amounts during parsing.
setMonetaryQuery(MonetaryAmountFactoryQuery) - Method in class javax.money.format.AmountFormatQueryBuilder
setMonetaryQuery(MonetaryAmountFactoryQuery) - Method in class javax.money.format.AmountFormatQueryBuilder: -
Sets the MonetaryContext to be used, when amount's are parsed.
+
Sets the MonetaryContext to be used, when amount's are parsed.
setNumber(double) - Method in interface javax.money.MonetaryAmountFactory
setNumber(double) - Method in interface javax.money.MonetaryAmountFactory: Sets the number to be used.
setNumber(long) - Method in interface javax.money.MonetaryAmountFactory
setNumber(long) - Method in interface javax.money.MonetaryAmountFactory: Sets the number to be used.
setNumber(Number) - Method in interface javax.money.MonetaryAmountFactory
setNumber(Number) - Method in interface javax.money.MonetaryAmountFactory: Sets the number to be used.
setNumericCodes(int...) - Method in class javax.money.CurrencyQueryBuilder
setNumericCodes(int...) - Method in class javax.money.CurrencyQueryBuilder: Set the numeric code.
setPrecision(int) - Method in class javax.money.MonetaryAmountFactoryQueryBuilder
setPrecision(int) - Method in class javax.money.MonetaryAmountFactoryQueryBuilder: Sets the required precision, the value 0 models unlimited precision.
setPrecision(int) - Method in class javax.money.MonetaryContextBuilder
setPrecision(int) - Method in class javax.money.MonetaryContextBuilder: Set the required precision.
setProviderName(String) - Method in class javax.money.AbstractContextBuilder
setProviderName(String) - Method in class javax.money.AbstractContextBuilder: Sets the provider.
setProviderName(String) - Method in class javax.money.AbstractQueryBuilder
setProviderName(String) - Method in class javax.money.AbstractQueryBuilder: Simple override, that sets the provider as provider to use.
setProviderNames(String...) - Method in class javax.money.AbstractQueryBuilder
setProviderNames(String...) - Method in class javax.money.AbstractQueryBuilder: Set the providers to be considered.
setProviderNames(List<String>) - Method in class javax.money.AbstractQueryBuilder
setProviderNames(List<String>) - Method in class javax.money.AbstractQueryBuilder: Set the providers to be considered.
setRateType(RateType) - Method in class javax.money.convert.ConversionContextBuilder
setRateType(RateType) - Method in class javax.money.convert.ConversionContextBuilder: Set the historic value.
setRateTypes(RateType...) - Method in class javax.money.convert.ConversionQueryBuilder
setRateTypes(Collection<RateType>) - Method in class javax.money.convert.ProviderContextBuilder: -
Set the providers to be considered.
+
Set the rate types.
setRateTypes(Set<RateType>) - Method in class javax.money.convert.ConversionQueryBuilder
setRateTypes(Set<RateType>) - Method in class javax.money.convert.ConversionQueryBuilder: Set the providers to be considered.
setRateTypes(RateType...) - Method in class javax.money.convert.ProviderContextBuilder
setRateTypes(RateType...) - Method in class javax.money.convert.ConversionQueryBuilder: -
Set the rate types.
+
Set the providers to be considered.
setRateTypes(Collection<RateType>) - Method in class javax.money.convert.ProviderContextBuilder
setRateTypes(RateType...) - Method in class javax.money.convert.ProviderContextBuilder: Set the rate types.
setRoundingName(String) - Method in class javax.money.RoundingQueryBuilder
setRoundingName(String) - Method in class javax.money.RoundingQueryBuilder: -
Sets the rounding names of the MonetaryRounding instances.
+
Sets the rounding names of the MonetaryRounding instances.
setScale(int) - Method in class javax.money.RoundingQueryBuilder
setScale(int) - Method in class javax.money.RoundingQueryBuilder: Sets the target scale.
setTargetType(Class<?>) - Method in class javax.money.AbstractQueryBuilder
setTargetType(Class<?>) - Method in class javax.money.AbstractQueryBuilder: Sets the target implementation type required.
setTermCurrency(CurrencyUnit) - Method in class javax.money.convert.ConversionQueryBuilder
setTermCurrency(String) - Method in class javax.money.convert.ConversionQueryBuilder: Sets the term currency.
setTermCurrency(String) - Method in class javax.money.convert.ConversionQueryBuilder
setTermCurrency(CurrencyUnit) - Method in class javax.money.convert.ConversionQueryBuilder: Sets the term currency.
signum() - Method in interface javax.money.MonetaryAmount
signum() - Method in interface javax.money.MonetaryAmount: Returns the signum function of this MonetaryAmount.
stripTrailingZeros() - Method in interface javax.money.MonetaryAmount
stripTrailingZeros() - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount which is numerically equal to this one but with any trailing zeros removed from the representation.
subtract(MonetaryAmount) - Method in interface javax.money.MonetaryAmount
subtract(MonetaryAmount) - Method in interface javax.money.MonetaryAmount: Returns a MonetaryAmount whose value is this - - amount, and whose scale is max(this.scale(), - subtrahend.scale().
+ amount, and whose scale is max(this.getContext().getMaxScale(), + subtrahend.getContext().getMaxScale().

- +

T

toBuilder() - Method in class javax.money.convert.ConversionContext
toBuilder() - Method in class javax.money.convert.ConversionContext: Creates a conversion query builder with the context data from this context instance.
toBuilder() - Method in class javax.money.convert.ConversionQuery
toBuilder() - Method in class javax.money.convert.ConversionQuery: Creates a new Builder preinitialized with values from this instance.
toBuilder() - Method in class javax.money.convert.ProviderContext
toBuilder() - Method in class javax.money.convert.ProviderContext: -
Creates a ProviderContextBuilder initialized with this instance's data.
+
Creates a ProviderContextBuilder initialized with this instance's data.
toBuilder() - Method in class javax.money.CurrencyContext
toBuilder() - Method in class javax.money.CurrencyContext: -
Allows to convert a instance into the corresponding CurrencyContextBuilder, which allows - to change the values and of another CurrencyContext instance.
+
Allows to convert a instance into the corresponding CurrencyContextBuilder, which allows + to change the values and of another CurrencyContext instance.
toBuilder() - Method in class javax.money.CurrencyQuery
toBuilder() - Method in class javax.money.CurrencyQuery: Creates a new builder instances, initialized with the data from this one.
toBuilder() - Method in class javax.money.format.AmountFormatContext
toBuilder() - Method in class javax.money.format.AmountFormatContext: Creates a new builder instances, initialized with the data from this one.
toBuilder() - Method in class javax.money.format.AmountFormatQuery
toBuilder() - Method in class javax.money.format.AmountFormatQuery: -
Get a AmountFormatQueryBuilder preinitialized with this context instance.
+
Get a AmountFormatQueryBuilder preinitialized with this context instance.
toBuilder() - Method in class javax.money.MonetaryAmountFactoryQuery
toBuilder() - Method in class javax.money.MonetaryAmountFactoryQuery: Creates a new builder instances, initialized with the data from this one.
toBuilder() - Method in class javax.money.MonetaryContext
toBuilder() - Method in class javax.money.MonetaryContext: Creates a new builder instances, initialized with the data from this one.
toBuilder() - Method in class javax.money.RoundingContext
toBuilder() - Method in class javax.money.RoundingContext: -
Allows to convert a instance into the corresponding CurrencyContextBuilder, which allows - to change the values and of another CurrencyContext instance.
+
Allows to convert a instance into the corresponding CurrencyContextBuilder, which allows + to change the values and of another CurrencyContext instance.
toBuilder() - Method in class javax.money.RoundingQuery
toBuilder() - Method in class javax.money.RoundingQuery: Creates a new builder instances, initialized with the data from this one.
toQueryBuilder() - Method in class javax.money.convert.ConversionContext
toQueryBuilder() - Method in class javax.money.convert.ConversionContext: -
Creates a query builder based on this onctex.
+
Creates a query builder based on this context.
toString() - Method in class javax.money.AbstractContext
toString() - Method in class javax.money.AbstractContext
toString() - Method in class javax.money.AbstractContextBuilder
toString() - Method in class javax.money.AbstractContextBuilder
toString() - Method in exception javax.money.convert.CurrencyConversionException
toString() - Method in exception javax.money.convert.CurrencyConversionException
toString() - Method in exception javax.money.UnknownCurrencyException
toString() - Method in exception javax.money.UnknownCurrencyException

- +

U

UnknownCurrencyException - Exception in javax.money
UnknownCurrencyException - Exception in javax.money: -
Exception thrown when a currency code cannot be resolved into a CurrencyUnit.
+
Exception thrown when a currency code cannot be resolved into a CurrencyUnit.
UnknownCurrencyException(String) - Constructor for exception javax.money.UnknownCurrencyException
UnknownCurrencyException(String) - Constructor for exception javax.money.UnknownCurrencyException: -
Creates a new exception instance when a CurrencyUnit could not be evaluated given a +
Creates a new exception instance when a CurrencyUnit could not be evaluated given a currency code.
UnknownCurrencyException(Locale) - Constructor for exception javax.money.UnknownCurrencyException
UnknownCurrencyException(Locale) - Constructor for exception javax.money.UnknownCurrencyException: -
Creates a new exception instance when a CurrencyUnit could not be evaluated given a - (country) Locale.
+
Creates a new exception instance when a CurrencyUnit could not be evaluated given a + (country) Locale.

- +

V

valueOf(String) - Static method in enum javax.money.convert.RateType
valueOf(String) - Static method in enum javax.money.convert.RateType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy
valueOf(String) - Static method in enum javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy: Returns the enum constant of this type with the specified name.
values() - Static method in enum javax.money.convert.RateType
values() - Static method in enum javax.money.convert.RateType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy
values() - Static method in enum javax.money.spi.MonetaryAmountFactoryProviderSpi.QueryInclusionPolicy: Returns an array containing the constants of this enum type, in the order they are declared.

- +

W

with(MonetaryOperator) - Method in interface javax.money.MonetaryAmount
with(MonetaryOperator) - Method in interface javax.money.MonetaryAmount: Returns an operated object of the same type as this object with the operation made.

-A B C D E F G H I J K L M N O P Q R S T U V W +A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages +

+ +

java.lang.Object +

javax.money.Monetary

public final class Monetary
+extends java.lang.Object

Factory singleton for CurrencyUnit, MonetaryAmount and + MonetaryRounding instances as provided by the + different registered SPI instances. +

+ This class is thread safe. +

Author:: Anatole Tresch

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Modifier and Type	Method	Description
`static java.util.Collection<MonetaryAmountFactory<?>>`	`getAmountFactories()`	+ Access all currently available `MonetaryAmount` implementation classes that are + accessible from this `MonetaryAmount` singleton. +
`static java.util.Collection<MonetaryAmountFactory<?>>`	`getAmountFactories(MonetaryAmountFactoryQuery query)`	+ Returns all factory instances that match the query. +
`static <T extends MonetaryAmount> MonetaryAmountFactory<T>`	`getAmountFactory(java.lang.Class<T> amountType)`	+ Access an `MonetaryAmountFactory` for the given `MonetaryAmount` implementation + type. +
`static MonetaryAmountFactory`	`getAmountFactory(MonetaryAmountFactoryQuery query)`	+ Executes the query and returns the factory found, if there is only one factory. +
`static java.util.Collection<java.lang.Class<? extends MonetaryAmount>>`	`getAmountTypes()`	+ Access all currently available `MonetaryAmount` implementation classes that are + accessible from this `MonetaryAmount` singleton. +
`static java.util.Collection<CurrencyUnit>`	`getCurrencies(java.lang.String... providers)`	+ Access all currencies known. +
`static java.util.Set<CurrencyUnit>`	`getCurrencies(java.util.Locale locale, +java.lang.String... providers)`	+ Access a new instance based on the `Locale`. +
`static java.util.Collection<CurrencyUnit>`	`getCurrencies(CurrencyQuery query)`	+ Query all currencies matching the given query. +
`static CurrencyUnit`	`getCurrency(java.lang.String currencyCode, +java.lang.String... providers)`	+ Access a new instance based on the currency code. +
`static CurrencyUnit`	`getCurrency(java.util.Locale locale, +java.lang.String... providers)`	+ Access a new instance based on the `Locale`. +
`static CurrencyUnit`	`getCurrency(CurrencyQuery query)`	+ Query all currencies matching the given query. +
`static java.util.Set<java.lang.String>`	`getCurrencyProviderNames()`	+ Query all currencies matching the given query. +
`static MonetaryAmountFactory<?>`	`getDefaultAmountFactory()`	+ Access the default `MonetaryAmountFactory` as defined by + `MonetaryAmountsSingletonSpi.getDefaultAmountFactory()`. +
`static java.lang.Class<? extends MonetaryAmount>`	`getDefaultAmountType()`	+ Access the default `MonetaryAmount` implementation class that is + accessible from this `MonetaryAmount` singleton. +
`static java.util.List<java.lang.String>`	`getDefaultCurrencyProviderChain()`	+ Query the list and ordering of provider names modelling the default provider chain to be used, if no provider + chain was explicitly set.. +
`static MonetaryRounding`	`getDefaultRounding()`	+ Creates a rounding that can be added as `MonetaryOperator` to + chained calculations. +
`static java.util.List<java.lang.String>`	`getDefaultRoundingProviderChain()`	+ Allows to access the default providers chain used if no provider chain was passed explicitly.. +
`static MonetaryRounding`	`getRounding(java.lang.String roundingName, +java.lang.String... providers)`	+ Access an `MonetaryOperator` for custom rounding + `MonetaryAmount` instances. +
`static MonetaryRounding`	`getRounding(CurrencyUnit currencyUnit, +java.lang.String... providers)`	+ Creates an `MonetaryOperator` for rounding `MonetaryAmount` + instances given a currency. +
`static MonetaryRounding`	`getRounding(RoundingQuery roundingQuery)`	+ Access a `MonetaryRounding` using a possibly complex query. +
`static java.util.Set<java.lang.String>`	`getRoundingNames(java.lang.String... providers)`	+ Allows to access the names of the current defined roundings. +
`static java.util.Set<java.lang.String>`	`getRoundingProviderNames()`	+ Allows to access the names of the current registered providers. +
`static java.util.Collection<MonetaryRounding>`	`getRoundings(RoundingQuery roundingQuery)`	+ Access multiple `MonetaryRounding` instances using a possibly complex query +
`static boolean`	`isAvailable(MonetaryAmountFactoryQuery query)`	+ Allows to check if any of the getXXX methods return non empty/non null results of `.MonetaryAmountFactory`. +
`static boolean`	`isCurrencyAvailable(java.lang.String code, +java.lang.String... providers)`	+ Allows to check if a `CurrencyUnit` instance is defined, i.e. +
`static boolean`	`isCurrencyAvailable(java.util.Locale locale, +java.lang.String... providers)`	+ Allows to check if a `CurrencyUnit` instance is + defined, i.e. +
`static boolean`	`isRoundingAvailable(java.lang.String roundingName, +java.lang.String... providers)`	+ Checks if a `MonetaryRounding` is available given a roundingId. +
`static boolean`	`isRoundingAvailable(CurrencyUnit currencyUnit, +java.lang.String... providers)`	+ Checks if a `MonetaryRounding` is available given a roundingId. +
`static boolean`	`isRoundingAvailable(RoundingQuery roundingQuery)`	+ Checks if a `MonetaryRounding` matching the query is available. +

Methods inherited from class java.lang.Object

+ + +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+
+ + +
Method Details
+
- +
  +
  getRoundingProviderNames
  +
  public static java.util.Set<java.lang.String> getRoundingProviderNames()
  +
  Allows to access the names of the current registered providers.
  +
  +
  Returns:
  +
  the set of provider names, never null.
  +
  +
  +
- +
  +
  getDefaultRoundingProviderChain
  +
  public static java.util.List<java.lang.String> getDefaultRoundingProviderChain()
  +
  Allows to access the default providers chain used if no provider chain was passed explicitly..
  +
  +
  Returns:
  +
  the chained list of provider names, never null.
  +
  +
  +
- +
  +
  getDefaultRounding
  +
  public static MonetaryRounding getDefaultRounding()
  +
  Creates a rounding that can be added as MonetaryOperator to + chained calculations. The instance will lookup the concrete + MonetaryOperator instance from the Monetary + based on the input MonetaryAmount's CurrencyUnit.
  +
  +
  Returns:
  +
  the (shared) default rounding instance.
  +
  +
  +
- +
  +
  getRounding
  +
  public static MonetaryRounding getRounding(CurrencyUnit currencyUnit, +java.lang.String... providers)
  +
  Creates an MonetaryOperator for rounding MonetaryAmount + instances given a currency.
  +
  +
  Parameters:
  +
  currencyUnit - The currency, which determines the required scale. As + RoundingMode, by default, RoundingMode.HALF_UP + is used.
  +
  providers - the providers and ordering to be used. By default providers and ordering as defined in + #getDefaultProviders is used.
  +
  Returns:
  +
  a new instance MonetaryOperator implementing the + rounding, never null.
  +
  +
  +
- +
  +
  getRounding
  +
  public static MonetaryRounding getRounding(java.lang.String roundingName, +java.lang.String... providers)
  +
  Access an MonetaryOperator for custom rounding + MonetaryAmount instances.
  +
  +
  Parameters:
  +
  roundingName - The rounding identifier.
  +
  providers - the providers and ordering to be used. By default providers and ordering as defined in + #getDefaultProviders is used.
  +
  Returns:
  +
  the corresponding MonetaryOperator implementing the + rounding, never null.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such rounding is registered using a + RoundingProviderSpi instance.
  +
  +
  +
- +
  +
  getRounding
  +
  public static MonetaryRounding getRounding(RoundingQuery roundingQuery)
  +
  Access a MonetaryRounding using a possibly complex query.
  +
  +
  Parameters:
  +
  roundingQuery - The RoundingQuery that may contains arbitrary parameters to be + evaluated.
  +
  Returns:
  +
  the corresponding MonetaryRounding, never null.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such rounding is registered using a + RoundingProviderSpi instance.
  +
  +
  +
- +
  +
  isRoundingAvailable
  +
  public static boolean isRoundingAvailable(java.lang.String roundingName, +java.lang.String... providers)
  +
  Checks if a MonetaryRounding is available given a roundingId.
  +
  +
  Parameters:
  +
  roundingName - The rounding identifier.
  +
  providers - the providers and ordering to be used. By default providers and ordering as defined in + #getDefaultProviders is used.
  +
  Returns:
  +
  true, if a corresponding MonetaryRounding is available.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such rounding is registered using a + RoundingProviderSpi instance.
  +
  +
  +
- +
  +
  isRoundingAvailable
  +
  public static boolean isRoundingAvailable(CurrencyUnit currencyUnit, +java.lang.String... providers)
  +
  Checks if a MonetaryRounding is available given a roundingId.
  +
  +
  Parameters:
  +
  currencyUnit - The currency, which determines the required scale. As RoundingMode, + by default, RoundingMode.HALF_UP is used.
  +
  providers - the providers and ordering to be used. By default providers and ordering as defined in + #getDefaultProviders is used.
  +
  Returns:
  +
  true, if a corresponding MonetaryRounding is available.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such rounding is registered using a + RoundingProviderSpi instance.
  +
  +
  +
- +
  +
  isRoundingAvailable
  +
  public static boolean isRoundingAvailable(RoundingQuery roundingQuery)
  +
  Checks if a MonetaryRounding matching the query is available.
  +
  +
  Parameters:
  +
  roundingQuery - The RoundingQuery that may contains arbitrary parameters to be + evaluated.
  +
  Returns:
  +
  true, if a corresponding MonetaryRounding is available.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such rounding is registered using a + RoundingProviderSpi instance.
  +
  +
  +
- +
  +
  getRoundings
  +
  public static java.util.Collection<MonetaryRounding> getRoundings(RoundingQuery roundingQuery)
  +
  Access multiple MonetaryRounding instances using a possibly complex query
  +
  +
  Parameters:
  +
  roundingQuery - The RoundingQuery that may contains arbitrary parameters to be + evaluated.
  +
  Returns:
  +
  all MonetaryRounding instances matching the query, never null.
  +
  +
  +
- +
  +
  getRoundingNames
  +
  public static java.util.Set<java.lang.String> getRoundingNames(java.lang.String... providers)
  +
  Allows to access the names of the current defined roundings.
  +
  +
  Parameters:
  +
  providers - the providers and ordering to be used. By default providers and ordering as defined in + #getDefaultProviders is used.
  +
  Returns:
  +
  the set of custom rounding ids, never null.
  +
  +
  +
- +
  +
  getAmountFactory
  +
  public static <T extends MonetaryAmount> +MonetaryAmountFactory<T> getAmountFactory(java.lang.Class<T> amountType)
  +
  Access an MonetaryAmountFactory for the given MonetaryAmount implementation + type.
  +
  +
  Parameters:
  +
  amountType - MonetaryAmount implementation type, nor null.
  +
  Returns:
  +
  the corresponding MonetaryAmountFactory, never null.
  +
  Throws:
  +
  MonetaryException - if no MonetaryAmountFactory targeting the given MonetaryAmount + implementation class is registered.
  +
  +
  +
- +
  +
  getDefaultAmountFactory
  +
  public static MonetaryAmountFactory<?> getDefaultAmountFactory()
  +
  Access the default MonetaryAmountFactory as defined by + MonetaryAmountsSingletonSpi.getDefaultAmountFactory().
  +
  +
  Returns:
  +
  the MonetaryAmountFactory corresponding to default amount type, + never null.
  +
  Throws:
  +
  MonetaryException - if no MonetaryAmountFactory targeting the default amount type + implementation class is registered.
  +
  +
  +
- +
  +
  getAmountFactories
  +
  public static java.util.Collection<MonetaryAmountFactory<?>> getAmountFactories()
  +
  Access all currently available MonetaryAmount implementation classes that are + accessible from this MonetaryAmount singleton.
  +
  +
  Returns:
  +
  all currently available MonetaryAmount implementation classes that have + corresponding MonetaryAmountFactory instances provided, never null
  +
  +
  +
- +
  +
  getAmountTypes
  +
  public static java.util.Collection<java.lang.Class<? extends MonetaryAmount>> getAmountTypes()
  +
  Access all currently available MonetaryAmount implementation classes that are + accessible from this MonetaryAmount singleton.
  +
  +
  Returns:
  +
  all currently available MonetaryAmount implementation classes that have + corresponding MonetaryAmountFactory instances provided, never null
  +
  +
  +
- +
  +
  getDefaultAmountType
  +
  public static java.lang.Class<? extends MonetaryAmount> getDefaultAmountType()
  +
  Access the default MonetaryAmount implementation class that is + accessible from this MonetaryAmount singleton.
  +
  +
  Returns:
  +
  all current default MonetaryAmount implementation class, never null
  +
  +
  +
- +
  +
  getAmountFactory
  +
  public static MonetaryAmountFactory getAmountFactory(MonetaryAmountFactoryQuery query)
  +
  Executes the query and returns the factory found, if there is only one factory. + If multiple factories match the query, one is selected.
  +
  +
  Parameters:
  +
  query - the factory query, not null.
  +
  Returns:
  +
  the factory found, or null.
  +
  +
  +
- +
  +
  getAmountFactories
  +
  public static java.util.Collection<MonetaryAmountFactory<?>> getAmountFactories(MonetaryAmountFactoryQuery query)
  +
  Returns all factory instances that match the query.
  +
  +
  Parameters:
  +
  query - the factory query, not null.
  +
  Returns:
  +
  the instances found, never null.
  +
  +
  +
- +
  +
  isAvailable
  +
  public static boolean isAvailable(MonetaryAmountFactoryQuery query)
  +
  Allows to check if any of the getXXX methods return non empty/non null results of .MonetaryAmountFactory.
  +
  +
  Parameters:
  +
  query - the factory query, not null.
  +
  Returns:
  +
  true, if at least one MonetaryAmountFactory matches the query.
  +
  +
  +
- +
  +
  getCurrency
  +
  public static CurrencyUnit getCurrency(java.lang.String currencyCode, +java.lang.String... providers)
  +
  Access a new instance based on the currency code. Currencies are + available as provided by CurrencyProviderSpi instances registered + with the Bootstrap.
  +
  +
  Parameters:
  +
  currencyCode - the ISO currency code, not null.
  +
  providers - the (optional) specification of providers to consider.
  +
  Returns:
  +
  the corresponding CurrencyUnit instance.
  +
  Throws:
  +
  UnknownCurrencyException - if no such currency exists.
  +
  +
  +
- +
  +
  getCurrency
  +
  public static CurrencyUnit getCurrency(java.util.Locale locale, +java.lang.String... providers)
  +
  Access a new instance based on the Locale. Currencies are + available as provided by CurrencyProviderSpi instances registered + with the Bootstrap.
  +
  +
  Parameters:
  +
  locale - the target Locale, typically representing an ISO + country, not null.
  +
  providers - the (optional) specification of providers to consider.
  +
  Returns:
  +
  the corresponding CurrencyUnit instance.
  +
  Throws:
  +
  UnknownCurrencyException - if no such currency exists.
  +
  +
  +
- +
  +
  getCurrencies
  +
  public static java.util.Set<CurrencyUnit> getCurrencies(java.util.Locale locale, +java.lang.String... providers)
  +
  Access a new instance based on the Locale. Currencies are + available as provided by CurrencyProviderSpi instances registered + with the Bootstrap.
  +
  +
  Parameters:
  +
  locale - the target Locale, typically representing an ISO + country, not null.
  +
  providers - the (optional) specification of providers to consider.
  +
  Returns:
  +
  the corresponding CurrencyUnit instance.
  +
  Throws:
  +
  UnknownCurrencyException - if no such currency exists.
  +
  +
  +
- +
  +
  isCurrencyAvailable
  +
  public static boolean isCurrencyAvailable(java.lang.String code, +java.lang.String... providers)
  +
  Allows to check if a CurrencyUnit instance is defined, i.e. + accessible from getCurrency(String, String...).
  +
  +
  Parameters:
  +
  code - the currency code, not null.
  +
  providers - the (optional) specification of providers to consider.
  +
  Returns:
  +
  true if getCurrency(String, java.lang.String...) + would return a result for the given code.
  +
  +
  +
- +
  +
  isCurrencyAvailable
  +
  public static boolean isCurrencyAvailable(java.util.Locale locale, +java.lang.String... providers)
  +
  Allows to check if a CurrencyUnit instance is + defined, i.e. accessible from getCurrency(String, String...).
  +
  +
  Parameters:
  +
  locale - the target Locale, not null.
  +
  providers - the (optional) specification of providers to consider.
  +
  Returns:
  +
  true if getCurrencies(Locale, String...) would return a + result containing a currency with the given code.
  +
  +
  +
- +
  +
  getCurrencies
  +
  public static java.util.Collection<CurrencyUnit> getCurrencies(java.lang.String... providers)
  +
  Access all currencies known.
  +
  +
  Parameters:
  +
  providers - the (optional) specification of providers to consider.
  +
  Returns:
  +
  the list of known currencies, never null.
  +
  +
  +
- +
  +
  getCurrency
  +
  public static CurrencyUnit getCurrency(CurrencyQuery query)
  +
  Query all currencies matching the given query.
  +
  +
  Parameters:
  +
  query - The CurrencyQuery, not null.
  +
  Returns:
  +
  the list of known currencies, never null.
  +
  +
  +
- +
  +
  getCurrencies
  +
  public static java.util.Collection<CurrencyUnit> getCurrencies(CurrencyQuery query)
  +
  Query all currencies matching the given query.
  +
  +
  Parameters:
  +
  query - The CurrencyQuery, not null.
  +
  Returns:
  +
  the list of known currencies, never null.
  +
  +
  +
- +
  +
  getCurrencyProviderNames
  +
  public static java.util.Set<java.lang.String> getCurrencyProviderNames()
  +
  Query all currencies matching the given query.
  +
  +
  Returns:
  +
  the list of known currencies, never null.
  +
  +
  +
- +
  +
  getDefaultCurrencyProviderChain
  +
  public static java.util.List<java.lang.String> getDefaultCurrencyProviderChain()
  +
  Query the list and ordering of provider names modelling the default provider chain to be used, if no provider + chain was explicitly set..
  +
  +
  Returns:
  +
  the ordered list provider names, modelling the default provider chain used, never null.
  +
  +
  +
+
+

+ +

All Superinterfaces:: java.lang.Comparable<MonetaryAmount>, CurrencySupplier, NumberSupplier

public interface MonetaryAmount
+extends CurrencySupplier, NumberSupplier, java.lang.Comparable<MonetaryAmount>

Interface defining a monetary amount. The effective format representation of an amount may vary + depending on the implementation used. JSR 354 explicitly supports different types of monetary + amounts to be implemented and used. Reason behind is that the requirements to an implementation + heavily vary for different usage scenarios. E.g. product calculations may require high precision + and scale, whereas low latency order and trading systems require high calculation performance for + algorithmic operations. +

+ Each instance of an amount provides additional meta-data in form of a MonetaryContext. + This context contains detailed information on the numeric capabilities, e.g. the supported + precision and maximal scale, as well as the common implementation flavor. + + Also a MonetaryAmount provides a NumberValue, which allows easily to extract the + numeric value, of the amount. And finally getFactory() provides a + MonetaryAmountFactory, which allows to of instances of MonetaryAmount based + on the same numeric implementation. +

+ This JSR additionally recommends to consider the following aspects: +

Arithmetic operations should throw an ArithmeticException, if performing arithmetic + operations between amounts exceeds the capabilities of the numeric representation type used. Any + implicit truncating, that would lead to complete invalid and useless results, should be avoided. + This recommendation does not affect format rounding, as required by the format numeric + representation of a monetary amount. +
Monetary amounts should allow numbers as argument for arithmetic operations like division and + multiplication. Adding or subtracting of amounts must only be possible by passing instances of + MonetaryAmount.
Nevertheless numeric truncation is also explicitly supported when calling + NumberValue.numberValue(Class), whereas the exact counterpart, + NumberValue.numberValueExact(Class), works similar to + BigDecimal.longValueExact(). +
Since implementations are recommended to be immutable, an operation should never change any + format state of an instance. Given an instance, all operations are required to be fully + reproducible.
Finally the result of calling with(MonetaryOperator) must be of the same type as + type on which with was called. The with method also defines additional + interoperability requirements that are important to enable this invariant.
To enable further interoperability a static method from(MonetaryAmount) is + recommended to be implemented on each implementation class, that allows conversion of a + MonetaryAmount to a concrete instance. E.g.a class MyMoney extends MonetaryAmount + would contain the following method: + +
+
```
+ public final class MyMoney implements MonetaryAmount{
+   ...
+   public static MyMoney from(MonetaryAmount amount)(...)
+ }
+ 
```
+

Implementation specification

+ Implementations of this interface must be +

thread-safe

+ Implementations of this interface should be +

final
serializable, hereby writing the numeric value, the MonetaryContext and a serialized + CurrencyUnit.

+ Implementations of this interface must be +

thread-safe
immutable
comparable
must implement equals/hashCode, hereby considering +
- Implementation type +
- CurrencyUnit +
- Numeric value. +
+ This also means that two different implementations types with the same currency and numeric value + are NOT equal.

Version:: 1.1
Author:: Anatole Tresch, Werner Keil
See Also:: with(MonetaryOperator)

+ + +

Method Summary

Modifier and Type	Method	Description
`MonetaryAmount`	`abs()`	+ Returns a `MonetaryAmount` whose value is the absolute value of this + `MonetaryAmount`, and whose scale is `this.getContext().getMaxScale()`. +
`MonetaryAmount`	`add(MonetaryAmount augend)`	+ Returns a `MonetaryAmount` whose value is `this + augend`, and whose scale is `max(this.getContext().getMaxScale(), + augend.getContext().getMaxScale())`. +
`MonetaryAmount`	`divide(double divisor)`	+ Returns a `MonetaryAmount` whose value is `this / + divisor`, and whose preferred scale is `this.getContext().getMaxScale() - + divisor.getContext().getMaxScale()`; if the exact quotient cannot be represented an `ArithmeticException` + is thrown. +
`MonetaryAmount`	`divide(long divisor)`	+ Returns a `MonetaryAmount` whose value is `this / + divisor`, and whose preferred scale is `this.getContext().getMaxScale() - + divisor.getContext().getMaxScale()`; if the exact quotient cannot be represented an `ArithmeticException` + is thrown. +
`MonetaryAmount`	`divide(java.lang.Number divisor)`	+ Returns a `MonetaryAmount` whose value is `this / + divisor`, and whose preferred scale is `this.getContext().getMaxScale() - + divisor.getContext().getMaxScale()`; if the exact quotient cannot be represented an `ArithmeticException` + is thrown. +
`MonetaryAmount[]`	`divideAndRemainder(double divisor)`	+ Returns a two-element `MonetaryAmount` array containing the result of + `divideToIntegralValue` followed by the result of `remainder` on the two + operands. +
`MonetaryAmount[]`	`divideAndRemainder(long divisor)`	+ Returns a two-element `MonetaryAmount` array containing the result of + `divideToIntegralValue` followed by the result of `remainder` on the two + operands. +
`MonetaryAmount[]`	`divideAndRemainder(java.lang.Number divisor)`	+ Returns a two-element `MonetaryAmount` array containing the result of + `divideToIntegralValue` followed by the result of `remainder` on the two + operands. +
`MonetaryAmount`	`divideToIntegralValue(double divisor)`	+ Returns a `MonetaryAmount` whose value is the integer part of the quotient + `this / divisor` rounded down. +
`MonetaryAmount`	`divideToIntegralValue(long divisor)`	+ Returns a `MonetaryAmount` whose value is the integer part of the quotient + `this / divisor` rounded down. +
`MonetaryAmount`	`divideToIntegralValue(java.lang.Number divisor)`	+ Returns a `MonetaryAmount` whose value is the integer part of the quotient + `this / divisor` rounded down. +
`MonetaryContext`	`getContext()`	+ Returns the `MonetaryContext` of this `MonetaryAmount`. +
`MonetaryAmountFactory<? extends MonetaryAmount>`	`getFactory()`	+ Creates a new `MonetaryAmountFactory`, returning the same implementation type Hereby + this given amount is used as a template, so reusing the `CurrencyUnit`, its numeric + value, the algorithmic implementation as well as the current `MonetaryContext`. +
`boolean`	`isEqualTo(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	`isGreaterThan(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	`isGreaterThanOrEqualTo(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	`isLessThan(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	`isLessThanOrEqualTo(MonetaryAmount amt)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`default boolean`	`isNegative()`	+ Checks if a `MonetaryAmount` is negative. +
`default boolean`	`isNegativeOrZero()`	+ Checks if a `MonetaryAmount` is negative or zero. +
`default boolean`	`isPositive()`	+ Checks if a `MonetaryAmount` is positive. +
`default boolean`	`isPositiveOrZero()`	+ Checks if a `MonetaryAmount` is positive or zero. +
`default boolean`	`isZero()`	+ Checks if an `MonetaryAmount` is zero. +
`MonetaryAmount`	`multiply(double multiplicand)`	+ Returns a `MonetaryAmount` whose value is `(this × + multiplicand)`, and whose scale is `this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale()`. +
`MonetaryAmount`	`multiply(long multiplicand)`	+ Returns a `MonetaryAmount` whose value is `(this × + multiplicand)`, and whose scale is `this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale()`. +
`MonetaryAmount`	`multiply(java.lang.Number multiplicand)`	+ Returns a `MonetaryAmount` whose value is `(this × + multiplicand)`, and whose scale is `this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale()`. +
`MonetaryAmount`	`negate()`	+ Returns a `MonetaryAmount` whose value is `-this`, and whose scale is + `this.getContext().getMaxScale()`, with rounding according to the context settings. +
`MonetaryAmount`	`plus()`	+ Returns a `MonetaryAmount` whose value is `+this`. +
`default <R> R`	`query(MonetaryQuery<R> query)`	+ Queries this monetary amount for a value. +
`MonetaryAmount`	`remainder(double divisor)`	+ Returns a `MonetaryAmount` whose value is `this % divisor`. +
`MonetaryAmount`	`remainder(long divisor)`	+ Returns a `MonetaryAmount` whose value is `this % divisor`. +
`MonetaryAmount`	`remainder(java.lang.Number divisor)`	+ Returns a `MonetaryAmount` whose value is `this % divisor`. +
`MonetaryAmount`	`scaleByPowerOfTen(int power)`	+ Returns a `MonetaryAmount` whose numerical value is equal to ( `this` * + 10ⁿ). +
`int`	`signum()`	+ Returns the signum function of this `MonetaryAmount`. +
`MonetaryAmount`	`stripTrailingZeros()`	+ Returns a `MonetaryAmount` which is numerically equal to this one but with any trailing + zeros removed from the representation. +
`MonetaryAmount`	`subtract(MonetaryAmount subtrahend)`	+ Returns a `MonetaryAmount` whose value is `this - + amount`, and whose scale is `max(this.getContext().getMaxScale(), + subtrahend.getContext().getMaxScale()`. +
`default MonetaryAmount`	`with(MonetaryOperator operator)`	+ Returns an operated object of the same type as this object with the operation made. +

Methods inherited from interface java.lang.Comparable

+ + +compareTo

Methods inherited from interface javax.money.CurrencySupplier

+ + +getCurrency

Methods inherited from interface javax.money.NumberSupplier

+ + +getNumber

+
+ + +
Method Details
+
- +
  +
  getContext
  +
  MonetaryContext getContext()
  +
  Returns the MonetaryContext of this MonetaryAmount. The + MonetaryContext provides additional information about the numeric representation and + the numeric capabilities. This information can be used by code to determine situations where + MonetaryAmount instances must be converted to avoid implicit truncation, which can + lead to invalid results.
  +
  +
  Returns:
  +
  the MonetaryContext of this MonetaryAmount, never null .
  +
  +
  +
- +
  +
  query
  +
  default <R> R query(MonetaryQuery<R> query)
  +
  Queries this monetary amount for a value. +
  + This queries this amount using the specified query strategy object. +
  + Implementations must ensure that no observable state is altered when this read-only method is + invoked.
  +
  +
  Type Parameters:
  +
  R - the type of the result
  +
  Parameters:
  +
  query - the query to invoke, not null
  +
  Returns:
  +
  the query result, null may be returned (defined by the query)
  +
  +
  +
- +
  +
  with
  +
  default MonetaryAmount with(MonetaryOperator operator)
  +
  Returns an operated object of the same type as this object with the operation made. + Hereby returning an instance of the same type is very important to prevent + uncontrolled mixup of implementations. Switching between implementations is still easily + possible, e.g. by using according MonetaryAmountFactory instances:
  +
  + // converting from Money to MyMoney + Money m = ...; + MonetartyAmountFactory<MyMoney> f = Monetary.queryAmountFactory(MyMoney.class); + MyMoney myMoney = f.setAmount(m).of(); +
  +
  + This converts this monetary amount according to the rules of the specified operator. A + typical operator will change the amount and leave the currency unchanged. A more complex + operator might also change the currency. +
  + Some example code indicating how and why this method is used: +
  +
  + MonetaryAmount money = money.with(amountMultipliedBy(2)); + money = money.with(amountRoundedToNearestWholeUnit()); +
  +
  +
  + Hereby also the method signature on the implementation type must return the concrete type, to + enable a fluent API, e.g. + +
  +
  + public final class MyMoney implements MonetaryAmount{ + ... + public MyMoney with(MonetaryOperator operator){ + ... + } + + ... + } +
  +
  +
  +
  Parameters:
  +
  operator - the operator to use, not null
  +
  Returns:
  +
  an object of the same type with the specified conversion made, not null
  +
  +
  +
- +
  +
  getFactory
  +
  MonetaryAmountFactory<? extends MonetaryAmount> getFactory()
  +
  Creates a new MonetaryAmountFactory, returning the same implementation type Hereby + this given amount is used as a template, so reusing the CurrencyUnit, its numeric + value, the algorithmic implementation as well as the current MonetaryContext. +
  + This method is used for creating a new amount result after having done calculations that are + not directly mappable to the default monetary arithmetics, e.g. currency conversion.
  +
  +
  Returns:
  +
  the new MonetaryAmountFactory with the given MonetaryAmount as its + default values.
  +
  +
  +
- +
  +
  isGreaterThan
  +
  boolean isGreaterThan(MonetaryAmount amount)
  +
  Compares two instances of MonetaryAmount, hereby ignoring non significant trailing + zeroes and different numeric capabilities.
  +
  +
  Parameters:
  +
  amount - the MonetaryAmount to be compared with this instance.
  +
  Returns:
  +
  true if amount > this.
  +
  Throws:
  +
  MonetaryException - if the amount's currency is not equal to the currency of this instance.
  +
  +
  +
- +
  +
  isGreaterThanOrEqualTo
  +
  boolean isGreaterThanOrEqualTo(MonetaryAmount amount)
  +
  Compares two instances of MonetaryAmount, hereby ignoring non significant trailing + zeroes and different numeric capabilities.
  +
  +
  Parameters:
  +
  amount - the MonetaryAmount to be compared with this instance.
  +
  Returns:
  +
  true if amount >= this.
  +
  Throws:
  +
  MonetaryException - if the amount's currency is not equal to the currency of this instance.
  +
  +
  +
- +
  +
  isLessThan
  +
  boolean isLessThan(MonetaryAmount amount)
  +
  Compares two instances of MonetaryAmount, hereby ignoring non significant trailing + zeroes and different numeric capabilities.
  +
  +
  Parameters:
  +
  amount - the MonetaryAmount to be compared with this instance.
  +
  Returns:
  +
  true if amount < this.
  +
  Throws:
  +
  MonetaryException - if the amount's currency is not equal to the currency of this instance.
  +
  +
  +
- +
  +
  isLessThanOrEqualTo
  +
  boolean isLessThanOrEqualTo(MonetaryAmount amt)
  +
  Compares two instances of MonetaryAmount, hereby ignoring non significant trailing + zeroes and different numeric capabilities.
  +
  +
  Parameters:
  +
  amt - the MonetaryAmount to be compared with this instance.
  +
  Returns:
  +
  true if amount <= this.
  +
  Throws:
  +
  MonetaryException - if the amount's currency is not equal to the currency of this instance.
  +
  +
  +
- +
  +
  isEqualTo
  +
  boolean isEqualTo(MonetaryAmount amount)
  +
  Compares two instances of MonetaryAmount, hereby ignoring non significant trailing + zeroes and different numeric capabilities.
  +
  +
  Parameters:
  +
  amount - the MonetaryAmount to be compared with this instance.
  +
  Returns:
  +
  true if amount == this.
  +
  Throws:
  +
  MonetaryException - if the amount's currency is not equal to the currency of this instance.
  +
  +
  +
- +
  +
  isNegative
  +
  default boolean isNegative()
  +
  Checks if a MonetaryAmount is negative.
  +
  +
  Returns:
  +
  true if signum() < 0.
  +
  +
  +
- +
  +
  isNegativeOrZero
  +
  default boolean isNegativeOrZero()
  +
  Checks if a MonetaryAmount is negative or zero.
  +
  +
  Returns:
  +
  true if signum() <= 0.
  +
  +
  +
- +
  +
  isPositive
  +
  default boolean isPositive()
  +
  Checks if a MonetaryAmount is positive.
  +
  +
  Returns:
  +
  true if signum() > 0.
  +
  +
  +
- +
  +
  isPositiveOrZero
  +
  default boolean isPositiveOrZero()
  +
  Checks if a MonetaryAmount is positive or zero.
  +
  +
  Returns:
  +
  true if signum() >= 0.
  +
  +
  +
- +
  +
  isZero
  +
  default boolean isZero()
  +
  Checks if an MonetaryAmount is zero.
  +
  +
  Returns:
  +
  true if signum() == 0.
  +
  +
  +
- +
  +
  signum
  +
  int signum()
  +
  Returns the signum function of this MonetaryAmount.
  +
  +
  Returns:
  +
  -1, 0, or 1 as the value of this MonetaryAmount is negative, zero, or + positive.
  +
  +
  +
- +
  +
  add
  +
  MonetaryAmount add(MonetaryAmount augend)
  +
  Returns a MonetaryAmount whose value is this + augend, and whose scale is max(this.getContext().getMaxScale(), + augend.getContext().getMaxScale()).
  +
  +
  Parameters:
  +
  augend - value to be added to this MonetaryAmount.
  +
  Returns:
  +
  this + augend
  +
  Throws:
  +
  java.lang.ArithmeticException - if the result exceeds the numeric capabilities of this implementation class, i.e. + the MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  subtract
  +
  MonetaryAmount subtract(MonetaryAmount subtrahend)
  +
  Returns a MonetaryAmount whose value is this - + amount, and whose scale is max(this.getContext().getMaxScale(), + subtrahend.getContext().getMaxScale().
  +
  +
  Parameters:
  +
  subtrahend - value to be subtracted from this MonetaryAmount.
  +
  Returns:
  +
  this - subtrahend
  +
  Throws:
  +
  java.lang.ArithmeticException - if the result exceeds the numeric capabilities of this implementation class, i.e. + the MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  multiply
  +
  MonetaryAmount multiply(long multiplicand)
  +
  Returns a MonetaryAmount whose value is (this × + multiplicand), and whose scale is this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale().
  +
  +
  Parameters:
  +
  multiplicand - value to be multiplied by this MonetaryAmount.
  +
  Returns:
  +
  this * multiplicand
  +
  Throws:
  +
  java.lang.ArithmeticException - if the result exceeds the numeric capabilities of this implementation class, i.e. + the MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  multiply
  +
  MonetaryAmount multiply(double multiplicand)
  +
  Returns a MonetaryAmount whose value is (this × + multiplicand), and whose scale is this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale(). + By default the input value's scale will be rounded to + accommodate the format capabilities, and no ArithmeticException + is thrown if the input number's scale exceeds the capabilities.
  +
  +
  Parameters:
  +
  multiplicand - value to be multiplied by this MonetaryAmount. If the multiplicand's scale exceeds + the + capabilities of the implementation, it may be rounded implicitly.
  +
  Returns:
  +
  this * multiplicand
  +
  Throws:
  +
  java.lang.ArithmeticException - if the result exceeds the numeric capabilities of this implementation class, i.e. + the MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  multiply
  +
  MonetaryAmount multiply(java.lang.Number multiplicand)
  +
  Returns a MonetaryAmount whose value is (this × + multiplicand), and whose scale is this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale().
  +
  +
  Parameters:
  +
  multiplicand - value to be multiplied by this MonetaryAmount. If the multiplicand's scale exceeds + the + capabilities of the implementation, it may be rounded implicitly.
  +
  Returns:
  +
  this * multiplicand
  +
  Throws:
  +
  java.lang.ArithmeticException - if the result exceeds the numeric capabilities of this implementation class, i.e. + the MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  divide
  +
  MonetaryAmount divide(long divisor)
  +
  Returns a MonetaryAmount whose value is this / + divisor, and whose preferred scale is this.getContext().getMaxScale() - + divisor.getContext().getMaxScale(); if the exact quotient cannot be represented an ArithmeticException + is thrown.
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided.
  +
  Returns:
  +
  this / divisor
  +
  Throws:
  +
  java.lang.ArithmeticException - if the exact quotient does not have a terminating decimal expansion, or if the + result exceeds the numeric capabilities of this implementation class, i.e. the + MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  divide
  +
  MonetaryAmount divide(double divisor)
  +
  Returns a MonetaryAmount whose value is this / + divisor, and whose preferred scale is this.getContext().getMaxScale() - + divisor.getContext().getMaxScale(); if the exact quotient cannot be represented an ArithmeticException + is thrown.
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided.
  +
  Returns:
  +
  this / divisor
  +
  Throws:
  +
  java.lang.ArithmeticException - if the exact quotient does not have a terminating decimal expansion, or if the + result exceeds the numeric capabilities of this implementation class, i.e. the + MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  divide
  +
  MonetaryAmount divide(java.lang.Number divisor)
  +
  Returns a MonetaryAmount whose value is this / + divisor, and whose preferred scale is this.getContext().getMaxScale() - + divisor.getContext().getMaxScale(); if the exact quotient cannot be represented an ArithmeticException + is thrown.
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided.
  +
  Returns:
  +
  this / divisor
  +
  Throws:
  +
  java.lang.ArithmeticException - if the exact quotient does not have a terminating decimal expansion, or if the + result exceeds the numeric capabilities of this implementation class, i.e. the + MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  remainder
  +
  MonetaryAmount remainder(long divisor)
  +
  Returns a MonetaryAmount whose value is this % divisor. + +
  + The remainder is given by + this.subtract(this.divideToIntegralValue(divisor).multiply(divisor) . Note that this + is not the modulo operation (the result can be negative).
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided.
  +
  Returns:
  +
  this % divisor.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0, or if the result exceeds the numeric capabilities of this + implementation class, i.e. the MonetaryContext cannot be adapted as + required.
  +
  +
  +
- +
  +
  remainder
  +
  MonetaryAmount remainder(double divisor)
  +
  Returns a MonetaryAmount whose value is this % divisor. + +
  + The remainder is given by + this.subtract(this.divideToIntegralValue(divisor).multiply(divisor) . Note that this + is not the modulo operation (the result can be negative).
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided.
  +
  Returns:
  +
  this % divisor.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0, or if the result exceeds the numeric capabilities of this + implementation class, i.e. the MonetaryContext cannot be adapted as + required.
  +
  +
  +
- +
  +
  remainder
  +
  MonetaryAmount remainder(java.lang.Number divisor)
  +
  Returns a MonetaryAmount whose value is this % divisor. + +
  + The remainder is given by + this.subtract(this.divideToIntegralValue(divisor).multiply(divisor) . Note that this + is not the modulo operation (the result can be negative).
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided.
  +
  Returns:
  +
  this % divisor.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0, or if the result exceeds the numeric capabilities of this + implementation class, i.e. the MonetaryContext cannot be adapted as + required.
  +
  +
  +
- +
  +
  divideAndRemainder
  +
  MonetaryAmount[] divideAndRemainder(long divisor)
  +
  Returns a two-element MonetaryAmount array containing the result of + divideToIntegralValue followed by the result of remainder on the two + operands. + +
  + Note that if both the integer quotient and remainder are needed, this method is faster than + using the divideToIntegralValue and remainder methods separately because the + division need only be carried out once.
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided, and the remainder + computed.
  +
  Returns:
  +
  a two element MonetaryAmount array: the quotient (the result of + divideToIntegralValue) is the initial element and the remainder is the final + element.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0, or if the result exceeds the numeric capabilities of this + implementation class, i.e. the MonetaryContext cannot be adapted as + required.
  +
  See Also:
  +
  divideToIntegralValue(long), +remainder(long)
  +
  +
  +
- +
  +
  divideAndRemainder
  +
  MonetaryAmount[] divideAndRemainder(double divisor)
  +
  Returns a two-element MonetaryAmount array containing the result of + divideToIntegralValue followed by the result of remainder on the two + operands. + +
  + Note that if both the integer quotient and remainder are needed, this method is faster than + using the divideToIntegralValue and remainder methods separately because the + division need only be carried out once.
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided, and the remainder + computed.
  +
  Returns:
  +
  a two element MonetaryAmount array: the quotient (the result of + divideToIntegralValue) is the initial element and the remainder is the final + element.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0, or if the result exceeds the numeric capabilities of this + implementation class, i.e. the MonetaryContext cannot be adapted as + required.
  +
  See Also:
  +
  divideToIntegralValue(double), +remainder(double)
  +
  +
  +
- +
  +
  divideAndRemainder
  +
  MonetaryAmount[] divideAndRemainder(java.lang.Number divisor)
  +
  Returns a two-element MonetaryAmount array containing the result of + divideToIntegralValue followed by the result of remainder on the two + operands. + +
  + Note that if both the integer quotient and remainder are needed, this method is faster than + using the divideToIntegralValue and remainder methods separately because the + division need only be carried out once.
  +
  +
  Parameters:
  +
  divisor - value by which this MonetaryAmount is to be divided, and the remainder + computed.
  +
  Returns:
  +
  a two element MonetaryAmount array: the quotient (the result of + divideToIntegralValue) is the initial element and the remainder is the final + element.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0, or if the result exceeds the numeric capabilities of this + implementation class, i.e. the MonetaryContext cannot be adapted as + required.
  +
  See Also:
  +
  divideToIntegralValue(Number), +remainder(Number)
  +
  +
  +
- +
  +
  divideToIntegralValue
  +
  MonetaryAmount divideToIntegralValue(long divisor)
  +
  Returns a MonetaryAmount whose value is the integer part of the quotient + this / divisor rounded down. The preferred scale of the result is + this.getContext().getMaxScale() - + divisor.getContext().getMaxScale().
  +
  +
  Parameters:
  +
  divisor - value by which this BigDecimal is to be divided.
  +
  Returns:
  +
  The integer part of this / divisor.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0
  +
  See Also:
  +
  BigDecimal.divideToIntegralValue(java.math.BigDecimal)
  +
  +
  +
- +
  +
  divideToIntegralValue
  +
  MonetaryAmount divideToIntegralValue(double divisor)
  +
  Returns a MonetaryAmount whose value is the integer part of the quotient + this / divisor rounded down. The preferred scale of the result is + this.getContext().getMaxScale() - divisor.getContext().getMaxScale().
  +
  +
  Parameters:
  +
  divisor - value by which this BigDecimal is to be divided.
  +
  Returns:
  +
  The integer part of this / divisor.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0
  +
  See Also:
  +
  BigDecimal.divideToIntegralValue(java.math.BigDecimal)
  +
  +
  +
- +
  +
  divideToIntegralValue
  +
  MonetaryAmount divideToIntegralValue(java.lang.Number divisor)
  +
  Returns a MonetaryAmount whose value is the integer part of the quotient + this / divisor rounded down. The preferred scale of the result is + this.getContext().getMaxScale() - + divisor.getContext().getMaxScale().
  +
  +
  Parameters:
  +
  divisor - value by which this BigDecimal is to be divided.
  +
  Returns:
  +
  The integer part of this / divisor.
  +
  Throws:
  +
  java.lang.ArithmeticException - if divisor==0
  +
  See Also:
  +
  BigDecimal.divideToIntegralValue(java.math.BigDecimal)
  +
  +
  +
- +
  +
  scaleByPowerOfTen
  +
  MonetaryAmount scaleByPowerOfTen(int power)
  +
  Returns a MonetaryAmount whose numerical value is equal to ( this * + 10ⁿ). The scale of the result is this.getContext().getMaxScale() - n.
  +
  +
  Parameters:
  +
  power - the power.
  +
  Returns:
  +
  the calculated amount value.
  +
  Throws:
  +
  java.lang.ArithmeticException - if the scale would be outside the range of a 32-bit integer, or if the result + exceeds the numeric capabilities of this implementation class, i.e. the + MonetaryContext cannot be adapted as required.
  +
  +
  +
- +
  +
  abs
  +
  MonetaryAmount abs()
  +
  Returns a MonetaryAmount whose value is the absolute value of this + MonetaryAmount, and whose scale is this.getContext().getMaxScale().
  +
  +
  Returns:
  +
  abs(this
  +
  +
  +
- +
  +
  negate
  +
  MonetaryAmount negate()
  +
  Returns a MonetaryAmount whose value is -this, and whose scale is + this.getContext().getMaxScale(), with rounding according to the context settings.
  +
  +
  Returns:
  +
  -this, rounded as necessary.
  +
  Throws:
  +
  java.lang.ArithmeticException - if rounding fails.
  +
  See Also:
  +
  BigDecimal.negate()
  +
  +
  +
- +
  +
  plus
  +
  MonetaryAmount plus()
  +
  Returns a MonetaryAmount whose value is +this. + +
  This method, which simply returns this MonetaryAmount + is included for symmetry with the unary minus method negate().
  +
  +
  Returns:
  +
  this.
  +
  See Also:
  +
  negate(), +BigDecimal.plus()
  +
  +
  +
- +
  +
  stripTrailingZeros
  +
  MonetaryAmount stripTrailingZeros()
  +
  Returns a MonetaryAmount which is numerically equal to this one but with any trailing + zeros removed from the representation. For example, stripping the trailing zeros from the + MonetaryAmount value CHF 600.0, which has [BigInteger, scale] + components equals to [6000, 1], yields 6E2 with [ BigInteger, scale] + components equals to [6, -2]
  +
  +
  Returns:
  +
  a numerically equal MonetaryAmount with any trailing zeros removed.
  +
  +
  +
+
+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Packages that use MonetaryAmount
Package	Description
javax.money	+ Main package of the Money and Currency API. +
javax.money.convert	+ Defines the monetary currency conversion API. +
javax.money.format	+ Money and Currency format API. +
javax.money.spi	+ SPI interfaces of the Money and Currency API, including bootstrap logic. +

+ + +

Uses of MonetaryAmount in javax.money

+ + + + + + + + + + + + + + + + +

Classes in javax.money with type parameters of type MonetaryAmount
Modifier and Type	Interface	Description
`interface`	`MonetaryAmountFactory<T extends MonetaryAmount>`	+ Factory for `MonetaryAmount` instances for a given type. +

+ + + + + + + + + + + + + + + + +

Methods in javax.money with type parameters of type MonetaryAmount
Modifier and Type	Method	Description
`static <T extends MonetaryAmount> MonetaryAmountFactory<T>`	Monetary.`getAmountFactory(java.lang.Class<T> amountType)`	+ Access an `MonetaryAmountFactory` for the given `MonetaryAmount` implementation + type. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods in javax.money that return MonetaryAmount
Modifier and Type	Method	Description
`MonetaryAmount`	MonetaryAmount.`abs()`	+ Returns a `MonetaryAmount` whose value is the absolute value of this + `MonetaryAmount`, and whose scale is `this.getContext().getMaxScale()`. +
`MonetaryAmount`	MonetaryAmount.`add(MonetaryAmount augend)`	+ Returns a `MonetaryAmount` whose value is `this + augend`, and whose scale is `max(this.getContext().getMaxScale(), + augend.getContext().getMaxScale())`. +
`MonetaryAmount`	MonetaryOperator.`apply(MonetaryAmount amount)`	+ Applies the operator on the given amount. +
`MonetaryAmount`	MonetaryAmount.`divide(double divisor)`	+ Returns a `MonetaryAmount` whose value is `this / + divisor`, and whose preferred scale is `this.getContext().getMaxScale() - + divisor.getContext().getMaxScale()`; if the exact quotient cannot be represented an `ArithmeticException` + is thrown. +
`MonetaryAmount`	MonetaryAmount.`divide(long divisor)`	+ Returns a `MonetaryAmount` whose value is `this / + divisor`, and whose preferred scale is `this.getContext().getMaxScale() - + divisor.getContext().getMaxScale()`; if the exact quotient cannot be represented an `ArithmeticException` + is thrown. +
`MonetaryAmount`	MonetaryAmount.`divide(java.lang.Number divisor)`	+ Returns a `MonetaryAmount` whose value is `this / + divisor`, and whose preferred scale is `this.getContext().getMaxScale() - + divisor.getContext().getMaxScale()`; if the exact quotient cannot be represented an `ArithmeticException` + is thrown. +
`MonetaryAmount[]`	MonetaryAmount.`divideAndRemainder(double divisor)`	+ Returns a two-element `MonetaryAmount` array containing the result of + `divideToIntegralValue` followed by the result of `remainder` on the two + operands. +
`MonetaryAmount[]`	MonetaryAmount.`divideAndRemainder(long divisor)`	+ Returns a two-element `MonetaryAmount` array containing the result of + `divideToIntegralValue` followed by the result of `remainder` on the two + operands. +
`MonetaryAmount[]`	MonetaryAmount.`divideAndRemainder(java.lang.Number divisor)`	+ Returns a two-element `MonetaryAmount` array containing the result of + `divideToIntegralValue` followed by the result of `remainder` on the two + operands. +
`MonetaryAmount`	MonetaryAmount.`divideToIntegralValue(double divisor)`	+ Returns a `MonetaryAmount` whose value is the integer part of the quotient + `this / divisor` rounded down. +
`MonetaryAmount`	MonetaryAmount.`divideToIntegralValue(long divisor)`	+ Returns a `MonetaryAmount` whose value is the integer part of the quotient + `this / divisor` rounded down. +
`MonetaryAmount`	MonetaryAmount.`divideToIntegralValue(java.lang.Number divisor)`	+ Returns a `MonetaryAmount` whose value is the integer part of the quotient + `this / divisor` rounded down. +
`MonetaryAmount`	MonetaryAmount.`multiply(double multiplicand)`	+ Returns a `MonetaryAmount` whose value is `(this × + multiplicand)`, and whose scale is `this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale()`. +
`MonetaryAmount`	MonetaryAmount.`multiply(long multiplicand)`	+ Returns a `MonetaryAmount` whose value is `(this × + multiplicand)`, and whose scale is `this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale()`. +
`MonetaryAmount`	MonetaryAmount.`multiply(java.lang.Number multiplicand)`	+ Returns a `MonetaryAmount` whose value is `(this × + multiplicand)`, and whose scale is `this.getContext().getMaxScale() + + multiplicand.getContext().getMaxScale()`. +
`MonetaryAmount`	MonetaryAmount.`negate()`	+ Returns a `MonetaryAmount` whose value is `-this`, and whose scale is + `this.getContext().getMaxScale()`, with rounding according to the context settings. +
`MonetaryAmount`	MonetaryAmount.`plus()`	+ Returns a `MonetaryAmount` whose value is `+this`. +
`MonetaryAmount`	MonetaryAmount.`remainder(double divisor)`	+ Returns a `MonetaryAmount` whose value is `this % divisor`. +
`MonetaryAmount`	MonetaryAmount.`remainder(long divisor)`	+ Returns a `MonetaryAmount` whose value is `this % divisor`. +
`MonetaryAmount`	MonetaryAmount.`remainder(java.lang.Number divisor)`	+ Returns a `MonetaryAmount` whose value is `this % divisor`. +
`MonetaryAmount`	MonetaryAmount.`scaleByPowerOfTen(int power)`	+ Returns a `MonetaryAmount` whose numerical value is equal to ( `this` * + 10ⁿ). +
`MonetaryAmount`	MonetaryAmount.`stripTrailingZeros()`	+ Returns a `MonetaryAmount` which is numerically equal to this one but with any trailing + zeros removed from the representation. +
`MonetaryAmount`	MonetaryAmount.`subtract(MonetaryAmount subtrahend)`	+ Returns a `MonetaryAmount` whose value is `this - + amount`, and whose scale is `max(this.getContext().getMaxScale(), + subtrahend.getContext().getMaxScale()`. +
`default MonetaryAmount`	MonetaryAmount.`with(MonetaryOperator operator)`	+ Returns an operated object of the same type as this object with the operation made. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods in javax.money that return types with arguments of type MonetaryAmount
Modifier and Type	Method	Description
`java.lang.Class<? extends MonetaryAmount>`	MonetaryAmountFactory.`getAmountType()`	+ Access the `MonetaryAmount` implementation type. +
`java.lang.Class<? extends MonetaryAmount>`	MonetaryContext.`getAmountType()`	+ Get the MonetaryAmount implementation class. +
`static java.util.Collection<java.lang.Class<? extends MonetaryAmount>>`	Monetary.`getAmountTypes()`	+ Access all currently available `MonetaryAmount` implementation classes that are + accessible from this `MonetaryAmount` singleton. +
`static java.lang.Class<? extends MonetaryAmount>`	Monetary.`getDefaultAmountType()`	+ Access the default `MonetaryAmount` implementation class that is + accessible from this `MonetaryAmount` singleton. +
`MonetaryAmountFactory<? extends MonetaryAmount>`	MonetaryAmount.`getFactory()`	+ Creates a new `MonetaryAmountFactory`, returning the same implementation type Hereby + this given amount is used as a template, so reusing the `CurrencyUnit`, its numeric + value, the algorithmic implementation as well as the current `MonetaryContext`. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods in javax.money with parameters of type MonetaryAmount
Modifier and Type	Method	Description
`MonetaryAmount`	MonetaryAmount.`add(MonetaryAmount augend)`	+ Returns a `MonetaryAmount` whose value is `this + augend`, and whose scale is `max(this.getContext().getMaxScale(), + augend.getContext().getMaxScale())`. +
`MonetaryAmount`	MonetaryOperator.`apply(MonetaryAmount amount)`	+ Applies the operator on the given amount. +
`boolean`	MonetaryAmount.`isEqualTo(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	MonetaryAmount.`isGreaterThan(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	MonetaryAmount.`isGreaterThanOrEqualTo(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	MonetaryAmount.`isLessThan(MonetaryAmount amount)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`boolean`	MonetaryAmount.`isLessThanOrEqualTo(MonetaryAmount amt)`	+ Compares two instances of `MonetaryAmount`, hereby ignoring non significant trailing + zeroes and different numeric capabilities. +
`R`	MonetaryQuery.`queryFrom(MonetaryAmount amount)`	+ Queries the specified monetary amount. +
`default MonetaryAmountFactory<T>`	MonetaryAmountFactory.`setAmount(MonetaryAmount amount)`	+ Uses an arbitrary `MonetaryAmount` to initialize this factory. +
`MonetaryAmount`	MonetaryAmount.`subtract(MonetaryAmount subtrahend)`	+ Returns a `MonetaryAmount` whose value is `this - + amount`, and whose scale is `max(this.getContext().getMaxScale(), + subtrahend.getContext().getMaxScale()`. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method parameters in javax.money with type arguments of type MonetaryAmount
Modifier and Type	Method	Description
`static MonetaryContext`	MonetaryContext.`from(MonetaryAmountFactoryQuery monetaryAmountFactoryQuery, +java.lang.Class<? extends MonetaryAmount> amountClass)`	+ This method allows to easily of a new MonetaryContext instance from a given `.MonetaryAmountFactoryQuery`. +
`static MonetaryContext`	MonetaryContext.`from(MonetaryContext monetaryContext, +java.lang.Class<? extends MonetaryAmount> amountClass)`	+ Creates a new MonetaryContext). +
`static MonetaryContextBuilder`	MonetaryContextBuilder.`of(java.lang.Class<? extends MonetaryAmount> amountType)`	+ Creates a new builder, hereby the target implementation type is required. +
`MonetaryContextBuilder`	MonetaryContextBuilder.`setAmountType(java.lang.Class<? extends MonetaryAmount> amountType)`	+ Set the MonetaryAmount implementation class. +

+ + +

Uses of MonetaryAmount in javax.money.convert

+ + + + + + + + + + + + + + + + +

Methods in javax.money.convert with parameters of type MonetaryAmount
Modifier and Type	Method	Description
`ExchangeRate`	CurrencyConversion.`getExchangeRate(MonetaryAmount sourceAmount)`	+ Get the `ExchangeRate` applied for the given `MonetaryAmount` + . +

+ + +

Uses of MonetaryAmount in javax.money.format

+ + + + + + + + + + + + + + + + +

Methods in javax.money.format that return MonetaryAmount
Modifier and Type	Method	Description
`MonetaryAmount`	MonetaryAmountFormat.`parse(java.lang.CharSequence text)`	+ Fully parses the text into an instance of `MonetaryAmount`. +

+ + + + + + + + + + + + + + + + + + + + + +

Methods in javax.money.format with parameters of type MonetaryAmount
Modifier and Type	Method	Description
`default java.lang.String`	MonetaryAmountFormat.`format(MonetaryAmount amount)`	+ Formats the given `MonetaryAmount` to a String. +
`void`	MonetaryAmountFormat.`print(java.lang.Appendable appendable, +MonetaryAmount amount)`	+ Formats the given `MonetaryAmount` to a `Appendable`. +

+ + +

Uses of MonetaryAmount in javax.money.spi

+ + + + + + + + + + + + + + + + +

Classes in javax.money.spi with type parameters of type MonetaryAmount
Modifier and Type	Interface	Description
`interface`	`MonetaryAmountFactoryProviderSpi<T extends MonetaryAmount>`	+ SPI (core): Implementations of this interface are used by the `MonetaryAmountsSingletonSpi` to evaluate the + correct `MonetaryAmountFactory` instances. +

+ + + + + + + + + + + + + + + + +

Methods in javax.money.spi with type parameters of type MonetaryAmount
Modifier and Type	Method	Description
`<T extends MonetaryAmount> MonetaryAmountFactory<T>`	MonetaryAmountsSingletonSpi.`getAmountFactory(java.lang.Class<T> amountType)`	+ Access the `MonetaryAmountFactory` for the given `amountType` . +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods in javax.money.spi that return types with arguments of type MonetaryAmount
Modifier and Type	Method	Description
`java.util.Collection<MonetaryAmountFactory<? extends MonetaryAmount>>`	MonetaryAmountsSingletonQuerySpi.`getAmountFactories(MonetaryAmountFactoryQuery query)`	+ Get the `MonetaryAmountFactory` implementation class, that best matches to cover the given + `MonetaryContext`. +
`default java.lang.Class<? extends MonetaryAmount>`	MonetaryAmountsSingletonQuerySpi.`getAmountType(MonetaryAmountFactoryQuery query)`	+ Executes the query and returns the `MonetaryAmount` implementation type found, + if there is only one type. +
`default java.util.Collection<java.lang.Class<? extends MonetaryAmount>>`	MonetaryAmountsSingletonQuerySpi.`getAmountTypes(MonetaryAmountFactoryQuery query)`	+ Executes the query and returns the `MonetaryAmount` implementation types found. +
`java.util.Collection<java.lang.Class<? extends MonetaryAmount>>`	MonetaryAmountsSingletonSpi.`getAmountTypes()`	+ Get the currently registered `MonetaryAmount` implementation types. +
`java.lang.Class<? extends MonetaryAmount>`	MonetaryAmountsSingletonSpi.`getDefaultAmountType()`	+ Access the default `MonetaryAmount` implementation type. +

+ +

public interface ExchangeRateProvider

This interface defines access to the exchange rates provided by a provider. + The provider and its capabilities can be defined in arbitrary detail by the + corresponding ProviderContext. + Instances of this class must only provide conversion data for exact one provider, identified by + AbstractContext.getProviderName(). + + When accessing ExchangeRateProvider instances or CurrencyConversion instances from the + MonetaryConversions + in many cases a chain of providers will be returned. It is the responsibility of the implementation code assembling + the chain to + establish a well defined coordination mechanism for evaluating the correct result. By default the first provider + in the chain that returns a non null result determines the final result of a call. Nevertheless adapting the + MonetaryConversionsSingletonSpi allows + to implement also alternate strategies, e.g. honoring different priorities of providers as well. +

+ Implementations of this interface are required to be thread save. +

+ Implementations of this class must neither be immutable nor serializable.

Author:: Anatole Tresch, Werner Keil

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Modifier and Type	Method	Description
`ProviderContext`	`getContext()`	+ Access the `ConversionContext` for this + `ExchangeRateProvider`. +
`default CurrencyConversion`	`getCurrencyConversion(java.lang.String termCode)`	+ Access a `CurrencyConversion` that can be applied as a + `MonetaryOperator` to an amount. +
`CurrencyConversion`	`getCurrencyConversion(ConversionQuery conversionQuery)`	+ Access a `CurrencyConversion` that can be applied as a + `MonetaryOperator` to an amount. +
`default CurrencyConversion`	`getCurrencyConversion(CurrencyUnit term)`	+ Access a `CurrencyConversion` that can be applied as a + `MonetaryOperator` to an amount. +
`default ExchangeRate`	`getExchangeRate(java.lang.String baseCode, +java.lang.String termCode)`	+ Access a `ExchangeRate` using the given currencies. +
`ExchangeRate`	`getExchangeRate(ConversionQuery conversionQuery)`	+ Access a `ExchangeRate` using the given currencies. +
`default ExchangeRate`	`getExchangeRate(CurrencyUnit base, +CurrencyUnit term)`	+ Access a `ExchangeRate` using the given currencies. +
`default ExchangeRate`	`getReversed(ExchangeRate rate)`	+ The method reverses the `ExchangeRate` to a rate mapping from term + to base `CurrencyUnit`. +
`default boolean`	`isAvailable(java.lang.String baseCode, +java.lang.String termCode)`	+ Checks if an `ExchangeRate` between two `CurrencyUnit` is + available from this provider. +
`default boolean`	`isAvailable(ConversionQuery conversionQuery)`	+ Checks if an `ExchangeRate` between two `CurrencyUnit` is + available from this provider. +
`default boolean`	`isAvailable(CurrencyUnit base, +CurrencyUnit term)`	+ Checks if an `ExchangeRate` between two `CurrencyUnit` is + available from this provider. +

+
+ + +
Method Details
+
- +
  +
  getContext
  +
  ProviderContext getContext()
  +
  Access the ConversionContext for this + ExchangeRateProvider. Each instance of + ExchangeRateProvider provides conversion data for exact one + ConversionContext .
  +
  +
  Returns:
  +
  the exchange rate type, never null.
  +
  +
  +
- +
  +
  getExchangeRate
  +
  ExchangeRate getExchangeRate(ConversionQuery conversionQuery)
  +
  Access a ExchangeRate using the given currencies. The + ExchangeRate may be, depending on the data provider, real-time or + deferred. This method should return the rate that is currently + valid.
  +
  +
  Parameters:
  +
  conversionQuery - the required ConversionQuery, not null
  +
  Returns:
  +
  the matching ExchangeRate.
  +
  Throws:
  +
  CurrencyConversionException - If no such rate is available.
  +
  MonetaryException - if one of the currency codes passed is not valid.
  +
  See Also:
  +
  ConversionQueryBuilder
  +
  +
  +
- +
  +
  getCurrencyConversion
  +
  CurrencyConversion getCurrencyConversion(ConversionQuery conversionQuery)
  +
  Access a CurrencyConversion that can be applied as a + MonetaryOperator to an amount.
  +
  +
  Parameters:
  +
  conversionQuery - the required ConversionQuery, not null
  +
  Returns:
  +
  a new instance of a corresponding CurrencyConversion, + never null.
  +
  Throws:
  +
  MonetaryException - if one of the currency codes passed is not valid.
  +
  See Also:
  +
  ConversionQueryBuilder
  +
  +
  +
- +
  +
  isAvailable
  +
  default boolean isAvailable(ConversionQuery conversionQuery)
  +
  Checks if an ExchangeRate between two CurrencyUnit is + available from this provider. This method should check, if a given rate + is currently defined.
  +
  +
  Parameters:
  +
  conversionQuery - the required ConversionQuery, not null
  +
  Returns:
  +
  true, if such an ExchangeRate is currently + defined.
  +
  +
  +
- +
  +
  getExchangeRate
  +
  default ExchangeRate getExchangeRate(CurrencyUnit base, +CurrencyUnit term)
  +
  Access a ExchangeRate using the given currencies. The + ExchangeRate may be, depending on the data provider, real-time or + deferred. This method should return the rate that is currently + valid.
  +
  +
  Parameters:
  +
  base - base CurrencyUnit, not null
  +
  term - term CurrencyUnit, not null
  +
  Returns:
  +
  the matching ExchangeRate.
  +
  Throws:
  +
  CurrencyConversionException - If no such rate is available.
  +
  +
  +
- +
  +
  getCurrencyConversion
  +
  default CurrencyConversion getCurrencyConversion(CurrencyUnit term)
  +
  Access a CurrencyConversion that can be applied as a + MonetaryOperator to an amount.
  +
  +
  Parameters:
  +
  term - term CurrencyUnit, not null
  +
  Returns:
  +
  a new instance of a corresponding CurrencyConversion, + never null.
  +
  +
  +
- +
  +
  isAvailable
  +
  default boolean isAvailable(CurrencyUnit base, +CurrencyUnit term)
  +
  Checks if an ExchangeRate between two CurrencyUnit is + available from this provider. This method should check, if a given rate + is currently defined.
  +
  +
  Parameters:
  +
  base - the base CurrencyUnit
  +
  term - the term CurrencyUnit
  +
  Returns:
  +
  true, if such an ExchangeRate is currently + defined.
  +
  +
  +
- +
  +
  isAvailable
  +
  default boolean isAvailable(java.lang.String baseCode, +java.lang.String termCode)
  +
  Checks if an ExchangeRate between two CurrencyUnit is + available from this provider. This method should check, if a given rate + is currently defined.
  +
  +
  Parameters:
  +
  baseCode - the base currency code
  +
  termCode - the terminal/target currency code
  +
  Returns:
  +
  true, if such an ExchangeRate is currently + defined.
  +
  Throws:
  +
  MonetaryException - if one of the currency codes passed is not valid.
  +
  +
  +
- +
  +
  getExchangeRate
  +
  default ExchangeRate getExchangeRate(java.lang.String baseCode, +java.lang.String termCode)
  +
  Access a ExchangeRate using the given currencies. The + ExchangeRate may be, depending on the data provider, real-time or + deferred. This method should return the rate that is currently + valid.
  +
  +
  Parameters:
  +
  baseCode - base currency code, not null
  +
  termCode - term/target currency code, not null
  +
  Returns:
  +
  the matching ExchangeRate.
  +
  Throws:
  +
  CurrencyConversionException - If no such rate is available.
  +
  MonetaryException - if one of the currency codes passed is not valid.
  +
  +
  +
- +
  +
  getReversed
  +
  default ExchangeRate getReversed(ExchangeRate rate)
  +
  The method reverses the ExchangeRate to a rate mapping from term + to base CurrencyUnit. Hereby the factor must not be + recalculated as 1/oldFactor, since typically reverse rates are + not symmetric in most cases.
  +
  +
  Parameters:
  +
  rate - ExchangeRate, not null
  +
  Returns:
  +
  the matching reversed ExchangeRate, or null, if + the rate cannot be reversed.
  +
  +
  +
- +
  +
  getCurrencyConversion
  +
  default CurrencyConversion getCurrencyConversion(java.lang.String termCode)
  +
  Access a CurrencyConversion that can be applied as a + MonetaryOperator to an amount.
  +
  +
  Parameters:
  +
  termCode - terminal/target currency code, not null
  +
  Returns:
  +
  a new instance of a corresponding CurrencyConversion, + never null.
  +
  Throws:
  +
  MonetaryException - if one of the currency codes passed is not valid.
  +
  +
  +
+
+

+ +

java.lang.Object +

javax.money.convert.MonetaryConversions

public final class MonetaryConversions
+extends java.lang.Object

This singleton defines access to the exchange and currency conversion logic + of JavaMoney. It allows to evaluate the currently available exchange rate + type instances and provides access to the corresponding + ExchangeRateProvider and CurrencyConversion instances. +

+ This class is thread safe. +

+ This class is designed to support also contextual behaviour, e.g. in Java EE + containers each application may provide its own ExchangeRateProvider + instances, e.g. by registering them as CDI beans. An EE container can + register an according MonetaryConversionsSingletonSpi that manages the + different application contexts transparently. In a SE environment this class + is expected to behave like an ordinary singleton, loading its SPIs e.g. from the + JDK ServiceLoader or an alternate component and service provider. +

+ This class is thread-safe. Hereby it is important to know that it delegates + to the registered MonetaryConversionsSingletonSpi SPI, which also is required + to be thread-safe.

Author:: Anatole Tresch, Werner Keil

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Modifier and Type	Method	Description
`static CurrencyConversion`	`getConversion(java.lang.String termCurrencyCode, +java.lang.String... providers)`	+ Access an instance of `CurrencyConversion` for the given providers. +
`static CurrencyConversion`	`getConversion(ConversionQuery conversionQuery)`	+ Access an instance of `CurrencyConversion` for the given providers. +
`static CurrencyConversion`	`getConversion(CurrencyUnit termCurrency, +java.lang.String... providers)`	+ Access an instance of `CurrencyConversion` for the given providers. +
`static java.util.Collection<java.lang.String>`	`getConversionProviderNames()`	+ Return the (non localized) names of all providers available in the + current context. +
`static java.util.List<java.lang.String>`	`getDefaultConversionProviderChain()`	+ Get the default provider used. +
`static ExchangeRateProvider`	`getExchangeRateProvider(java.lang.String... providers)`	+ Access an instance of `CurrencyConversion` using the given + providers as a provider chain. +
`static ExchangeRateProvider`	`getExchangeRateProvider(ConversionQuery conversionQuery)`	+ Access an instance of `CurrencyConversion` using the given + providers as a provider chain. +
`static ExchangeRateProvider`	`getExchangeRateProvider(ExchangeRateProviderSupplier provider, +ExchangeRateProviderSupplier... providers)`	+ Access an instance of `CurrencyConversion` using the + `ExchangeRateProviderSupplier`. +
`static boolean`	`isConversionAvailable(java.lang.String currencyCode, +java.lang.String... providers)`	+ Checks if a `CurrencyConversion` is available for the given parameters. +
`static boolean`	`isConversionAvailable(ConversionQuery conversionQuery)`	+ Checks if a `CurrencyConversion` is available for the given parameters. +
`static boolean`	`isConversionAvailable(CurrencyUnit termCurrency, +java.lang.String... providers)`	+ Checks if a `CurrencyConversion` is available for the given parameters. +
`static boolean`	`isExchangeRateProviderAvailable(ConversionQuery conversionQuery)`	+ Checks if a `ExchangeRateProvider` is available for the given parameters. +

Methods inherited from class java.lang.Object

+ + +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+
+ + +
Method Details
+
- +
  +
  getConversion
  +
  public static CurrencyConversion getConversion(CurrencyUnit termCurrency, +java.lang.String... providers)
  +
  Access an instance of CurrencyConversion for the given providers. + Use getConversionProviderNames() to check, which are available.
  +
  +
  Parameters:
  +
  termCurrency - the terminating or target currency, not null
  +
  providers - Additional providers, for building a provider chain
  +
  Returns:
  +
  the exchange rate type if this instance.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such ExchangeRateProvider is available.
  +
  +
  +
- +
  +
  getConversion
  +
  public static CurrencyConversion getConversion(java.lang.String termCurrencyCode, +java.lang.String... providers)
  +
  Access an instance of CurrencyConversion for the given providers. + Use getConversionProviderNames()} to check, which are available.
  +
  +
  Parameters:
  +
  termCurrencyCode - the terminating or target currency code, not null
  +
  providers - Additional providers, for building a provider chain
  +
  Returns:
  +
  the exchange rate type if this instance.
  +
  Throws:
  +
  MonetaryException - if no such ExchangeRateProvider is available or if no CurrencyUnit was + matching the given currency code.
  +
  +
  +
- +
  +
  getConversion
  +
  public static CurrencyConversion getConversion(ConversionQuery conversionQuery)
  +
  Access an instance of CurrencyConversion for the given providers. + Use getConversionProviderNames()} to check, which are available.
  +
  +
  Parameters:
  +
  conversionQuery - The ConversionQuery required, not null
  +
  Returns:
  +
  the CurrencyConversion instance matching.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if the query defines ExchangeRateProviders that are not available.
  +
  +
  +
- +
  +
  isConversionAvailable
  +
  public static boolean isConversionAvailable(ConversionQuery conversionQuery)
  +
  Checks if a CurrencyConversion is available for the given parameters.
  +
  +
  Parameters:
  +
  conversionQuery - the ConversionQuery, not null.
  +
  Returns:
  +
  true, if a conversion is accessible from getConversion(ConversionQuery).
  +
  +
  +
- +
  +
  isConversionAvailable
  +
  public static boolean isConversionAvailable(java.lang.String currencyCode, +java.lang.String... providers)
  +
  Checks if a CurrencyConversion is available for the given parameters.
  +
  +
  Parameters:
  +
  currencyCode - The currency code, resolvable by (String, String...)
  +
  providers - Additional providers, for building a provider chain
  +
  Returns:
  +
  true, if a conversion is accessible from getConversion(String, String...).
  +
  +
  +
- +
  +
  isConversionAvailable
  +
  public static boolean isConversionAvailable(CurrencyUnit termCurrency, +java.lang.String... providers)
  +
  Checks if a CurrencyConversion is available for the given parameters.
  +
  +
  Parameters:
  +
  termCurrency - the terminating or target currency, not null
  +
  providers - Additional providers, for building a provider chain
  +
  Returns:
  +
  true, if a conversion is accessible from getConversion(String, String...).
  +
  +
  +
- +
  +
  getExchangeRateProvider
  +
  public static ExchangeRateProvider getExchangeRateProvider(java.lang.String... providers)
  +
  Access an instance of CurrencyConversion using the given + providers as a provider chain. Use getConversionProviderNames()s + to check, which are available.
  +
  +
  Parameters:
  +
  providers - Additional providers, for building a provider chain
  +
  Returns:
  +
  the exchange rate provider.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such ExchangeRateProvider is available.
  +
  +
  +
- +
  +
  getExchangeRateProvider
  +
  public static ExchangeRateProvider getExchangeRateProvider(ExchangeRateProviderSupplier provider, +ExchangeRateProviderSupplier... providers)
  +
  Access an instance of CurrencyConversion using the + ExchangeRateProviderSupplier.
  +
  +
  Parameters:
  +
  provider - the exchange rate provider.
  +
  providers - the exchange rate provider.
  +
  Returns:
  +
  the exchange rate provider.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such ExchangeRateProvider is available.
  +
  +
  +
- +
  +
  getExchangeRateProvider
  +
  public static ExchangeRateProvider getExchangeRateProvider(ConversionQuery conversionQuery)
  +
  Access an instance of CurrencyConversion using the given + providers as a provider chain. Use getConversionProviderNames() + to check, which are available.
  +
  +
  Parameters:
  +
  conversionQuery - the ConversionQuery, not null.
  +
  Returns:
  +
  the exchange rate provider.
  +
  Throws:
  +
  java.lang.IllegalArgumentException - if no such ExchangeRateProvider is available.
  +
  +
  +
- +
  +
  isExchangeRateProviderAvailable
  +
  public static boolean isExchangeRateProviderAvailable(ConversionQuery conversionQuery)
  +
  Checks if a ExchangeRateProvider is available for the given parameters.
  +
  +
  Parameters:
  +
  conversionQuery - the ConversionQuery, not null.
  +
  Returns:
  +
  true, if a rate provider is accessible from getExchangeRateProvider(ConversionQuery)}.
  +
  +
  +
- +
  +
  getConversionProviderNames
  +
  public static java.util.Collection<java.lang.String> getConversionProviderNames()
  +
  Return the (non localized) names of all providers available in the + current context. Each id can be used to obtain + ExchangeRateProvider or CurrencyConversion instances.
  +
  +
  Returns:
  +
  all supported provider ids, never null.
  +
  +
  +
- +
  +
  getDefaultConversionProviderChain
  +
  public static java.util.List<java.lang.String> getDefaultConversionProviderChain()
  +
  Get the default provider used.
  +
  +
  Returns:
  +
  the default provider, never null.
  +
  +
  +
+
+

javax.money.AbstractQuery
Modifier and Type	Constant Field	Value
+ +`protected static final String`	`KEY_QUERY_PROVIDERS`	`"Query.providers"`
+ +`protected static final String`	`KEY_QUERY_TARGET_TYPE`	`"Query.targetType"`
+ +`protected static final String`	`KEY_QUERY_TIMESTAMP`	`"Query.timestamp"`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`<T> T`	`get(Class<T> type)` + Access an attribute, hereby using the class name as key. +
`<T> T`	`get(String key, + Class<T> type)` + Access an attribute. +
`Boolean`	`getBoolean(String key)` + Access a Boolean attribute. +
`Double`	`getDouble(String key)` + Access a Double attribute. +
`Float`	`getFloat(String key)` + Access a Float attribute. +
`Integer`	`getInt(String key)` + Access an Integer attribute. +
`Set<String>`	`getKeys(Class<?> type)` + Get the present keys of all entries with a given type, checking hereby if assignable. +
`Long`	`getLong(String key)` + Access a Long attribute. +
`String`	`getProviderName()` + Get the provider name of this context. +
`String`	`getText(String key)` + Access a String attribute. +
`Class<?>`	`getType(String key)` + Get the current attribute type. +
`int`	`hashCode()`
`boolean`	`isEmpty()` + Checks if the current instance has no attributes set. +
`String`	`toString()`

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract C`	`build()` + Creates a new `AbstractContext` with the data from this Builder + instance. +
`B`	`importContext(AbstractContext context)` + Apply all attributes on the given context, hereby existing entries are preserved. +
`B`	`importContext(AbstractContext context, + boolean overwriteDuplicates)` + Apply all attributes on the given context. +
`B`	`removeAttributes(String... keys)` + Removes an entry of a certain keys. +
`<T> B`	`set(Class<T> key, + T value)` + Sets an attribute, using `attribute.getClass()` as attribute + type. +
`B`	`set(Object value)` + Sets an attribute, using `attribute.getClass()` as attribute + type and `attribute.getClass().getName()` as attribute + name. +
`B`	`set(String key, + boolean value)` + Sets an Boolean attribute. +
`B`	`set(String key, + char value)` + Sets an Character attribute. +
`B`	`set(String key, + double value)` + Sets an Double attribute. +
`B`	`set(String key, + float value)` + Sets an Float attribute. +
`B`	`set(String key, + int value)` + Sets an Integer attribute. +
`B`	`set(String key, + long value)` + Sets an Long attribute. +
`B`	`set(String key, + Object value)` + Sets an attribute, using `attribute.getClass()` as attribute + type. +
`B`	`setProviderName(String provider)` + Sets the provider. +
`String`	`toString()`

Fields
Modifier and Type	Field and Description
`protected static String`	`KEY_QUERY_PROVIDERS` + Key for storing the target providers to be queried +
`protected static String`	`KEY_QUERY_TARGET_TYPE` + Key name for the target type attribute. +
`protected static String`	`KEY_QUERY_TIMESTAMP` + Key name for the timestamp attribute. +

Blog

Fourth Post

Third Post

Second Post

First Post

About

Welcome to JavaMoney - the Java Money and Currency API for the Java™ Platform as well as related projects and libraries

JCP Page

Blog Archive

Oktober 2013

October 2013

September 2013

May 2013

August 2013

Juli 2013

Early Draft

Early Draft

Public Draft

Public Draft

Welcome to JavaMoney - the Java Money and Currency API for the Java™ Platform as well as related projects and libraries

News

Blog

Public Draft

Public Draft

Early Draft

Early Draft

News

Library

JavaMoney financial library, evolved from JSR 354 development.

Welcome to the JavaMoney financial library.

-Welcome to Moneta - the JSR 354 reference implementation

-Authors and Contributors

-Support or Contact

-Welcome to the JSR 354 Technical Compatibiliy Kit (TCK)

-Authors and Contributors

-Support or Contact

Moneta

JSR 354 RI

Reference Implementation of JSR 354

+Welcome to Moneta - the JSR 354 reference implementation

+Authors and Contributors

+Support or Contact

TCK

JSR 354 TCK

Technical Compatibiliy Kit (TCK) of JSR 354

+Welcome to the JSR 354 Technical Compatibiliy Kit (TCK)

+Authors and Contributors

+Support or Contact

Early Draft

Public Draft

** rounding and formatting features, ** regions and validite4s support ** bundles for different runtime environments -

+ + +

Authors and Contributors

Support or Contact

Authors and Contributors

Support or Contact

Authors and Contributors

diff --git a/tck.html b/tck.html index db737f8..c12a754 100644 --- a/tck.html +++ b/tck.html @@ -98,7 +98,7 @@

Authors and Contributors

Blog

Public Draft

Library

-Welcome to the JavaMoney financial library.

-Authors and Contributors

-javamoney-incubator

-Support or Contact

Moneta

JSR 354 RI

Reference Implementation of JSR 354

-Welcome to Moneta - the JSR 354 reference implementation

-Authors and Contributors

-Support or Contact

Library

+Welcome to the JavaMoney financial library.

+Authors and Contributors

+javamoney-incubator

+Support or Contact

Moneta

JSR 354 RI

Reference Implementation of JSR 354

rounding and formatting features, regions and validite4s support ** bundles for different runtime environments -

`</dependency>`