Skip to content

Commit 6a17815

Browse files
committed
Slightly updated JavaDoc.
1 parent 195c0da commit 6a17815

File tree

4 files changed

+13
-10
lines changed

4 files changed

+13
-10
lines changed

src/main/java/javax/money/CurrencyUnit.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
* concrete implementation type and currency code.
2727
* <li>are required to be thread-safe
2828
* <li>are required to be immutable
29+
* <li>are required to be comparable
2930
* <li>are highly recommended to be serializable.
3031
* </ul>
3132
*
@@ -48,11 +49,11 @@ public interface CurrencyUnit {
4849
* For ISO codes the 3-letter ISO code should be returned. For non ISO
4950
* currencies no constraints are defined.
5051
*
51-
* @return the currency code, never {@code null}. For the ISO-4217
52-
* namespace, this this will be the three letter ISO-4217 code.
53-
* However, alternate currencies can have different codes. Also
54-
* there is no constraint about the formatting of alternate codes,
55-
* despite they fact that the currency codes must be unique.
52+
* @return the currency code, never {@code null}. For ISO-4217 this this
53+
* will be the three letter ISO-4217 code. However, alternate
54+
* currencies can have different codes. Also there is no constraint
55+
* about the formatting of alternate codes, despite they fact that
56+
* the currency codes must be unique.
5657
*/
5758
public String getCurrencyCode();
5859

src/main/java/javax/money/MonetaryAdjuster.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@
2727
* instead of the interface to support a fluent style:
2828
*
2929
* <pre>
30-
* // these two lines are equivalent, but the second approach is recommended
30+
* // these two variants are equivalent
3131
* monetary = thisAdjuster.adjustInto(monetary);
3232
* monetary = anotherAdjuster.adjustInto(monetary);
3333
*
34-
* // second approach, using a fluent API
34+
* // second, recommended, approach, using a fluent API
3535
* monetary = monetary.with(thisAdjuster).with(anotherAdjuster);
3636
* </pre>
3737
*

src/main/java/javax/money/MonetaryAmount.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@
3434
* <li>Monetary amounts should allow numbers as argument for arithmetic
3535
* operations like division and multiplication additionally to a MonetaryAmount.
3636
* Adding or subtracting of amounts must only be possible by passing instances
37-
* of MonetaryAmount. Arguments of type {@link Number} should be avoided, since
38-
* it does not allow to extract its numeric value in a feasible way.
37+
* of MonetaryAmount.</li>
38+
* <li>Arguments of type {@link Number} should be avoided, since
39+
* it does not allow to extract its numeric value in a feasible way.</li>
3940
* <li>If the numeric representation of a {@code MonetaryAmount} exceeds the
4041
* numeric capabilities of the concrete type {@code T from(MonetaryAmount)}, an
4142
* implementation should throw an {@code ArithemticOperationException}.</li>
@@ -44,7 +45,7 @@
4445
* {@code ArithmeticException} should be thrown. Never should truncation be
4546
* performed implicitly.</li>
4647
* <li>Nevertheless truncation may be supported by passing additional parameters
47-
* or using <i>exact</i> methods, similar to {@link BigDecimal#longValueExact()}.
48+
* or defining <i>exact</i> methods, similar to {@link BigDecimal#longValueExact()}.
4849
* <li>Rounding should never be done automatically, exception internal rounding
4950
* implied by the numeric implementation type.</li>
5051
* <li>Since implementations are recommended to be immutable, an operation

src/main/java/javax/money/MonetaryQuery.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
* <pre>
2828
* // these two lines are equivalent, but the second approach is recommended
2929
* monetary = thisQuery.queryFrom(monetary);
30+
* // recommened approach
3031
* monetary = monetary.query(thisQuery);
3132
* </pre>
3233
* It is recommended to use the second approach, {@code query(MonetaryQuery)},

0 commit comments

Comments
 (0)