javax.measure.spi.QuantityFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of unit-api Show documentation
Units of Measurement Standard - This JSR specifies Java packages for modeling and working with measurement values, quantities and their corresponding units.
The newest version!
/*
 * Units of Measurement API
 * Copyright (c) 2014-2023, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of JSR-385 nor the names of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package javax.measure.spi;

import javax.measure.Quantity;
import javax.measure.Quantity.Scale;
import javax.measure.Unit;

/**
 * Represents a factory that accepts {@link Number} and {@link Unit} arguments to create {@link Quantity} results.
 *
 * @param 
 *          the type of the {@link Quantity} result
 *
 * @author Werner Keil
 * @author Otavio Santana
 * @version 1.4, December 18, 2018
 * @since 1.0
 *
 * @see  Wikipedia: Factory method pattern
 * @see Quantity
 * @see Unit
 */
public interface QuantityFactory> {

    /**
     * Returns the quantity for the specified number stated in the specified unit and scale.
     *
     * @param value
     *          the numeric value stated in the specified unit
     * @param unit
     *          the unit
     * @param scale
     *          The {@code ABSOLUTE} / {@code RELATIVE} {@code scale} of this quantity
     * @return the corresponding quantity
     * @since 2.0
     */
    Quantity create(Number value, Unit unit, Scale scale);
    
    /**
     * Returns the quantity for the specified number stated in the specified unit.
     *
     * @param value
     *          the numeric value stated in the specified unit
     * @param unit
     *          the unit
     * @return the corresponding quantity
     */
    Quantity create(Number value, Unit unit);

    /**
     * Returns the system unit for quantities produced by this factory or {@code null} if unknown.
     *
     * 
     * Because the system unit is unique by quantity type, it can be be used to identify the quantity given the unit. For example:
     * 
     *
     *      *     static boolean isAngularSpeed({@literal Unit} unit) {
     *         return unit.getSystemUnit().equals(RADIAN.divide(SECOND));
     *     }
     *     assert isAngularSpeed(REVOLUTION.divide(MINUTE)); // Returns true.
     * 
     *
     * @return the system unit for this factory.
     * @see Unit#getSystemUnit()
     */
    Unit getSystemUnit();
}