UnitConversion.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo Framework
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.model.api.units;

import java.math.BigDecimal;

/**
 * Unit conversion
 * 
 * @since 1.1.8
 * @author maku
 */
public interface UnitConversion {

    /**
     * @return new reversed UnitConversion
     */
    UnitConversion reverse();

    /**
     * @param other
     * @return new UnitConversion object which represent conversion from this source unit to target unit of other UnitConversion
     *         given in argument
     */
    UnitConversion merge(final UnitConversion other);

    /**
     * @return conversion ratio
     */
    BigDecimal getRatio();

    /**
     * @return source unit symbol
     */
    String getUnitFrom();

    /**
     * @return target unit symbol
     */
    String getUnitTo();

}