001/* AssertionError.java -- indication of a failed assertion
002   Copyright (C) 2002, 2005, 2012  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.lang;
040
041/**
042 * An assertion error normally occurs as a result of the <code>assert</code>
043 * statement added in JDK 1.4, to indicate that an assertion failed. There
044 * are enough constructors to ensure that
045 * <code>new AssertionError(<em>expression</em>)</code> will work for all
046 * expressions, regardless of type, as if the error message were given by
047 * the string <code>"" + <em>expression</em></code>. This extends Error,
048 * because you usually do not want to inadvertently trap an assertion failure.
049 *
050 * @author Eric Blake (ebb9@email.byu.edu)
051 * @since 1.4
052 * @status updated to 1.4
053 */
054public class AssertionError extends Error
055{
056  /**
057   * Compatible with JDK 1.4+.
058   */
059  private static final long serialVersionUID = -5013299493970297370L;
060
061  /**
062   * Construct an AssertionError with no detail message.
063   */
064  public AssertionError()
065  {
066  }
067
068  /**
069   * Construct an AssertionError with the string conversion of the given
070   * object as its error message. If the object is a Throwable, it is also
071   * set as the cause of this error.
072   *
073   * @param msg the source of the error message
074   * @see Throwable#getCause()
075   */
076  public AssertionError(Object msg)
077  {
078    super("" + msg);
079    if (msg instanceof Throwable)
080      initCause((Throwable) msg);
081  }
082
083  /**
084   * Construct an AssertionError with the string conversion of the given
085   * boolean as its error message.
086   *
087   * @param msg the source of the error message
088   */
089  public AssertionError(boolean msg)
090  {
091    super(msg ? "true" : "false");
092  }
093
094  /**
095   * Construct an AssertionError with the string conversion of the given
096   * char as its error message.
097   *
098   * @param msg the source of the error message
099   */
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
149  /**
150   * Construct an AssertionError with detail message and cause.
151   *
152   * @param msg Detail message.
153   * @param cause The cause of this exception, may be null
154   * @since 1.7
155   */
156  public AssertionError(String msg, Throwable cause)
157  {
158    super(msg, cause);
159  }
160}