001/*
002 * Units of Measurement Implementation for Java SE
003 * Copyright (c) 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM.
004 *
005 * All rights reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without modification,
008 * are permitted provided that the following conditions are met:
009 *
010 * 1. Redistributions of source code must retain the above copyright notice,
011 *    this list of conditions and the following disclaimer.
012 *
013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
014 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
015 *
016 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
017 *    derived from this software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package tec.uom.se.quantity;
031
032import static tec.uom.se.format.FormatBehavior.LOCALE_NEUTRAL;
033
034import java.math.BigDecimal;
035import java.math.BigInteger;
036import java.text.ParsePosition;
037import java.util.Objects;
038
039import javax.measure.Quantity;
040import javax.measure.Unit;
041import javax.measure.format.ParserException;
042
043import tec.uom.se.ComparableQuantity;
044import tec.uom.se.format.QuantityFormat;
045
046/**
047 * Singleton class for accessing {@link Quantity} instances.
048 * 
049 * @author werner
050 * @author otaviojava
051 */
052public final class Quantities {
053  /**
054   * Private singleton constructor.
055   */
056  private Quantities() {
057  }
058
059  /**
060   * Returns the {@link #valueOf(java.math.BigDecimal, javax.measure.unit.Unit) decimal} measure of unknown type corresponding to the specified
061   * representation. This method can be used to parse dimensionless quantities.<br/>
062   * <code>
063   *     Quantity<Dimensionless> proportion = Quantities.getQuantity("0.234").asType(Dimensionless.class);
064   * </code>
065   *
066   * <p>
067   * Note: This method handles only {@link javax.measure.unit.UnitFormat#getStandard standard} unit format (<a
068   * href="http://unitsofmeasure.org/">UCUM</a> based). Locale-sensitive measure formatting and parsing are handled by the {@link MeasurementFormat}
069   * class and its subclasses.
070   * </p>
071   *
072   * @param csq
073   *          the decimal value and its unit (if any) separated by space(s).
074   * @return <code>QuantityFormat.getInstance(LOCALE_NEUTRAL).parse(csq, new ParsePosition(0))</code>
075   */
076  public static ComparableQuantity<?> getQuantity(CharSequence csq) {
077    try {
078      return QuantityFormat.getInstance(LOCALE_NEUTRAL).parse(csq, new ParsePosition(0));
079    } catch (ParserException e) {
080      throw new IllegalArgumentException(e.getParsedString());
081    }
082  }
083
084  /**
085   * Returns the scalar measurement. When the {@link Number} was {@link BigDecimal} or {@link BigInteger} will uses {@link DecimalQuantity}, when the
086   * {@link Number} was {@link Double} will {@link DoubleQuantity} otherwise will {@link NumberQuantity}. in the specified unit.
087   * 
088   * @param value
089   *          the measurement value.
090   * @param unit
091   *          the measurement unit.
092   * @return the corresponding <code>numeric</code> measurement.
093   * @throws NullPointerException
094   *           when value or unit were null
095   */
096  public static <Q extends Quantity<Q>> ComparableQuantity<Q> getQuantity(Number value, Unit<Q> unit) {
097
098    Objects.requireNonNull(value);
099    Objects.requireNonNull(unit);
100    if (Double.class.isInstance(value)) {
101      return new DoubleQuantity<>(Double.class.cast(value), unit);
102    } else if (BigDecimal.class.isInstance(value)) {
103      return new DecimalQuantity<>(BigDecimal.class.cast(value), unit);
104    } else if (BigInteger.class.isInstance(value)) {
105      return new DecimalQuantity<>(new BigDecimal(BigInteger.class.cast(value)), unit);
106    }
107    return new NumberQuantity<>(value, unit);
108  }
109}