/* * Copyright (C) 1997 Roger Whitney * * This file is part of the San Diego State University Java Library. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ package iutsud ; /** * Cette classe imite la macro ASSERT de C/C++. * Elle permet de s'assurer qu'une condition est vérifiée * avant de poursuivre l'exécution.

* Elle a trois méthodes * statiques : pre, post et invariant * Ces méthodes sont identiques. Chaque méthode arrête l'exécution du * programme en levant une exception si son argument est faux.

* Un exemple d'utilisation d'assertion est : * 

 *		Assertion.pre( (mois == 1 ) && ( jour <= 31 ));
 *
* Ceci vérifie que la condition est vrai à ce stade de l'exécution. * Si elle n'est pas vérifiée, une exception de type * Assertion.PreConditionException, * Assertion.PostConditionException * ou Assertion.InvariantException * est levée. * Ces exceptions dérivent de RuntimeException * et arrêtent l'exécution du programme en affichant * l'état de la pile d'exécution.

* Cette classe provient de la classe sdsu.io.Assert de l'université * de San Diego (http://www.eli.sdsu.edu/java-SDSU). *

Les modifications sont mineures : *

  • définition et utilisation d'exceptions internes à la classe *
  • suppression de la méthode condition *
  • méthode classInvariant renommée invariant *
  • classe Assert renommée Assertion */ /* *

    This class is modeled after the ASSERT macro in C/C++. The class * has three static methods. * The methods are identical. Each method will throw an exception if * is argument is false. A sample use of the assert is: * 

     *		Assert.pre( (X > 5 ) && ( Z <= 10 ));
 *
    * This asserts that the condition should be true at this point. * If it is not an exception will be thrown. So the program can * assume that the condition is true after the above assert.

    * In C/C++ ASSERT is defined as a macro. Thus the macro can be * turned off with a compile switch. This allows the code to contain * ASSERTS with out any runtime cost. There is no way in Java to * completely eliminate the cost of the Assert calls. Hopefully * future compilers will be smart enough to use tricks with * classpaths and two versions of this class to "turn off" the * Assert calls in productin code without modifing the program * source.

    * See Writing Solid Code by Steve Maguire, pp 13-44 * or Object-Oriented Software Construction by * Bertrand Meyer, pp 111 - 163 for the use and importance * of Assert. * * @see sdsu.test.AssertException * @version 1.0 30 December 1997 * @author Roger Whitney * (whitney@cs.sdsu.edu) */ public abstract class Assertion { private Assertion() { super() ; } // /* main de test private static void main(String args[]) { while (true) { System.out.print( "Print a Boolean "); boolean b = Console.readBoolean() ; pre(b) ; post(b) ; invariant(b) ; } } // */ /** * Exception levée lorsqu'une précondition n'est pas vérifiée */ public static class PreConditionException extends RuntimeException { public PreConditionException(String message) { super(message) ; } } // end class PreConditionException /** * Exception levée lorsqu'une postcondition n'est pas vérifiée */ public static class PostConditionException extends RuntimeException { public PostConditionException(String message) { super(message) ; } } // end class PostConditionException /** * Exception levée lorsqu'un invariant n'est pas vérifiée */ public static class InvariantException extends RuntimeException { public InvariantException(String message) { super(message) ; } } // end class InvariantException /** * Arrête l'exécution du programme si la condition n'est pas vérifiée * en levant l'exception PreConditionException * @param cond la condition à vérifier */ public static void pre( boolean cond ) { if ( !cond ) throw new PreConditionException( "Précondition non vérifiée" ); } /** * Arrête l'exécution du programme si la condition n'est pas vérifiée * en levant l'exception PreConditionException * avec le message passé en paramètre * @param cond la condition à vérifier * @param message message à afficher */ public static void pre( boolean cond , String message ) { if ( !cond ) throw new PreConditionException( message ); } /** * Arrête l'exécution du programme si la condition n'est pas vérifiée * en levant l'exception PostConditionException * @param cond la condition à vérifier */ public static void post( boolean cond ) { if ( !cond ) throw new PostConditionException( "Postcondition non vérifiée" ); } /** * Arrête l'exécution du programme si la condition n'est pas vérifiée * en levant l'exception PostConditionException * avec le message passé en paramètre * @param cond la condition à vérifier * @param message message à afficher */ public static void post( boolean cond , String message) { if ( !cond ) throw new PostConditionException( message ); } /** * Arrête l'exécution du programme si la condition n'est pas vérifiée * en levant l'exception InvariantException * @param cond la condition à vérifier */ public static void invariant( boolean cond ) { if ( !cond ) throw new InvariantException( "Invariant non vérifié" ); } /** * Arrête l'exécution du programme si la condition n'est pas vérifiée * en levant l'exception InvariantException * avec le message passé en paramètre * @param cond la condition à vérifier * @param message message à afficher */ public static void invariant( boolean cond , String message ) { if ( !cond ) throw new InvariantException( message ); } }