001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.datatypes;
051:
052: import java.io.Serializable;
053: import java.util.*;
054:
055: /**
056: * This class is used to hold currency data. Instances of this class are immutable.
057: */
058: public class Currency implements Cloneable, Comparable, Serializable {
059:
060: // check http://www.bsi-global.com/iso4217currency for the ISO 4217 currency codes
061:
062: /** The constant to denote US Dollar.*/
063: public static String USD = "USD";
064:
065: // *** PRIVATE FIELDS ***
066: private Double m_value = null;
067: private String m_currencyType = null;
068:
069: /** Default constructor. This creates a Currency object with 0 value.
070: * This will default to USD as the currency type.
071: */
072: public Currency() {
073: this (new Double(0));
074: }
075:
076: /** Constructs a Currency object with the specified value.
077: * This will default to USD as the currency type.
078: * @param value the value of the object.
079: */
080: public Currency(double value) {
081: this (new Double(value));
082: }
083:
084: /** Constructs a Currency object with the specified value.
085: * This will default to USD as the currency type.
086: * @param s the value of the object.
087: */
088: public Currency(String s) {
089: this (new Double(s));
090: }
091:
092: /** Constructs a Currency object with the specified value.
093: * This will default to USD as the currency type.
094: * @param value the value of the object.
095: */
096: public Currency(Double value) {
097: this (value, USD);
098: }
099:
100: /** Constructs a Currency object with the specified value and currency type
101: * A RuntimeException will be thrown if the input currency type is not supported.
102: * @param value the value of the object.
103: * @param currencyType the currency type.
104: */
105: public Currency(double value, String currencyType) {
106: this (new Double(value), currencyType);
107: }
108:
109: /** Constructs a Currency object with the specified value and currency type
110: * A RuntimeException will be thrown if the input currency type is not supported.
111: * @param s the value of the object.
112: * @param currencyType the currency type.
113: */
114: public Currency(String s, String currencyType) {
115: this (new Double(s), currencyType);
116: }
117:
118: /** Constructs a Currency object with the specified value and currency type
119: * A RuntimeException will be thrown if the input currency type is not supported.
120: * @param value the value of the object.
121: * @param currencyType the currency type.
122: */
123: public Currency(Double value, String currencyType) {
124: // ensure that the currencyType is a valid currency code
125: // the following will throw an exception, in case the currencyType is null or invalid
126: java.util.Currency.getInstance(currencyType);
127:
128: m_value = value;
129: m_currencyType = currencyType;
130: }
131:
132: // *** PUBLIC METHODS ***
133: // - Some standard Methods
134:
135: /** Returns a clone of the object.
136: * @return a clone of the object.
137: */
138: public Object clone() {
139: try {
140: return super .clone();
141: // no more processign required since the fields are immutable
142: } catch (CloneNotSupportedException e) {
143: // this shouldn't happen, since we are Cloneable
144: return null;
145: }
146: }
147:
148: /** Compares this object with another Currency object.
149: * Note: this class has a natural ordering that is inconsistent with equals
150: * The target object is converted to the same currencyType before the comparison is performed.
151: * Hence, it is quite possible that this method might indicate a equality, while the 'equals' method may return a false.
152: * @param obj the other Currency object.
153: * @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
154: */
155: public int compareTo(Object obj) {
156: // convert the obj to a Currency of the same type as the current
157: Currency target = ((Currency) obj).convert(m_currencyType);
158: return m_value.compareTo(target.m_value);
159: }
160:
161: /** Compares this object with another Currency object.
162: * Returns a true if both the objects have the same currency type and value.
163: * @param obj the other Currency object.
164: * @return a true if both the objects have the same currency type and value.
165: */
166: public boolean equals(Object obj) {
167: if (obj instanceof Currency) {
168: Currency target = (Currency) obj;
169: return m_currencyType.equals(target.m_currencyType)
170: && m_value.equals(target.m_value);
171: } else {
172: return false;
173: }
174: }
175:
176: /** Returns an int which will be the sum of the of the hashcodes of the value and the currency type.
177: * @return an int which will be the sum of the of the hashcodes of the value and the currency type.
178: */
179: public int hashCode() {
180: return m_value.hashCode() + m_currencyType.hashCode();
181: }
182:
183: /** Returns the diagnostic information.
184: * @return the diagnostic information.
185: */
186: public String toString() {
187: return Formatter.format(this );
188: }
189:
190: // - Getters
191:
192: /** Getter for property value.
193: * @return Value of property value.
194: */
195: public Double getValue() {
196: return m_value;
197: }
198:
199: /** Getter for property currencyType.
200: * @return Value of property currencyType.
201: */
202: public String getCurrencyType() {
203: return m_currencyType;
204: }
205:
206: // - Currency Manipulation methods
207:
208: /** Returns a new Currency object, which has the same currency type as this object,
209: * and a value which is the sum of the 2 Currency objects. The input Currency is first converted
210: * to the same currency type, before adding the values.
211: * @param c the other Currency object.
212: * @return a new Currency object which has the same currency type as this object, and a value which is the sum of the 2 Currency objects
213: */
214: public Currency add(Currency c) {
215: double value = m_value.doubleValue()
216: + c.convert(m_currencyType).m_value.doubleValue();
217: return new Currency(value, m_currencyType);
218: }
219:
220: /** Returns a new Currency object, which will have the value of the current object converted to the input currency type.
221: * A RuntimeException will be thrown if the input currency type is not supported.
222: * @param currencyType the type to convert to.
223: * @return a new Currency object, which will have the value of the current object converted to the input currency type.
224: */
225: public Currency convert(String currencyType) {
226: if (currencyType != null && currencyType.equals(m_currencyType))
227: return (Currency) this .clone();
228: else
229: // todo: just throw a RuntimeException for the time being
230: throw new RuntimeException("No conversion Available");
231: }
232:
233: }
|