title=Library
date=2016-07-10
type=page
status=published
~~~~~~

        <header>
          <h1>JavaMoney Library</h1>
          <h2>JavaMoney financial library, evolved from JSR 354 development.</h2>
        </header>

        <section id="downloads" class="clearfix">
          <a href="https://github.com/JavaMoney/javamoney-lib/zipball/master" id="download-zip" class="button"><span>Download .zip</span></a>
          <a href="https://github.com/JavaMoney/javamoney-lib/tarball/master" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a>
          <a href="https://github.com/JavaMoney/javamoney-lib" id="view-on-github" class="button"><span>View on GitHub</span></a>
        </section>

        <hr>

        <section id="main_content">
          <h3>
<a name="welcome-to-the-javamoney-financial-library" class="anchor" href="#welcome-to-the-javamoney-financial-library"><span class="octicon octicon-link"></span></a>Welcome to the JavaMoney financial library.</h3>

<p><a href="https://github.com/JavaMoney/javamoney-lib" target="_blank">JavaMoney-lib</a> is a financial library that is built upon JSR 354 (or compatible libraries). Whereas the JSR 354 API and reference implementation provides the fundamentals like monetary amounts, customizable currencies and interfaces for interoperation this library adds additional powerful APIs and SPIs that were implemented during JSR development as a proof of concept:</p>

<ul>
<!--
<li>
<strong>Currency Conversion</strong>, supporting multiple conversion data providers, direct and derived (chained) rates, current, as well as historic conversion. Also feed implementations from the European Central Bank (EZB) and the International Monetary Funds (IMF) were available, that support currency conversion back to 1995 for almost every ISO currency.</li>
<li>
<strong>Currency Services</strong>, provide a EE styled service, which allows querying currencies available and supports mapping between different currency naming schemes.</li>
<li>
<strong>Formatting</strong> provides an extensible formatting library that allows to define complex formatters, that can be configured in arbitrary ways using <code>LocalizationStyle</code> instances. Also available is a flexible Builder for creating arbitrary complex formatters and parsers based on an ordered set of arbitrary tokens.</li>
<li>
<strong>Region API</strong> provides a forest (a set of trees) of regions. This allows to model regional hierarchies in a more flexible and intuitive way, than adding all functionalities into <code>java.util.Locale</code>. By default the Unicode CLDR region tree, well as ISO countries defined by the 2- or 3-letter country code are available. Of course, the API is fully extendible, so customer related regions such as legal units, customer segments etc can be mapped easily to this API, also.</li>
<li>
<strong>Validity API</strong> This API provides a generic API for accessing historic validity information for arbitrary items, and for relationships between items. By default the API provides access to the historic relationship of currencies to countries using the Unicode CLDR data.</li>
<li>
<strong>common</strong> provides general functionality, such as an automatic data loader, which allows to update and locally cache arbitrary remote resources, and inform clients, if a new version of a resource was detected.</li>
-->
<li>
<strong>calc</strong> finally provides a set of monetary calculations and formulas. The idea here is to provide a comprehensive set of algorithms and tools to perform complex financial mathematics. </li>
<li>
<strong>bundles</strong> finally provides the library in different flavors, targeting different execution environments:
    <ul>
        <li><strong>se</strong> loading SPIs only using the JDK <code>ServiceLoader</code>.</li>
        <li><strong>se-cdi</strong> loading SPIs based on a Weld SE container.</li>
        <li><strong>ee</strong> loading SPIs based on CDI in a Java EE environment &gt;= EE6.</li>
    </ul>
</li>
</ul>

<!--
<p>To use the library you simply have to add the Maven dependency to your project.</p>

<pre><code>&lt;dependency&gt;
  &lt;groupId&gt;org.javamoney&lt;/groupId&gt;
  &lt;artifactId&gt;javamoney-${module}&lt;artifactId&gt;
  &lt;versionId&gt;the current version&lt;/version&gt;
&lt;/dependency&gt;
</code></pre>

<p>
The release artifacts should be accessible from the following repositories:
<ul>
<li>Maven Central</li>
</ul>
</p>
-->

<h3>
<a name="authors-and-contributors" class="anchor" href="#authors-and-contributors"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>

<p>Different people have contributed to this project. During the development of JSR 354, <a href="https://github.com/atsticks" class="user-mention">@atsticks</a> and <a href="https://github.com/keilw" class="user-mention">@keilw</a> founded this project and were also the main contributors. Nevertheless everybody is really welcome to help us, to make this library more feasible and add features.</p>

<h3>
<a name="javamoney-shelter" class="anchor" href="#javamoney-shelter"><span class="octicon octicon-link"></span></a>javamoney-shelter</h3>

<p>The <a href="shelter.html">JavaMoney Shelter</a> module is for testing out new features or modules before they may enter the official JavaMoney library.
</p>

</section>