tec.units.ri.quantity.AbstractQuantityFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unit-ri Show documentation
Show all versions of unit-ri Show documentation
Unit Standard (JSR 363) Reference Implementation.
/*
* Unit-API - Units of Measurement API for Java
* Copyright (c) 2005-2015, Jean-Marie Dautelle, Werner Keil, V2COM.
*
* 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.
*/
package tec.units.ri.quantity;
import static tec.units.ri.unit.Units.*;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.measure.Quantity;
import javax.measure.Unit;
import javax.measure.quantity.*;
import javax.measure.spi.QuantityFactory;
import tec.units.ri.AbstractQuantity;
/**
* A factory producing simple quantities instances (tuples {@link Number}/{@link Unit}).
*
* For example:
* Mass m = AbstractQuantityFactory.getInstance(Mass.class).create(23.0, KILOGRAM); // 23.0 kg
* Time m = AbstractQuantityFactory.getInstance(Time.class).create(124, MILLI(SECOND)); // 124 ms
*
* @param The type of the quantity.
*
* @author Martin Desruisseaux
* @author Werner Keil
* @author Jean-Marie Dautelle
* @version 0.6.6, $Date: 2015-07-06 $
*/
abstract class AbstractQuantityFactory> implements QuantityFactory {
/**
* Holds the current instances.
*/
@SuppressWarnings("rawtypes")
static final Map INSTANCES = new HashMap();
static final Logger logger = Logger.getLogger(AbstractQuantityFactory.class.getName());
static final Level LOG_LEVEL = Level.FINE;
/**
* Overrides the default implementation of the factory for the specified
* quantity type.
*
* @param The type of the quantity
* @param type the quantity type
* @param factory the quantity factory
*/
protected static > void setInstance(final Class type, AbstractQuantityFactory factory) {
if (!AbstractQuantity.class.isAssignableFrom(type))
// This exception is not documented because it should never happen if the
// user don't try to trick the Java generic types system with unsafe cast.
throw new ClassCastException();
INSTANCES.put(type, factory);
}
/**
* 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
*/
public abstract Quantity create(Number value, Unit unit);
// public abstract > Q create(N number, U unit);
/**
* Returns the metric unit for quantities produced by this factory
* or null if unknown.
*
* @return the metric units for this factory quantities.
*/
public abstract Unit getMetricUnit();
/**
* The default factory implementation. This factory provides
* a default implementation for every {@link AbstractQuantity} sub-types.
*
* @param The type of the quantity
*/
private static final class Default> extends AbstractQuantityFactory {
/**
* The type of the quantities created by this factory.
*/
@SuppressWarnings("unused")
private final Class type;
/**
* The metric unit for quantities created by this factory.
*/
private final Unit metricUnit;
/**
* Creates a new factory for quantities of the given type.
*
* @param type The type of the quantities created by this factory.
*/
@SuppressWarnings("unchecked")
Default(final Class type) {
this.type = type;
metricUnit = CLASS_TO_METRIC_UNIT.get(type);
}
@SuppressWarnings("rawtypes")
static final Map CLASS_TO_METRIC_UNIT = new HashMap();
static {
CLASS_TO_METRIC_UNIT.put(Dimensionless.class, ONE);
CLASS_TO_METRIC_UNIT.put(ElectricCurrent.class, AMPERE);
CLASS_TO_METRIC_UNIT.put(LuminousIntensity.class, CANDELA);
CLASS_TO_METRIC_UNIT.put(Temperature.class, KELVIN);
CLASS_TO_METRIC_UNIT.put(Mass.class, KILOGRAM);
CLASS_TO_METRIC_UNIT.put(Length.class, METRE);
CLASS_TO_METRIC_UNIT.put(AmountOfSubstance.class, MOLE);
CLASS_TO_METRIC_UNIT.put(Time.class, SECOND);
// CLASS_TO_METRIC_UNIT.put(MagnetomotiveForce.class, AMPERE_TURN);
CLASS_TO_METRIC_UNIT.put(Angle.class, RADIAN);
CLASS_TO_METRIC_UNIT.put(SolidAngle.class, STERADIAN);
// CLASS_TO_METRIC_UNIT.put(Information.class, BIT);
CLASS_TO_METRIC_UNIT.put(Frequency.class, HERTZ);
CLASS_TO_METRIC_UNIT.put(Force.class, NEWTON);
CLASS_TO_METRIC_UNIT.put(Pressure.class, PASCAL);
CLASS_TO_METRIC_UNIT.put(Energy.class, JOULE);
CLASS_TO_METRIC_UNIT.put(Power.class, WATT);
CLASS_TO_METRIC_UNIT.put(ElectricCharge.class, COULOMB);
CLASS_TO_METRIC_UNIT.put(ElectricPotential.class, VOLT);
CLASS_TO_METRIC_UNIT.put(ElectricCapacitance.class, FARAD);
CLASS_TO_METRIC_UNIT.put(ElectricResistance.class, OHM);
CLASS_TO_METRIC_UNIT.put(ElectricConductance.class, SIEMENS);
CLASS_TO_METRIC_UNIT.put(MagneticFlux.class, WEBER);
CLASS_TO_METRIC_UNIT.put(MagneticFluxDensity.class, TESLA);
CLASS_TO_METRIC_UNIT.put(ElectricInductance.class, HENRY);
CLASS_TO_METRIC_UNIT.put(LuminousFlux.class, LUMEN);
CLASS_TO_METRIC_UNIT.put(Illuminance.class, LUX);
CLASS_TO_METRIC_UNIT.put(Radioactivity.class, BECQUEREL);
CLASS_TO_METRIC_UNIT.put(RadiationDoseAbsorbed.class, GRAY);
CLASS_TO_METRIC_UNIT.put(RadiationDoseEffective.class, SIEVERT);
CLASS_TO_METRIC_UNIT.put(CatalyticActivity.class, KATAL);
CLASS_TO_METRIC_UNIT.put(Speed.class, METRES_PER_SECOND);
CLASS_TO_METRIC_UNIT.put(Acceleration.class, METRES_PER_SQUARE_SECOND);
CLASS_TO_METRIC_UNIT.put(Area.class, SQUARE_METRE);
CLASS_TO_METRIC_UNIT.put(Volume.class, CUBIC_METRE);
}
@SuppressWarnings("unchecked")
public Quantity create(Number value, Unit unit) {
// public > Q create(N value, U unit) {
return (Q) new NumberQuantity(value, unit);
}
public Unit getMetricUnit() {
return metricUnit;
}
}
}