Showing the changes to java/pkg/java/util/spi/CurrencyNameProvider.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,119 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. | |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 | + * | |
| 5 | + * This code is free software; you can redistribute it and/or modify it | |
| 6 | + * under the terms of the GNU General Public License version 2 only, as | |
| 7 | + * published by the Free Software Foundation. Oracle designates this | |
| 8 | + * particular file as subject to the "Classpath" exception as provided | |
| 9 | + * by Oracle in the LICENSE file that accompanied this code. | |
| 10 | + * | |
| 11 | + * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 | + * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 | + * accompanied this code). | |
| 16 | + * | |
| 17 | + * You should have received a copy of the GNU General Public License version | |
| 18 | + * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 | + * | |
| 21 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 | + * or visit www.oracle.com if you need additional information or have any | |
| 23 | + * questions. | |
| 24 | + */ | |
| 25 | + | |
| 26 | +package java.util.spi; | |
| 27 | + | |
| 28 | +import java.util.Arrays; | |
| 29 | +import java.util.Currency; | |
| 30 | +import java.util.List; | |
| 31 | +import java.util.Locale; | |
| 32 | + | |
| 33 | +/** | |
| 34 | + * An abstract class for service providers that | |
| 35 | + * provide localized currency symbols and display names for the | |
| 36 | + * {@link java.util.Currency Currency} class. | |
| 37 | + * Note that currency symbols are considered names when determining | |
| 38 | + * behaviors described in the | |
| 39 | + * {@link java.util.spi.LocaleServiceProvider LocaleServiceProvider} | |
| 40 | + * specification. | |
| 41 | + * | |
| 42 | + * @since 1.6 | |
| 43 | + */ | |
| 44 | +public abstract class CurrencyNameProvider extends LocaleServiceProvider { | |
| 45 | + | |
| 46 | + /** | |
| 47 | + * Sole constructor. (For invocation by subclass constructors, typically | |
| 48 | + * implicit.) | |
| 49 | + */ | |
| 50 | + protected CurrencyNameProvider() { | |
| 51 | + } | |
| 52 | + | |
| 53 | + /** | |
| 54 | + * Gets the symbol of the given currency code for the specified locale. | |
| 55 | + * For example, for "USD" (US Dollar), the symbol is "$" if the specified | |
| 56 | + * locale is the US, while for other locales it may be "US$". If no | |
| 57 | + * symbol can be determined, null should be returned. | |
| 58 | + * | |
| 59 | + * @param currencyCode the ISO 4217 currency code, which | |
| 60 | + * consists of three upper-case letters between 'A' (U+0041) and | |
| 61 | + * 'Z' (U+005A) | |
| 62 | + * @param locale the desired locale | |
| 63 | + * @return the symbol of the given currency code for the specified locale, or null if | |
| 64 | + * the symbol is not available for the locale | |
| 65 | + * @exception NullPointerException if <code>currencyCode</code> or | |
| 66 | + * <code>locale</code> is null | |
| 67 | + * @exception IllegalArgumentException if <code>currencyCode</code> is not in | |
| 68 | + * the form of three upper-case letters, or <code>locale</code> isn't | |
| 69 | + * one of the locales returned from | |
| 70 | + * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() | |
| 71 | + * getAvailableLocales()}. | |
| 72 | + * @see java.util.Currency#getSymbol(java.util.Locale) | |
| 73 | + */ | |
| 74 | + public abstract String getSymbol(String currencyCode, Locale locale); | |
| 75 | + | |
| 76 | + /** | |
| 77 | + * Returns a name for the currency that is appropriate for display to the | |
| 78 | + * user. The default implementation returns null. | |
| 79 | + * | |
| 80 | + * @param currencyCode the ISO 4217 currency code, which | |
| 81 | + * consists of three upper-case letters between 'A' (U+0041) and | |
| 82 | + * 'Z' (U+005A) | |
| 83 | + * @param locale the desired locale | |
| 84 | + * @return the name for the currency that is appropriate for display to the | |
| 85 | + * user, or null if the name is not available for the locale | |
| 86 | + * @exception IllegalArgumentException if <code>currencyCode</code> is not in | |
| 87 | + * the form of three upper-case letters, or <code>locale</code> isn't | |
| 88 | + * one of the locales returned from | |
| 89 | + * {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() | |
| 90 | + * getAvailableLocales()}. | |
| 91 | + * @exception NullPointerException if <code>currencyCode</code> or | |
| 92 | + * <code>locale</code> is <code>null</code> | |
| 93 | + * @since 1.7 | |
| 94 | + */ | |
| 95 | + public String getDisplayName(String currencyCode, Locale locale) { | |
| 96 | + if (currencyCode == null || locale == null) { | |
| 97 | + throw new NullPointerException(); | |
| 98 | + } | |
| 99 | + | |
| 100 | + // Check whether the currencyCode is valid | |
| 101 | + char[] charray = currencyCode.toCharArray(); | |
| 102 | + if (charray.length != 3) { | |
| 103 | + throw new IllegalArgumentException("The currencyCode is not in the form of three upper-case letters."); | |
| 104 | + } | |
| 105 | + for (char c : charray) { | |
| 106 | + if (c < 'A' || c > 'Z') { | |
| 107 | + throw new IllegalArgumentException("The currencyCode is not in the form of three upper-case letters."); | |
| 108 | + } | |
| 109 | + } | |
| 110 | + | |
| 111 | + // Check whether the locale is valid | |
| 112 | + List<Locale> avail = Arrays.asList(getAvailableLocales()); | |
| 113 | + if (!avail.contains(locale)) { | |
| 114 | + throw new IllegalArgumentException("The locale is not available"); | |
| 115 | + } | |
| 116 | + | |
| 117 | + return null; | |
| 118 | + } | |
| 119 | +} | |