|
17 | 17 | * US Dollar, Bitcoin or other. It is mainly defined to provide interoperability |
18 | 18 | * between different implementations. |
19 | 19 | * <p> |
20 | | - * Currencies can be distinguished within separate arbitrary currency name |
21 | | - * spaces, whereas as {@link #ISO_NAMESPACE} will be the the most commonly used |
22 | | - * one, similar to {@link java.util.Currency}. |
| 20 | + * Currencies can be distinguished by separate {@link #getCurrencyCode()} codes, |
| 21 | + * similar to {@link java.util.Currency}. |
23 | 22 | * <p> |
24 | 23 | * Implementation of this class are required to be |
25 | 24 | * <ul> |
|
37 | 36 | public interface CurrencyUnit { |
38 | 37 |
|
39 | 38 | /** |
40 | | - * Gets the currency code, the effective code depends on the currency and |
41 | | - * the name space. It is possible that the two currency may have the same |
42 | | - * code, but different name spaces. |
| 39 | + * Gets the unique currency code, the effective code depends on the |
| 40 | + * currency. |
43 | 41 | * <p> |
44 | | - * Each currency is uniquely identified within its name space by this code. |
45 | | - * As a consequence the currency code is required to be uniqie in |
46 | | - * combination with the namespace and not {@code null} or empty. |
47 | | - * <p> |
48 | | - * This method matches basically the API of <type>java.util.Currency</type>. |
| 42 | + * Since each currency is identified by this code, the currency code is |
| 43 | + * required to be defined for every {@link CurrencyUnit} and not |
| 44 | + * {@code null} or empty. |
49 | 45 | * |
50 | | - * @see #getNamespace() |
51 | 46 | * @return the currency code, never {@code null}. For the ISO-4217 |
52 | 47 | * namespace, this this will be the three letter ISO-4217 code. |
53 | | - * However, alternate namespaces can have different codes. Also |
| 48 | + * However, alternate currencies can have different codes. Also |
54 | 49 | * there is no constraint about the formatting of alternate codes, |
55 | | - * despite they have to be unique within its corresponding |
56 | | - * namespace. |
| 50 | + * despite they fact that the currency codes must be unique. |
57 | 51 | */ |
58 | 52 | public String getCurrencyCode(); |
59 | 53 |
|
|
0 commit comments