Java Doc for Currency.java in  » J2EE » Jaffa » org » jaffa » datatypes » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » Jaffa » org.jaffa.datatypes 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jaffa.datatypes.Currency

Currency
public class Currency implements Cloneable,Comparable,Serializable(Code)
This class is used to hold currency data. Instances of this class are immutable.


Field Summary
public static  StringUSD
     The constant to denote US Dollar.

Constructor Summary
public  Currency()
     Default constructor.
public  Currency(double value)
     Constructs a Currency object with the specified value.
public  Currency(String s)
     Constructs a Currency object with the specified value.
public  Currency(Double value)
     Constructs a Currency object with the specified value.
public  Currency(double value, String currencyType)
     Constructs a Currency object with the specified value and currency type A RuntimeException will be thrown if the input currency type is not supported.
public  Currency(String s, String currencyType)
     Constructs a Currency object with the specified value and currency type A RuntimeException will be thrown if the input currency type is not supported.
public  Currency(Double value, String currencyType)
     Constructs a Currency object with the specified value and currency type A RuntimeException will be thrown if the input currency type is not supported.

Method Summary
public  Currencyadd(Currency c)
     Returns 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.
public  Objectclone()
     Returns a clone of the object.
public  intcompareTo(Object obj)
     Compares this object with another Currency object. Note: this class has a natural ordering that is inconsistent with equals The target object is converted to the same currencyType before the comparison is performed. Hence, it is quite possible that this method might indicate a equality, while the 'equals' method may return a false.
Parameters:
  obj - the other Currency object.
public  Currencyconvert(String currencyType)
     Returns a new Currency object, which will have the value of the current object converted to the input currency type. A RuntimeException will be thrown if the input currency type is not supported.
Parameters:
  currencyType - the type to convert to.
public  booleanequals(Object obj)
     Compares this object with another Currency object. Returns a true if both the objects have the same currency type and value.
Parameters:
  obj - the other Currency object.
public  StringgetCurrencyType()
     Getter for property currencyType.
public  DoublegetValue()
     Getter for property value.
public  inthashCode()
     Returns an int which will be the sum of the of the hashcodes of the value and the currency type.
public  StringtoString()
     Returns the diagnostic information.

Field Detail
USD
public static String USD(Code)
The constant to denote US Dollar.




Constructor Detail
Currency
public Currency()(Code)
Default constructor. This creates a Currency object with 0 value. This will default to USD as the currency type.



Currency
public Currency(double value)(Code)
Constructs a Currency object with the specified value. This will default to USD as the currency type.
Parameters:
  value - the value of the object.



Currency
public Currency(String s)(Code)
Constructs a Currency object with the specified value. This will default to USD as the currency type.
Parameters:
  s - the value of the object.



Currency
public Currency(Double value)(Code)
Constructs a Currency object with the specified value. This will default to USD as the currency type.
Parameters:
  value - the value of the object.



Currency
public Currency(double value, String currencyType)(Code)
Constructs a Currency object with the specified value and currency type A RuntimeException will be thrown if the input currency type is not supported.
Parameters:
  value - the value of the object.
Parameters:
  currencyType - the currency type.



Currency
public Currency(String s, String currencyType)(Code)
Constructs a Currency object with the specified value and currency type A RuntimeException will be thrown if the input currency type is not supported.
Parameters:
  s - the value of the object.
Parameters:
  currencyType - the currency type.



Currency
public Currency(Double value, String currencyType)(Code)
Constructs a Currency object with the specified value and currency type A RuntimeException will be thrown if the input currency type is not supported.
Parameters:
  value - the value of the object.
Parameters:
  currencyType - the currency type.




Method Detail
add
public Currency add(Currency c)(Code)
Returns 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. The input Currency is first converted to the same currency type, before adding the values.
Parameters:
  c - the other Currency object. 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



clone
public Object clone()(Code)
Returns a clone of the object. a clone of the object.



compareTo
public int compareTo(Object obj)(Code)
Compares this object with another Currency object. Note: this class has a natural ordering that is inconsistent with equals The target object is converted to the same currencyType before the comparison is performed. Hence, it is quite possible that this method might indicate a equality, while the 'equals' method may return a false.
Parameters:
  obj - the other Currency object. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.



convert
public Currency convert(String currencyType)(Code)
Returns a new Currency object, which will have the value of the current object converted to the input currency type. A RuntimeException will be thrown if the input currency type is not supported.
Parameters:
  currencyType - the type to convert to. a new Currency object, which will have the value of the current object converted to the input currency type.



equals
public boolean equals(Object obj)(Code)
Compares this object with another Currency object. Returns a true if both the objects have the same currency type and value.
Parameters:
  obj - the other Currency object. a true if both the objects have the same currency type and value.



getCurrencyType
public String getCurrencyType()(Code)
Getter for property currencyType. Value of property currencyType.



getValue
public Double getValue()(Code)
Getter for property value. Value of property value.



hashCode
public int hashCode()(Code)
Returns an int which will be the sum of the of the hashcodes of the value and the currency type. an int which will be the sum of the of the hashcodes of the value and the currency type.



toString
public String toString()(Code)
Returns the diagnostic information. the diagnostic information.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.