tec.units.ri.unit.BaseUnit 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-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.unit;

import java.util.Map;

import javax.measure.Dimension;
import javax.measure.Quantity;
import javax.measure.UnitConverter;

import tec.units.ri.AbstractConverter;
import tec.units.ri.AbstractUnit;
import tec.units.ri.quantity.QuantityDimension;

/**
 *  This class represents the building blocks on top of which all others
 *     physical units are created. Base units are always unscaled SI units.
 * 
 *  When using the standard model, all seven SI base units
 *     are dimensionally independent.
 *
 * @see 
 *       Wikipedia: SI base unit
 *
 * @author  Jean-Marie Dautelle
 * @author Werner Keil
 * @version 0.5, Sep 20, 2015
 */
public final class BaseUnit> extends AbstractUnit {

    /**
	 * 
	 */
//	private static final long serialVersionUID = 1721629233768215930L;

	/**
     * Holds the symbol.
     */
    private final String symbol;

    /**
     * Holds the base unit dimension.
     */
    private final Dimension dimension;

    /**
     * Creates a base unit having the specified symbol and dimension.
     *
     * @param symbol the symbol of this base unit.
     */
    public BaseUnit(String symbol, Dimension dimension) {
        this.symbol = symbol;
        if (dimension == null) {
        	dimension = QuantityDimension.getInstance(' '); // FIXME try pass char here
        }
        this.dimension = dimension;
    }
    
    /**
     * Creates a base unit having the specified symbol and dimension.
     *
     * @param symbol the symbol of this base unit.
     */
    public BaseUnit(String symbol) {
        this.symbol = symbol;
        this.dimension = QuantityDimension.NONE;
    }
    
    /**
     * Creates a base unit having the specified symbol and name.
     *
     * @param symbol the symbol of this base unit.
     * @param name the name of this base unit.
     * @throws IllegalArgumentException if the specified symbol is
     *         associated to a different unit.
     */
    public BaseUnit(String symbol, String name) {
        this(symbol);
        this.name = name;
        // Checks if the symbol is associated to a different unit. TODO verify if we want these checks
/*        synchronized (AbstractUnit.SYMBOL_TO_UNIT) {
            Unit unit = AbstractUnit.SYMBOL_TO_UNIT.get(symbol);
            if (unit == null) {
                AbstractUnit.SYMBOL_TO_UNIT.put(symbol, this);
                return;
            }
            if (!(unit instanceof BaseUnit))
                throw new IllegalArgumentException("Symbol " + symbol + " is associated to a different unit");
        } */
    }

    @Override
    public String getSymbol() {
        return symbol;
    }

    @Override
    public AbstractUnit toSystemUnit() {
        return this;
    }

    @Override
    public UnitConverter getSystemConverter() throws UnsupportedOperationException {
        return AbstractConverter.IDENTITY;
    }

    @Override
    public Dimension getDimension() {
        return dimension;
    }

    @Override
    public final boolean equals(Object that) {
        if (this == that) return true;
        if (!(that instanceof BaseUnit)) return false;
        BaseUnit thatUnit = (BaseUnit) that;
        return this.symbol.equals(thatUnit.symbol) 
                && this.dimension.equals(thatUnit.dimension);
    }

    @Override
    public final int hashCode() {
        return symbol.hashCode();
    }

	@Override
	public Map, Integer> getProductUnits() {
		// TODO Auto-generated method stub
		return null;
	}
}