Renamed methods similar to Java 8 version.

Author: atsticks

UserGuide.adoc

@@ -1,9 +1,9 @@
 Java Money and Currency API -- Backport for Java 7
 ==================================================
-:title: Java Money and Currency API -- Backport for Java 7
-:revnumber: 1.0-RC1
-:revdate: March 2015
-:longversion: 1.0-RC1 March 2015
+:title: Java Money and Currency API for Java 7
+:revnumber: 1.0
+:revdate: April 2015
+:longversion: 1.0 April 2015
 :authorinitials: ATR
 :author: Anatole Tresch, Credit Suisse
 :email: <[email protected]>
@@ -25,10 +25,10 @@ image::https://raw.githubusercontent.com/JavaMoney/jsr354-api/master/src/main/as
 
 ==== Version Information:
 ------------------------------------------------------------------
-Specification: Java Money and Currency API -- Backport for Java 7
-Version:       1.0-RC1
-Status:        Prerelease
-Release Date:  March 2015
+Specification: Java Money and Currency API for Java 7
+Version:       1.0
+Status:        Release
+Release Date:  April 2015
 Copyright:     2012-2015
                Credit Suisse AG
                P.O.Box
@@ -46,25 +46,18 @@ toc::[]
 <<<
 
 == Introduction
-This document is the user guide of the Java API for Money and Currency Backport of JSR 354. The technical objective is
+This document is the user guide of the Java API for Money and Currency of JSR 354 targeting Java 7. The technical objective is
 to provide a money and currency API for Java, targeted at all users of currencies and monetary amounts, compatible
 with Android and Java 7.
 The API will provide support for standard [ISO-4217] and custom currencies, and a model for monetary amounts and
 rounding. It will have extension points for adding additional features like currency exchange, financial calculations
 and formulas. For detailed information on the API and its usage, we recommend reading the JSR's specification, which can
 be downloaded from the JCP page http://jcp.org/en/jsr/detail?id=35[JSR 354 on jcp.org .
 
-Basically the specification of JSR 354 can be used as documentation base, if you want to have some introduction how
-to use this library. Hereby you must map the following packages:
-
-* org.javamoney.bp.api -> org.javamoney.bp
-* org.javamoney.bp.api.spi -> org.javamoney.bp.spi
-* org.javamoney.bp.api.convert -> org.javamoney.bp.convert
-* org.javamoney.bp.api.format -> org.javamoney.bp.format
-
-Additionally this library provides a package +org.javamoney.bp.spi.base+, which contains abstract classes that
-contain the logic included as _default_ methods in the JSR 354 API. So basically, when you have code based on
-JSR 354 Java 8 API as follows:
+The APIs for both Java 7 and Java 8 are basically the same. Java 8 additionally provides full support for _default
+methods_, which adds lots of comfort implementing the SPIs. For Java 7 users the reference implementation provides
+a set of common base classes, that provide the same functionality as provided by default methods in the Java 8 version
+of the API:
 
 [source,java]
 ----------------------------------------------------------------------
