net.sf.mpxj.primavera.Currency Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

The newest version!

/*
 * file:       Currency.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2023
 * date:       07/03/2023
 */

/*
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

package net.sf.mpxj.primavera;

/**
 * Represents a currency value when writing an XER file.
 */
final class Currency
{
   /**
    * Constructor.
    *
    * @param number value to be wrapped
    */
   public Currency(Number number)
   {
      m_number = number;
   }

   /**
    * Retrieve the wrapped value.
    *
    * @return wrapped value
    */
   public Number toNumber()
   {
      return m_number;
   }

   private final Number m_number;

   /**
    * Return a new Currency instance, or null if the caller passes null.
    *
    * @param number value to be wrapped
    * @return Currency instance or null
    */
   public static final Currency getInstance(Number number)
   {
      return number == null ? null : new Currency(number);
   }

   public static final Currency ZERO = new Currency(Double.valueOf(0));
}