com.highdeal.currency
Class PropertyCurrencyBook

java.lang.Object
  extended by com.highdeal.currency.PropertyCurrencyBook
All Implemented Interfaces:
CurrencyBook

public class PropertyCurrencyBook
extends java.lang.Object
implements CurrencyBook

A PropertyCurrencyBook keeps the currencies that can be used in your client application; The currencies are stored in a property resources.


Constructor Summary
PropertyCurrencyBook()
          Initializes a new property currency book from the default resource file (RESOURCE_FILE).
PropertyCurrencyBook(java.io.InputStream stream)
          Initializes a new property currency book from a stream.
PropertyCurrencyBook(java.util.Locale locale)
          Initializes a new property currency book from the default resource file (RESOURCE_FILE).
PropertyCurrencyBook(java.util.ResourceBundle bundle)
          Initializes a new property currency book from a specified resource bundle
PropertyCurrencyBook(java.lang.String fileName)
          Initializes a new property currency book from a specified resource file.
PropertyCurrencyBook(java.lang.String fileName, java.util.Locale locale)
          Initializes a new property currency book from a specified resource file.
 
Method Summary
 void addCurrency(Currency currency)
          Adds a currency in the currency book.
static PropertyCurrencyBook createDefaultInstance()
           
 java.util.Vector<Currency> getCurrencies()
          Returns all the current currencies that can be used in your client application.
 Currency getCurrency(int code)
          
Returns a currency from a given ISO 4217 code.
 Currency getCurrency(java.lang.String code)
          Returns a currency from a specified code.
 Currency getCurrency(java.lang.String iso4217code, int precision)
          Returns a currency from a given ISO 4217 code and with a precision greater or equal to the given precision; If there is no currency a given ISO 4217 code for with a precision greater or equal to the given precision, return null.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyCurrencyBook

public PropertyCurrencyBook()
                     throws java.io.IOException,
                            java.util.MissingResourceException
Initializes a new property currency book from the default resource file (RESOURCE_FILE).

Throws:
java.io.IOException - if an error occurred reading the default resource file
java.util.MissingResourceException - if the resource file does not contain the specified currency resources

PropertyCurrencyBook

public PropertyCurrencyBook(java.util.Locale locale)
                     throws java.io.IOException,
                            java.util.MissingResourceException
Initializes a new property currency book from the default resource file (RESOURCE_FILE).

Parameters:
locale - The locale object
Throws:
java.io.IOException - if an error occurred reading the default resource file
java.util.MissingResourceException - if the resource file does not contain the specified currency resources

PropertyCurrencyBook

public PropertyCurrencyBook(java.lang.String fileName)
                     throws java.io.IOException,
                            java.util.MissingResourceException
Initializes a new property currency book from a specified resource file.

Parameters:
fileName - The name and path of the resource file
Throws:
java.io.IOException - if an error occurred reading the specified resource file
java.util.MissingResourceException - if the resource file does not contain the specified currency resources

PropertyCurrencyBook

public PropertyCurrencyBook(java.lang.String fileName,
                            java.util.Locale locale)
                     throws java.io.IOException,
                            java.util.MissingResourceException
Initializes a new property currency book from a specified resource file.

Parameters:
fileName - The name and path of the resource file
locale - The locale object
Throws:
java.io.IOException - if an error occurred reading the specified resource file
java.util.MissingResourceException - if the resource file does not contain the specified currency resources

PropertyCurrencyBook

public PropertyCurrencyBook(java.io.InputStream stream)
                     throws java.io.IOException,
                            java.util.MissingResourceException
Initializes a new property currency book from a stream.

Parameters:
stream - The stream that contains the currency resources
Throws:
java.io.IOException - if an error occurred reading the stream
java.util.MissingResourceException - if the stream does not contain the specified currency resources

PropertyCurrencyBook

public PropertyCurrencyBook(java.util.ResourceBundle bundle)
                     throws java.util.MissingResourceException
Initializes a new property currency book from a specified resource bundle

Parameters:
bundle - The resource bundle containing the currency resources
Throws:
java.util.MissingResourceException - if the resource bundle does not contain the specified currency resources
Method Detail

getCurrencies

public java.util.Vector<Currency> getCurrencies()
Description copied from interface: CurrencyBook
Returns all the current currencies that can be used in your client application.

Specified by:
getCurrencies in interface CurrencyBook
Returns:
The current list of currencies that can be used in your client application

getCurrency

public Currency getCurrency(int code)
Description copied from interface: CurrencyBook
Returns a currency from a given ISO 4217 code.

Specified by:
getCurrency in interface CurrencyBook
Parameters:
code - The ISO 4217 three-digit currency code
Returns:
The currency for this code

getCurrency

public Currency getCurrency(java.lang.String iso4217code,
                            int precision)
Description copied from interface: CurrencyBook
Returns a currency from a given ISO 4217 code and with a precision greater or equal to the given precision; If there is no currency a given ISO 4217 code for with a precision greater or equal to the given precision, return null.

Specified by:
getCurrency in interface CurrencyBook
Parameters:
iso4217code - The ISO 4217 code of the currency
precision - The minimum precision of the currency
Returns:
The currency for this ISO 4217 code and precision or null

getCurrency

public Currency getCurrency(java.lang.String code)
Description copied from interface: CurrencyBook
Returns a currency from a specified code.

Specified by:
getCurrency in interface CurrencyBook
Parameters:
code - The code of the currency
Returns:
The currency for this code

addCurrency

public void addCurrency(Currency currency)
Description copied from interface: CurrencyBook
Adds a currency in the currency book.

Specified by:
addCurrency in interface CurrencyBook
Parameters:
currency - The currency to be added

createDefaultInstance

public static PropertyCurrencyBook createDefaultInstance()

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)