001/*
002 * Units of Measurement Reference Implementation
003 * Copyright (c) 2005-2018, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
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-385, Indriya nor the names of their 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 tech.units.indriya.quantity;
031
032import java.math.BigDecimal;
033import java.math.BigInteger;
034import java.text.ParsePosition;
035import java.util.Objects;
036
037import javax.measure.Quantity;
038import javax.measure.Unit;
039import javax.measure.format.MeasurementParseException;
040
041import tech.units.indriya.ComparableQuantity;
042import tech.units.indriya.format.AbstractQuantityFormat;
043import tech.units.indriya.format.SimpleQuantityFormat;
044
045/**
046 * Singleton class for accessing {@link Quantity} instances.
047 * @version 1.1.1
048 * @author werner
049 * @author otaviojava
050 * @since 1.0
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} quantity 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 Locale-neutral quantity formatting and parsing are handled by the {@link AbstractQuantityFormat} class and its
068   * subclasses.
069   * </p>
070   *
071   * @param csq
072   *          the decimal value and its unit (if any) separated by space(s).
073   * @return <code>QuantityFormat.getInstance(LOCALE_NEUTRAL).parse(csq, new ParsePosition(0))</code>
074   */
075  public static ComparableQuantity<?> getQuantity(CharSequence csq) {
076    try {
077      return SimpleQuantityFormat.getInstance().parse(csq, new ParsePosition(0));
078    } catch (MeasurementParseException e) {
079      throw new IllegalArgumentException(e.getParsedString());
080    }
081  }
082
083  /**
084   * Returns the scalar measurement. When the {@link Number} was {@link BigDecimal} or {@link BigInteger} will uses {@link DecimalQuantity}, when the
085   * {@link Number} was {@link Double} will {@link DoubleQuantity} otherwise will {@link NumberQuantity}. in the specified unit.
086   * 
087   * @param value
088   *          the measurement value.
089   * @param unit
090   *          the measurement unit.
091   * @return the corresponding <code>numeric</code> measurement.
092   * @throws NullPointerException
093   *           when value or unit were null
094   */
095  public static <Q extends Quantity<Q>> ComparableQuantity<Q> getQuantity(Number value, Unit<Q> unit) {
096    Objects.requireNonNull(value);
097    Objects.requireNonNull(unit);
098    if (Double.class.isInstance(value)) {
099      return new DoubleQuantity<>(Double.class.cast(value), unit);
100    } else if (BigDecimal.class.isInstance(value)) {
101      return new DecimalQuantity<>(BigDecimal.class.cast(value), unit);
102    } else if (BigInteger.class.isInstance(value)) {
103      return new DecimalQuantity<>(new BigDecimal(BigInteger.class.cast(value)), unit);
104    }
105    return new NumberQuantity<>(value, unit);
106  }
107}