libjava/java/lang/AssertionError.java

   1 /* AssertionError.java -- indication of a failed assertion
   2    Copyright (C) 2002, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.lang;
  40
  41 /**
  42  * An assertion error normally occurs as a result of the <code>assert</code>
  43  * statement added in JDK 1.4, to indicate that an assertion failed. There
  44  * are enough constructors to ensure that
  45  * <code>new AssertionError(<em>expression</em>)</code> will work for all
  46  * espressions, regardless of type, as if the error message were given by
  47  * the string <code>"" + <em>expression</em></code>. This extends Error,
  48  * because you usually do not want to inadvertently trap an assertion failure.
  49  *
  50  * @author Eric Blake (ebb9@email.byu.edu)
  51  * @since 1.4
  52  * @status updated to 1.4
  53  */
  54 public class AssertionError extends Error
  55 {
  56   /**
  57    * Compatible with JDK 1.4+.
  58    */
  59   private static final long serialVersionUID = -5013299493970297370L;
  60
  61   /**
  62    * Construct an AssertionError with no detail message.
  63    */
  64   public AssertionError()
  65   {
  66   }
  67
  68   /**
  69    * Construct an AssertionError with the string conversion of the given
  70    * object as its error message. If the object is a Throwable, it is also
  71    * set as the cause of this error.
  72    *
  73    * @param msg the source of the error message
  74    * @see Throwable#getCause()
  75    */
  76   public AssertionError(Object msg)
  77   {
  78     super("" + msg);
  79     if (msg instanceof Throwable)
  80       initCause((Throwable) msg);
  81   }
  82
  83   /**
  84    * Construct an AssertionError with the string conversion of the given
  85    * boolean as its error message.
  86    *
  87    * @param msg the source of the error message
  88    */
  89   public AssertionError(boolean msg)
  90   {
  91     super(msg ? "true" : "false");
  92   }
  93
  94   /**
  95    * Construct an AssertionError with the string conversion of the given
  96    * char as its error message.
  97    *
  98    * @param msg the source of the error message
  99    */
 100   public AssertionError(char msg)
 101   {
 102     super(String.valueOf(msg));
 103   }
 104
 105   /**
 106    * Construct an AssertionError with the string conversion of the given
 107    * int as its error message.
 108    *
 109    * @param msg the source of the error message
 110    */
 111   public AssertionError(int msg)
 112   {
 113     super(Integer.toString(msg, 10));
 114   }
 115
 116   /**
 117    * Construct an AssertionError with the string conversion of the given
 118    * long as its error message.
 119    *
 120    * @param msg the source of the error message
 121    */
 122   public AssertionError(long msg)
 123   {
 124     super(Long.toString(msg));
 125   }
 126
 127   /**
 128    * Construct an AssertionError with the string conversion of the given
 129    * float as its error message.
 130    *
 131    * @param msg the source of the error message
 132    */
 133   public AssertionError(float msg)
 134   {
 135     super(Float.toString(msg));
 136   }
 137
 138   /**
 139    * Construct an AssertionError with the string conversion of the given
 140    * double as its error message.
 141    *
 142    * @param msg the source of the error message
 143    */
 144   public AssertionError(double msg)
 145   {
 146     super(Double.toString(msg));
 147   }
 148 }