@@ -88,31 +81,32 @@ public class MyImplClass extends BaseCurrencyProviderSpi{
 [[ProjectStructure]]
 == Package and Project Structure
 ==== Package Overview
-Similar to JSR 354 the backport defines the following 4 main packages:
+Similar to JSR 354 Java 8 API this the Java 7 API defines 4 main packages:
 
-+org.javamoney.bp.api+:: contains the main artifacts, such as +CurrencyUnit, MonetaryAmount, MonetaryContext, MonetaryOperator,
-MonetaryQuery, MonetaryRounding+, and the singleton accessors +MonetaryCurrencies, MonetaryAmounts, MonetaryRoundings+.
++javax.money+:: contains the main artifacts, such as +CurrencyUnit, MonetaryAmount, MonetaryContext, MonetaryOperator,
+MonetaryQuery, MonetaryRounding+, and the singleton accessor +Monetary+.
 
-+org.javamoney.bp.api.conversion+:: contains the conversion artifacts +ExchangeRate, ExchangeRateProvider, CurrencyConversion+
++javax.money.conversion+:: contains the conversion artifacts +ExchangeRate, ExchangeRateProvider, CurrencyConversion+
 and the according +MonetaryConversions+ accessor singleton.
 
-+org.javamoney.bp.api.format+:: contains the formatting artifacts +MonetaryAmountFormat, AmountFormatContext+ and the according
++javax.money.format+:: contains the formatting artifacts +MonetaryAmountFormat, AmountFormatContext+ and the according
 +MonetaryFormats+ accessor singleton. 
 
-+org.javamoney.bp.api.spi+:: contains the SPI interfaces provided by the JSR 354 API and the bootstrap logic, to support
++javax.money.spi+:: contains the SPI interfaces provided by the JSR 354 API and the bootstrap logic, to support
 different runtime environments and component loading mechanisms.
 
 
 [[Modules]]
 ==== Module/Repository Overview
 The JSR’s source code repository under <<source>> provides several modules:
 
-javamoney-api-bp:: contains the API backport for use with Java 7. 
-javamoney-moneta-bp:: contains the ''moneta'' implementation, based on Java 7.
+jsr354-api-bp:: contains the API backport compatible with Java g and 7.
+jsr354-ri-bp:: contains the ''moneta'' implementation, based on Java 7.
 jsr354-api:: contains the JSR 354 API for use with Java 8. We highly recommend using this version, if possible, to
 benefit from the power of Java 8.
 jsr354-ri:: contains the ''moneta'' reference implementation, based on Java 8.
-jsr354-tck:: contains the technical compatibility kit (TCK) of the JSR, requiring as well Java 8.
+jsr354-tck:: contains the technical compatibility kit (TCK) of the JSR, requiring as well Java 7. The TCK is the same
+for Java 7 and Java 8.
 javamoney-parent:: is a root “POM” project for all modules under +org.javamoney+. This includes the RI/TCK projects,
   but not jsr354-api and javamoney-api-bp (which are standalone).
 javamoney-library:: contains a financial library (JavaMoney) adding comprehensive support for several extended
@@ -121,14 +115,14 @@ javamoney-examples:: finally contains the examples and demos, and also is not pa
 
 
 == Examples
-The following sections illustrate the backport's API usage in more detail.
+The following sections illustrate the API usage in more detail.
 
-=== Working with org.javamoney.moneta.bp.Money
-The Javamoney backport implementation of JSR 354 has to provide value type classes for monetary amounts, hereby implementing
-+org.javamoney.moneta.bp.api.MonetaryAmount+, and registering at least one implementation class with the +org.javamoney.moneta.bp.api.MonetaryAmounts+ singleton by
-implementing and registering a corresponding +org.javamoney.moneta.bp.api.MonetayAmountFactory+ instance.
+=== Working with javax.money.Money
+The Java 7 based implementation of JSR 354 has to provide value type classes for monetary amounts, hereby implementing
++javax.money.MonetaryAmount+, and registering at least one implementation class with the +javax.money.Monetary+
+singleton by implementing and registering a corresponding +javax.money.MonetayAmountFactory+ instance.
 
-As an example the reference implementation provides a class +org.javamoney.moneta.bp.Money+, which is using
+As an example the reference implementation provides a class +org.javamoney.moneta.Money+, which is using
 +java.math.BigDecimal+ internally:
 
 [source,java]
@@ -246,7 +240,7 @@ Below is a rather academical example of a +MonetaryOperator+ that simply convert
 the same numeric value, but with XXX (undefined) as currency:
 
 [source,java]
-.Simple example of a +MonetaryOperstor+ using the +MonetaryAmountFactory+ provided.
+.Simple example of a +MonetaryOperator+ using the +MonetaryAmountFactory+ provided.
 -------------------------------------------------------------------------------
 public final class ToInvalid implements MonetaryOperator{
   public <T extends MonetaryAmount> T apply(T amount){
@@ -495,23 +489,3 @@ Public Source Code Repository on GitHub: http://github.com/JavaMoney,
 * http://java.net/projects/javamoney/[JavaMoney Project on Java.net]
   ** https://github.com/JavaMoney[JSR 354 API GitHub Repository]
   ** https://github.com/JavaMoney/jsr354-ro[Moneta RI GitHub Repository]
-* http://www.javapractices.com/topic/TopicAction.do?Id=13[Java Practices about Representing Money]
-* http://blog.eisele.net/2011/08/working-with-money-in-java.html[Working with Money in Java]
-* http://mindprod.com/jgloss/currency.html[Java currency] by Roedy Green, http://mindprod.com[Canadian Mind Products]
-* http://www.eclipse.org/uomo/[UOMo Business], based on ICU4J and concepts by JScience Economics]
-* http://site.icu-project.org/[ICU4J] Uses Number for all operations and internal storage in its Money type.
-* http://moneydance.com/dev/apidoc/[MoneyDance API]
-* http://javamoney.org[JavaMoney] is the Apache 2.0 licensed OSS project that evolved from JSR 354 development. It provides concrete implementations for currency conversion and mapping, advanced formatting, historic data access, regions and a set of financial calculations and formulas.
-* http://www.joda.org/joda-money[Joda Money] can be referred to as an inspiration for API and design style. it is based on real-world use cases in an e-commerce application for airlines
-* http://grails.org/plugin/currencies[Grails Currencies] uses BigDecimal as internal representation, but API only exposes Number in all Money operations like plus(), minus() or similar.
-* http://lemnik.wordpress.com/2011/03/25/bigdecimal-and-your-money/[Why not to use BigDecimal for Money]
-* http://de.wikipedia.org/wiki/M-Pesa[M-Pesa-Mobile Money] in Africa
-* Currency Internationalization (i18n), Multiple Currencies and Foreign Exchange (FX).
-* http://en.wikipedia.org/wiki/Japanese_units_of_measurement#Money: Discussion of internationalization of currencies, rounding, grouping and formatting, separators etc]
-* http://speleotrove.com/decimal/
-* http://sourceforge.net/projects/oquote/
-* http://en.wikipedia.org/wiki/Karatsuba_algorithm[Karatsuba Algorithm] for Fast Big Decimal Multiplication
-
-=== Related Initiatives
-* http://timeandmoney.sourceforge.net/ [Eric Evans Time and Money Library]
-* http://bitcoinj.github.io/ [Bitcoin Java Client]

pom.xml

@@ -103,7 +103,7 @@
             </roles>
         </developer>
         <developer>
-            <id>-</id>
+            <id>simasch</id>
             <name>Simon Martinelli</name>
             <roles>
                 <role>Expert Group Member</role>
@@ -132,6 +132,55 @@
                 <role>Expert Group Member</role>
             </roles>
         </developer>
+        <developer>
+            <id>-</id>
+            <name>Scot James</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
+        <developer>
+            <id>-</id>
+            <name>Matthias Buecker</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
+        <developer>
+            <id>-</id>
+            <name>Sanjay Nagpal</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
+        <developer>
+            <id>keilw</id>
+            <name>Werner Keil</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
+        <developer>
+            <id>crazybob</id>
+            <name>Bob Lee</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
+        <developer>
+            <id>crazybob</id>
+            <name>Bob Lee</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
+        <developer>
+            <id>-</id>
+            <name>Arumugam Swaminathan</name>
+            <roles>
+                <role>Expert Group Member</role>
+            </roles>
+        </developer>
     </developers>
 
     <ciManagement>

src/main/java/javax/money/convert/MonetaryConversions.java

@@ -70,7 +70,7 @@ private MonetaryConversions(){
 
     /**
      * Access an instance of {@link CurrencyConversion} for the given providers.
-     * Use {@link #getProviderNames()} to check, which are available.
+     * Use {@link #getConversionProviderNames()} to check, which are available.
      *
      * @param termCurrency the terminating or target currency, not {@code null}
      * @param providers    Additional providers, for building a provider chain
@@ -82,7 +82,7 @@ public static CurrencyConversion getConversion(CurrencyUnit termCurrency, String
         Objects.requireNonNull(termCurrency);
         if(providers.length == 0){
             return MONETARY_CONVERSION_SPI.getConversion(
-                    ConversionQueryBuilder.of().setTermCurrency(termCurrency).setProviderNames(getDefaultProviderChain())
+                    ConversionQueryBuilder.of().setTermCurrency(termCurrency).setProviderNames(getDefaultConversionProviderChain())
                             .build());
         }
         return MONETARY_CONVERSION_SPI.getConversion(
@@ -91,7 +91,7 @@ public static CurrencyConversion getConversion(CurrencyUnit termCurrency, String
 
     /**
      * Access an instance of {@link CurrencyConversion} for the given providers.
-     * Use {@link #getProviderNames()}} to check, which are available.
+     * Use {@link #getConversionProviderNames()}} to check, which are available.
      *
      * @param termCurrencyCode the terminating or target currency code, not {@code null}
      * @param providers        Additional providers, for building a provider chain
@@ -106,7 +106,7 @@ public static CurrencyConversion getConversion(String termCurrencyCode, String..
 
     /**
      * Access an instance of {@link CurrencyConversion} for the given providers.
-     * Use {@link #getProviderNames()}} to check, which are available.
+     * Use {@link #getConversionProviderNames()}} to check, which are available.
      *
      * @param conversionQuery The {@link ConversionQuery} required, not {@code null}
      * @return the {@link CurrencyConversion}  instance matching.
@@ -167,15 +167,15 @@ public static boolean isConversionAvailable(CurrencyUnit termCurrency, String...
 
     /**
      * Access an instance of {@link CurrencyConversion} using the given
-     * providers as a provider chain. Use {@link #getProviderNames()}s
+     * providers as a provider chain. Use {@link #getConversionProviderNames()}s
      * to check, which are available.
      *
      * @return the exchange rate provider.
      * @throws IllegalArgumentException if no such {@link ExchangeRateProvider} is available.
      */
     public static ExchangeRateProvider getExchangeRateProvider(String... providers){
         if(providers.length == 0){
-            List<String> defaultProviderChain = getDefaultProviderChain();
+            List<String> defaultProviderChain = getDefaultConversionProviderChain();
             return MONETARY_CONVERSION_SPI.getExchangeRateProvider(ConversionQueryBuilder.of().setProviderNames(
                     defaultProviderChain.toArray(new String[defaultProviderChain.size()])).build());
         }
@@ -216,7 +216,7 @@ public static ExchangeRateProvider getExchangeRateProvider(
 	}
     /**
      * Access an instance of {@link CurrencyConversion} using the given
-     * providers as a provider chain. Use {@link #getProviderNames()}
+     * providers as a provider chain. Use {@link #getConversionProviderNames()}
      * to check, which are available.
      *
      * @return the exchange rate provider.
@@ -252,7 +252,7 @@ public static boolean isExchangeRateProviderAvailable(ConversionQuery conversion
      *
      * @return all supported provider ids, never {@code null}.
      */
-    public static Collection<String> getProviderNames(){
+    public static Collection<String> getConversionProviderNames(){
         if(MONETARY_CONVERSION_SPI==null){
             throw new MonetaryException(
                     "No MonetaryConveresionsSingletonSpi " + "loaded, query functionality is not available.");
@@ -265,7 +265,7 @@ public static Collection<String> getProviderNames(){
      *
      * @return the default provider, never {@code null}.
      */
-    public static List<String> getDefaultProviderChain(){
+    public static List<String> getDefaultConversionProviderChain(){
         if(MONETARY_CONVERSION_SPI==null){
             throw new MonetaryException(
                     "No MonetaryConveresionsSingletonSpi " + "loaded, query functionality is not available.");

src/main/java/javax/money/format/MonetaryFormats.java

@@ -167,7 +167,7 @@ public static Set<Locale> getAvailableLocales(String... providers) {
      *
      * @return the provider names, never null.
      */
-    public static Collection<String> getProviderNames() {
+    public static Collection<String> getFormatProviderNames() {
         if(monetaryFormatsSingletonSpi==null){
             throw new MonetaryException(
                     "No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");
@@ -180,7 +180,7 @@ public static Collection<String> getProviderNames() {
      *
      * @return the default provider chain, never null.
      */
-    public static List<String> getDefaultProviderChain() {
+    public static List<String> getDefaultFormatProviderChain() {
         if(monetaryFormatsSingletonSpi==null){
             throw new MonetaryException(
                     "No MonetaryFormatsSingletonSpi " + "loaded, query functionality is not available.");

src/test/java/javax/money/convert/MonetaryConversionsTest.java

@@ -106,15 +106,15 @@ public void testGetExchangeRateProvider_Invalid() throws Exception {
 
     @Test
     public void testGetProviderNames() throws Exception {
-        assertNotNull(MonetaryConversions.getProviderNames());
-        assertTrue(MonetaryConversions.getProviderNames().contains("test"));
-        assertTrue(MonetaryConversions.getProviderNames().size() == 1);
+        assertNotNull(MonetaryConversions.getConversionProviderNames());
+        assertTrue(MonetaryConversions.getConversionProviderNames().contains("test"));
+        assertTrue(MonetaryConversions.getConversionProviderNames().size() == 1);
     }
 
     @Test
     public void testGetDefaultProviderChain() throws Exception {
-        assertNotNull(MonetaryConversions.getDefaultProviderChain());
-        assertFalse(MonetaryConversions.getDefaultProviderChain().isEmpty());
-        assertEquals(1, MonetaryConversions.getDefaultProviderChain().size());
+        assertNotNull(MonetaryConversions.getDefaultConversionProviderChain());
+        assertFalse(MonetaryConversions.getDefaultConversionProviderChain().isEmpty());
+        assertEquals(1, MonetaryConversions.getDefaultConversionProviderChain().size());
     }
 }

src/test/java/javax/money/format/MonetaryFormatsTest.java

@@ -96,15 +96,15 @@ public void testGeAmountFormat_Name_Providers() {
 
     @Test
     public void testGetProviderNames() {
-        Collection<String> provs = MonetaryFormats.getProviderNames();
+        Collection<String> provs = MonetaryFormats.getFormatProviderNames();
         assertNotNull(provs);
         System.out.println(provs);
         assertTrue(provs.contains("TestAmountFormatProvider"));
     }
 
     @Test
     public void testGetDefaultProviderChain() {
-        List<String> provs = MonetaryFormats.getDefaultProviderChain();
+        List<String> provs = MonetaryFormats.getDefaultFormatProviderChain();
         assertNotNull(provs);
         assertTrue(provs.contains("TestAmountFormatProvider"));
     }