Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javamoney/jakarta-money
The helpful library to get a better developer experience when combining Money-API with Jakarta and MicroProfile API.
https://github.com/javamoney/jakarta-money
Last synced: about 2 months ago
JSON representation
The helpful library to get a better developer experience when combining Money-API with Jakarta and MicroProfile API.
- Host: GitHub
- URL: https://github.com/javamoney/jakarta-money
- Owner: JavaMoney
- License: apache-2.0
- Created: 2022-04-10T09:26:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-20T20:25:09.000Z (over 2 years ago)
- Last Synced: 2024-04-16T18:20:41.528Z (9 months ago)
- Language: Java
- Size: 197 KB
- Stars: 21
- Watchers: 10
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jakarta-money
Jakarta money is a helpful library for a better developer experience when combining Money-API with Jakarta and MicroProfile API.
**The dependency:**
```xml
org.javamoney
jakarta
0.0.1-SNAPSHOT
```
The API brings some libraries that is split by specification:
* Bean Validator
* JAXRS
* CDI
* JPA
* JSF
* XML bind (jaxb)
## Bean Validator
JSR 380 is a specification of the Java API for bean validation, part of Jakarta EE and JavaSE. It ensures that the properties of a bean meet specific criteria, using annotations such as @NotNull, @Min, and @Max.
To make an integration with Java-money Jakarta-money has four annotations:
**CurrencyAccepted**: Informs the currencies that are allowed on validation. It works with `MonetaryAmount` and `CurrencyUnit`.
```java
@CurrencyAccepted(currencies = "BRL")
private MonetaryAmount money;
@CurrencyAccepted(currencies = "BRL")
private CurrencyUnit currencyUnit;
```
**CurrencyRejected**: Informs the currencies that are rejected on validation. It works with `MonetaryAmount` and `CurrencyUnit`.
```java
@CurrencyRejected(currencies = "BRL")
private MonetaryAmount money;
@CurrencyRejected(currencies = "BRL")
private CurrencyUnit currencyUnit;
```
**MonetaryMax**: Informs the maximum value of a `MonetaryAmount`.
```java
@MonetaryMax("10.12")
private MonetaryAmount money;
```
**MonetaryMin**: Informs the minimum value of a `MonetaryAmount`.
```java
@MonetaryMin("10.12")
private MonetaryAmount money;
```
## JAXRS
If you want JAX-RS to automatically convert parameters such as query params, path params, or others, you need to create a ParamConverter.
It has support to:
* CurrencyUnit
* MonetaryAmount
```java
@Path("monetary")
@ApplicationScoped
public class MoneyResource {
@GET
public String findByCurrency(@QueryParam("currency") CurrencyUnit currency) {
return "hello, " + currency;
}
}
```
## JPA
Jakarta Persistence defines a standard for managing persistence and object/relational mapping in Java(R) environments.
It has support to both: `MoneyAmount` and `CurrencyUnit`.
```java
@Column
@Convert(converter = CurrencyConverter.class)
private CurrencyUnit currency;
@Column
@Convert(converter = MoneyConverter.class)
private MonetaryAmount money;
```
## CDI
### Currency Annotation
The `Currency` annotation allows to inject a currency unit based in the Currency code.
```java
@Inject
@Currency("USD")
private CurrencyUnit currency;
```
### MonetaryProducer
The MonetaryProducer annotations allows to inject the `MonetaryAmountProducer`
```java
@Inject
@MonetaryProducer
private MonetaryAmountProducer producer;
@Inject
@Currency("EUR")
private CurrencyUnit currency;
//
MonetaryAmount amount = producer.create(currency, 10);
```
## XML Bind
Jakarta XML Bind provides an XmlAdapter which can be used to transform custom classes to String and vice versa.
```java
@XmlJavaTypeAdapter(CurrencyUnitAdapter.class)
private CurrencyUnit currency;
@XmlJavaTypeAdapter(MonetaryAmountAdapter.class)
private MonetaryAmount money;
```