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
Unit Standard (JSR 363) Reference Implementation.
There is a newer version: 1.0.3
/*
 * Units of Measurement Reference Implementation
 * Copyright (c) 2005-2016, 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 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.spi.QuantityFactory;

import tec.units.ri.AbstractQuantity;

/**
 * A factory producing simple quantities instances (tuples {@link Number}/ {@link Unit}).
 *
 * For example:

 * 
 *      Mass m = DefaultQuantityFactory.getInstance(Mass.class).create(23.0, KILOGRAM); // 23.0 kg

 *      Time m = DefaultQuantityFactory.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.8, $Date: 2015-11-23 $
 */
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);
}