/*
 * Units - Temporary implementation for Geotools 2
 * Copyright (C) 1998 University Corporation for Atmospheric Research (Unidata)
 *               1998 Bill Hibbard & al. (VisAD)
 *               1999 Pêches et Océans Canada
 *               2000 Institut de Recherche pour le Développement
 *               2002 Centre for Computational Geography
 *
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Library General Public
 *    License as published by the Free Software Foundation; either
 *    version 2 of the License, or (at your option) any later version.
 *
 *    This library 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
 *    Library General Public License for more details (http://www.gnu.org/).
 *
 *
 *    This package is inspired from the units package of VisAD.
 *    Unidata and Visad's work is fully acknowledged here.
 *
 *                   THIS IS A TEMPORARY CLASS
 *
 *    This is a placeholder for future <code>Unit</code> class.
 *    This skeleton will be removed when the real classes from
 *    JSR-108: Units specification will be publicly available.
 */
package org.geotools.units;


/**
 * Exceptions signalant qu'une certaine opération ne peut pas être faite
 * sur une certaine unité. Cette exception peut être lancée lorsqu'une conversion est impossible,
 * ou qu'on ne peut pas multiplier une unité par une autre.
 *
 * @source $URL$
 * @version 1.0
 * @author Steven R. Emmerson
 * @author Bill Hibbard
 * @author Martin Desruisseaux
 *
 * @deprecated Replaced by the {@link javax.units.Unit} framework.
 */
public class UnitException extends RuntimeException {
    /**
     * Serial number for interoperability with different versions.
     */
    private static final long serialVersionUID = -6935210984697824869L;
    
    /**
     * Première unités en cause lors de l'exception. Il peut s'agir des unités <var>A</var> dans l'expression
     * <code>A.{@link Unit#multiply multiply}(B)</code> ou <code>A.{@link Unit#convert convert}(values, B)</code>.
     * Ce champ peut être nul s'il ne s'applique pas.
     */
    /*public*/ final Unit unitA;
    
    /**
     * Deuxième unités en cause lors de l'exception. Il peut s'agir des unités <var>B</var> dans l'expression
     * <code>A.{@link Unit#multiply multiply}(B)</code> ou <code>A.{@link Unit#convert convert}(values, B)</code>.
     * Ce champ peut être nul s'il ne s'applique pas. Par exemple <code>unitB</code> sera nul si l'exception
     * provient de la méthode <code>A.{@link Unit#pow pow}(n)</code>.
     */
    /*public*/ final Unit unitB;
    
    /**
     * Crée une exception sans messages.
     */
    public UnitException() {
        unitA=null;
        unitB=null;
    }
    
    /**
     * Crée une exception avec le message spécifié.
     */
    public UnitException(final String msg) {
        super(msg);
        unitA=null;
        unitB=null;
    }
    
    /**
     * Crée une exception avec le message spécifié
     * et en désignant les deux unités coupables.
     */
    /*public*/ UnitException(final String msg, final Unit A, final Unit B) {
        super(msg);
        unitA=A;
        unitB=B;
    }
}