tec.uom.se.unit.package-info Maven / Gradle / Ivy

/*
 * Units of Measurement Implementation for Java SE
 * Copyright (c) 2005-2018, 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-363 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.
 */
/**
 * This package provides supports for physics units, in conformity with the
 * Units of Measurement API.
 *
 *
 * Usage:
 * 
 *
 * import javax.measure.quantity.*; // Holds quantity types.
 * 
 * import tec.uom.se.AbstractUnit;
 * import tec.uom.se.function.AbstractConverter;
 * 
 * import static tec.uom.se.unit.Units.*; // Standard units.
 * import static tec.uom.se.unit.MetricPrefix.*;
 * import ...US.*; // US units (external module)
 * 
 * public class Main {
 *     public void main(String[] args) {
 *
 *         // Conversion between units (explicit way).
 *         AbstractUnit sourceUnit = KILO(METRE);
 *         AbstractUnit targetUnit = MILE;
 *         PhysicsConverter uc = sourceUnit.getConverterTo(targetUnit);
 *         System.out.println(uc.convert(10)); // Converts 10 km to miles.
 *
 *         // Same conversion than above, packed in one line.
 *         System.out.println(KILO(METRE).getConverterTo(MILE).convert(10));
 *
 *         // Retrieval of the SI unit (identifies the measurement type).
 *         System.out.println(REVOLUTION.divide(MINUTE).toSI());
 *
 *         // Dimension checking (allows/disallows conversions)
 *         System.out.println(ELECTRON_VOLT.isCompatible(WATT.times(HOUR)));
 *
 *         // Retrieval of the unit dimension (depends upon the current model).
 *         System.out.println(ELECTRON_VOLT.getDimension());
 *     }
 * }
 *
 * > 6.2137119223733395
 * > 6.2137119223733395
 * > rad/s
 * > true
 * > [L]²·[M]/[T]²
 * 
 *
 * Unit Parameterization
 *
 *     CommonUnits are parameterized enforce compile-time checks of units/measures consistency, for example:[code]
 *
 *     Unit MINUTE = SECOND.times(60); // Ok.
 *     tUnit MINUTE = METRE.times(60); // Compile error.
 *
 *     Unit HECTOPASCAL = HECTO(PASCAL); // Ok.
 *     Unit HECTOPASCAL = HECTO(NEWTON); // Compile error.
 *
 *     Quantity duration = ComparableQuantity.of(2, MINUTE); // Ok.
 *     Quantity duration = ComparableQuantity.of(2, CELSIUS); // Compile error.
 *
 *     long milliseconds = duration.longValue(MILLI(SECOND)); // Ok.
 *     long milliseconds = duration.longValue(POUND); // Compile error.
 *     [/code]
 *
 *     Runtime checks of dimension consistency can be done for more complex cases.
 *
 *     
 *     Unit SQUARE_FOOT = FOOT.times(FOOT).asType(Area.class); // Ok.
 *     Unit SQUARE_FOOT = FOOT.times(KELVIN).asType(Area.class); // Runtime error.
 *
 *     Unit KELVIN = AbstractUnit.of("K").asType(Temperature.class); // Ok.
 *     Unit KELVIN = AbstractUnit.of("kg").asType(Temperature.class); // Runtime error.
 *     
 *     
 *
 * @author Jean-Marie Dautelle
 * @author Werner Keil
 * @version 0.3
 */
package tec.uom.se.unit;