MoneyPerDurationUnit.java
package org.djunits.unit;
import org.djunits.unit.unitsystem.UnitSystem;
/**
* MoneyPerDurationUnit defines a unit for the cost or benefit per time, e.g. wage per hour.
* <p>
* Copyright (c) 2015-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
* BSD-style license. See <a href="http://djunits.org/docs/license.html">DJUNITS License</a>.
* <p>
* $LastChangedDate: 2018-08-10 02:43:31 +0200 (Fri, 10 Aug 2018) $, @version $Revision: 286 $, by $Author: averbraeck $,
* initial version Sep 5, 2015 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
*/
public class MoneyPerDurationUnit extends LinearUnit<MoneyPerDurationUnit>
{
/** */
private static final long serialVersionUID = 20150905L;
/** The unit of money for the money per time unit, e.g., EUR. */
private final MoneyUnit moneyUnit;
/** The unit of time for the money per time unit, e.g., hour. */
private final DurationUnit durationUnit;
/** Euro per hour. */
public static final MoneyPerDurationUnit EUR_PER_HOUR;
/** Euro per day. */
public static final MoneyPerDurationUnit EUR_PER_DAY;
/** US$ per hour. */
public static final MoneyPerDurationUnit USD_PER_HOUR;
/** US$ per day. */
public static final MoneyPerDurationUnit USD_PER_DAY;
/** The standard unit to use. */
private static MoneyPerDurationUnit standardMoneyPerDurationUnit;
static
{
EUR_PER_HOUR = new MoneyPerDurationUnit(MoneyUnit.EUR, DurationUnit.HOUR, "EUR per hour", "\u20AC/h", false);
EUR_PER_DAY = new MoneyPerDurationUnit(MoneyUnit.EUR, DurationUnit.DAY, "EUR per day", "\u20AC/day", false);
USD_PER_HOUR = new MoneyPerDurationUnit(MoneyUnit.USD, DurationUnit.HOUR, "USD per hour", "US$/h", false);
USD_PER_DAY = new MoneyPerDurationUnit(MoneyUnit.USD, DurationUnit.DAY, "USD per day", "US$/day", false);
standardMoneyPerDurationUnit = EUR_PER_HOUR;
}
/**
* Build a money per time unit from a money unit and an time unit.
* @param moneyUnit the unit of money for the money per time unit, e.g., EUR
* @param durationUnit the unit of time for the money per time unit, e.g., hour
* @param nameOrNameKey if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself
* @param abbreviationOrAbbreviationKey if standardUnit: the key to the locale file for the abbreviation of the unit,
* otherwise the abbreviation itself
* @param standardUnit indicates whether it is a standard unit with a definition in the locale, or a user-defined unit
*/
private MoneyPerDurationUnit(final MoneyUnit moneyUnit, final DurationUnit durationUnit, final String nameOrNameKey,
final String abbreviationOrAbbreviationKey, final boolean standardUnit)
{
super(nameOrNameKey, abbreviationOrAbbreviationKey, UnitSystem.OTHER, standardMoneyPerDurationUnit,
moneyUnit.getScaleFactor() / durationUnit.getScaleFactor(), standardUnit);
this.moneyUnit = moneyUnit;
this.durationUnit = durationUnit;
}
/**
* Build a user-defined money per time unit from a money unit and an time unit.
* @param moneyUnit the unit of money for the money per time unit, e.g., EUR
* @param durationUnit the unit of time for the money per time unit, e.g., hour
* @param name the key to the locale file for the long name of the unit
* @param abbreviation the key to the locale file for the abbreviation of the unit
*/
public MoneyPerDurationUnit(final MoneyUnit moneyUnit, final DurationUnit durationUnit, final String name,
final String abbreviation)
{
this(moneyUnit, durationUnit, name, abbreviation, false);
}
/**
* Build a MoneyPerDurationUnit unit based on another MoneyPerDurationUnit.
* @param nameOrNameKey if standardUnit: the key to the locale file for the long name of the unit, otherwise the name itself
* @param abbreviationOrAbbreviationKey if standardUnit: the key to the locale file for the abbreviation of the unit,
* otherwise the abbreviation itself
* @param referenceUnit the unit to convert to
* @param scaleFactorToReferenceUnit multiply a value in this unit by the factor to convert to the given reference unit
* @param standardUnit indicates whether it is a standard unit with a definition in the locale, or a user-defined unit
*/
private MoneyPerDurationUnit(final String nameOrNameKey, final String abbreviationOrAbbreviationKey,
final MoneyPerDurationUnit referenceUnit, final double scaleFactorToReferenceUnit, final boolean standardUnit)
{
super(nameOrNameKey, abbreviationOrAbbreviationKey, UnitSystem.OTHER, referenceUnit, scaleFactorToReferenceUnit,
standardUnit);
this.moneyUnit = referenceUnit.getMoneyUnit();
this.durationUnit = referenceUnit.getDurationUnit();
}
/**
* Build a user-defined MoneyPerDurationUnit with a conversion factor to another MoneyPerDurationUnit.
* @param name the long name of the unit
* @param abbreviation the abbreviation of the unit
* @param referenceUnit the unit to convert to
* @param scaleFactorToReferenceUnit multiply a value in this unit by the factor to convert to the given reference unit
*/
public MoneyPerDurationUnit(final String name, final String abbreviation, final MoneyPerDurationUnit referenceUnit,
final double scaleFactorToReferenceUnit)
{
this(name, abbreviation, referenceUnit, scaleFactorToReferenceUnit, false);
}
/**
* @return moneyUnit
*/
public final MoneyUnit getMoneyUnit()
{
return this.moneyUnit;
}
/**
* @return durationUnit
*/
public final DurationUnit getDurationUnit()
{
return this.durationUnit;
}
/**
* Set the standard MoneyPerDurationUnit in case the standard MoneyUnit changes, as the standard money unit is flexible.
* @param standardMoneyUnit the new standard money unit.
*/
protected static void setStandardUnit(final MoneyUnit standardMoneyUnit)
{
try
{
standardMoneyPerDurationUnit = new MoneyPerDurationUnit(standardMoneyUnit, DurationUnit.HOUR,
standardMoneyUnit.getName() + " per hour", standardMoneyUnit.getAbbreviation() + "/h");
}
catch (Exception e)
{
// ignore a RunTimeException that indicates that the Unit might already exist
e = null;
}
}
/** {@inheritDoc} */
@Override
public final MoneyPerDurationUnit getStandardUnit()
{
return standardMoneyPerDurationUnit;
}
/**
* @return standard MoneyPerDurationUnit
*/
public static MoneyPerDurationUnit getStandardMoneyPerDurationUnit()
{
return standardMoneyPerDurationUnit;
}
/** {@inheritDoc} */
@Override
public final String getSICoefficientsString()
{
return "1/s";
}
/** {@inheritDoc} */
@Override
public int hashCode()
{
final int prime = 31;
int result = super.hashCode();
result = prime * result + ((this.durationUnit == null) ? 0 : this.durationUnit.hashCode());
result = prime * result + ((this.moneyUnit == null) ? 0 : this.moneyUnit.hashCode());
return result;
}
/** {@inheritDoc} */
@SuppressWarnings("checkstyle:needbraces")
@Override
public boolean equals(final Object obj)
{
if (this == obj)
return true;
if (!super.equals(obj))
return false;
if (getClass() != obj.getClass())
return false;
MoneyPerDurationUnit other = (MoneyPerDurationUnit) obj;
if (this.durationUnit == null)
{
if (other.durationUnit != null)
return false;
}
else if (!this.durationUnit.equals(other.durationUnit))
return false;
if (this.moneyUnit == null)
{
if (other.moneyUnit != null)
return false;
}
else if (!this.moneyUnit.equals(other.moneyUnit))
return false;
return true;
}
}