JSR 354 (Money and Currency API) 1.1 · javax.money

Main package of the Money and Currency API. In more detail:

JSR 354 defines a minimal set of interfaces for interoperability, since concrete usage scenarios do not allow to define an implementation that is capable of covering all aspects identified. Consequently it must be possible that implementations can provide several implementations for monetary amounts. Users should not reference the interfaces, instead the value types should be used.
Implementations must provide value types for currencies and amounts, implementing javax.money.CurrencyUnit and javax.money.MonetaryAmount.
Implementations must also provide a minimal set of roundings, modeled as javax.money.MonetaryRounding. This should include basic roundings for ISO currencies, roundings defined by java.math.MathContext or java.math.RoundingMode.
This API must avoid restrictions that prevents its use in different runtime environments, such as EE or ME.
Method naming and style for currency modeling should be in alignment with parts of the Java Collection API or java.time / [JodaMoney].

Interface Summary

Modifier and Type	Interface and Description
public interface	CurrencySupplier Represents a supplier of `CurrencyUnit`-valued results.
public interface	CurrencyUnit A unit of currency.
public interface	MonetaryAmount Interface defining a monetary amount.
public interface	MonetaryAmountFactory<T extends MonetaryAmount> Factory for `MonetaryAmount` instances for a given type.
public interface	MonetaryOperator Represents an operation on a single `MonetaryAmount` that produces a result of type `MonetaryAmount`.
public interface	MonetaryQuery< the return type. R> Strategy for querying a monetary amount.
public interface	MonetaryRounding Interface representing a monetary rounding.
public interface	NumberSupplier Represents a supplier of `NumberValue`-valued results.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractContext Represents a general context of data targeting an item of type `Q`.
public abstract class	AbstractContextBuilder<B extends AbstractContextBuilder, C extends AbstractContext> This interface defines the common generic parts of a query.
public abstract class	AbstractQuery Represents a general context of data targeting an item of type `Q`.
public abstract class	AbstractQueryBuilder<B extends AbstractQueryBuilder, C extends AbstractQuery> This abstract class defines the common generic parts of a query.
public class	CurrencyContext This class models the attributable context of `javax.money.CurrencyUnit` instances.
public class	CurrencyContextBuilder Builder class for creating new instances of `CurrencyContext` adding detailed information about a `CurrencyUnit` instance.
public class	CurrencyQuery This class models a query for accessing instances of `CurrencyUnit`.
public class	CurrencyQueryBuilder Builder for queries for accessing `javax.money.CurrencyUnit` instances.
pack-priv class	DefaultMonetaryCurrenciesSingletonSpi Factory singleton for `CurrencyUnit` instances as provided by the different registered `javax.money.spi.CurrencyProviderSpi` instances.
public class	DefaultMonetaryRoundingsSingletonSpi This class models the accessor for rounding instances, modeled as `javax.money.MonetaryOperator`.
public class	Monetary Factory singleton for `CurrencyUnit`, `javax.money.MonetaryAmount` and `javax.money.MonetaryRounding` instances as provided by the different registered SPI instances.
public class	MonetaryAmountFactoryQuery Query to lookup instances of `MonetaryAmountFactory`, which are determined by the (minimal) capabilities required by the give use case.
public class	MonetaryAmountFactoryQueryBuilder Builder class for creating new instances of `MonetaryAmountFactoryQuery` that can be passed to access `MonetaryAmountFactory` instances using a possible complex query.
public class	MonetaryContext This class models the meta data (mostly the numeric capabilities) of a `MonetaryAmount` in a platform independent way.
public class	MonetaryContextBuilder Builder class for creating new instances of `MonetaryContext` adding detailed information about a `MonetaryAmount` instance.
public class	MonetaryException Exception thrown when an error occurs during monetary operations.
public abstract class	NumberValue Instances of this class allow to externalize the numeric value of a `MonetaryAmount`.
public class	RoundingContext This class models the spec/configuration for a rounding, modeled as `javax.money.MonetaryRounding` in a platform independent way.
public class	RoundingContextBuilder Builder class for creating new instances of `RoundingContext` adding detailed information about a `MonetaryRounding` instance.
public class	RoundingQuery Query for accessing instances of `javax.money.MonetaryRounding`.
public class	RoundingQueryBuilder Builder used to construct new instances of RoundingQuery}.
public class	UnknownCurrencyException Exception thrown when a currency code cannot be resolved into a `CurrencyUnit`.

Package javax.money

Interface Summary

Class Summary