Add documentation for the MonetaryAmountType

vladmihalcea · Jul 26, 2022 · f91d195 · f91d195
1 parent abcfc8f
commit f91d195
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -128,6 +128,7 @@ For more details, check out [this article](https://vladmihalcea.com/how-to-map-j
 
 #### Generic Types
 
+* [The best way to map `MonetaryAmount` with JPA and Hibernate](https://vladmihalcea.com/monetaryamount-jpa-hibernate/)
 * [How to map `java.time.YearMonth` to DATE or INTEGER column](https://vladmihalcea.com/java-yearmonth-jpa-hibernate/)
 * [How to map `java.time.Year` and `java.time.Month` with JPA and Hibernate](https://vladmihalcea.com/java-time-year-month-jpa-hibernate/)
 * [`Character` to nullable CHAR column](https://vladmihalcea.com/how-to-implement-a-custom-basic-type-using-hibernate-usertype/)

diff --git a/...nate-types-52/src/main/java/com/vladmihalcea/hibernate/type/money/MonetaryAmountType.java b/...nate-types-52/src/main/java/com/vladmihalcea/hibernate/type/money/MonetaryAmountType.java
@@ -20,7 +20,12 @@
 import static java.sql.Types.VARCHAR;
 
 /**
- * Maps a {@link MonetaryAmount} object type to composite columns (with amount and with currency).
+ * Maps a {@link MonetaryAmount} object type onto two columns (amount and currency).
+ *
+ * <p>
+ * For more details about how to use it,
+ * check out <a href="https://vladmihalcea.com/monetaryamount-jpa-hibernate/">this article</a>
+ * on <a href="https://vladmihalcea.com/">vladmihalcea.com</a>.
  *
  * @author Piotr Olaszewski
  */

diff --git a/...nate-types-55/src/main/java/com/vladmihalcea/hibernate/type/money/MonetaryAmountType.java b/...nate-types-55/src/main/java/com/vladmihalcea/hibernate/type/money/MonetaryAmountType.java
@@ -20,7 +20,12 @@
 import static java.sql.Types.VARCHAR;
 
 /**
- * Maps a {@link MonetaryAmount} object type to composite columns (with amount and with currency).
+ * Maps a {@link MonetaryAmount} object type onto two columns (amount and currency).
+ *
+ * <p>
+ * For more details about how to use it,
+ * check out <a href="https://vladmihalcea.com/monetaryamount-jpa-hibernate/">this article</a>
+ * on <a href="https://vladmihalcea.com/">vladmihalcea.com</a>.
  *
  * @author Piotr Olaszewski
  */

diff --git a/...nate-types-60/src/main/java/com/vladmihalcea/hibernate/type/money/MonetaryAmountType.java b/...nate-types-60/src/main/java/com/vladmihalcea/hibernate/type/money/MonetaryAmountType.java
@@ -12,7 +12,12 @@
 import java.util.Objects;
 
 /**
- * Maps a {@link MonetaryAmount} object type to composite columns (with amount and with currency).
+ * Maps a {@link MonetaryAmount} object type onto two columns (amount and currency).
+ *
+ * <p>
+ * For more details about how to use it,
+ * check out <a href="https://vladmihalcea.com/monetaryamount-jpa-hibernate/">this article</a>
+ * on <a href="https://vladmihalcea.com/">vladmihalcea.com</a>.
  *
  * @author Piotr Olaszewski
  */