java.lang.AssertionError Maven / Gradle / Ivy

/*
This is not an official specification document, and usage is restricted.


NOTICE





(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.

Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/


  


package java.lang;

/** 
 * Thrown to indicate that an assertion has failed.
 *
 * 
The seven one-argument public constructors provided by this
 * class ensure that the assertion error returned by the invocation:
 * 
 *     new AssertionError(expression)
 * 
 * has as its detail message the string conversion of
 * expression (as defined in 
 * The Java Language Specification, Second Edition, 
 * 
 * Section  15.18.1.1), regardless of the type of expression.
 *
 * @version 1.7, 03/12/05
 * @since   JDK1.4
 */
public class AssertionError extends java.lang.Error
{

    /** 
     * Constructs an AssertionError with no detail message.
     */
    public AssertionError() { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified object, which is converted to a string as
     * defined in The Java Language Specification, Second
     * Edition, Section 15.18.1.1.
     *
     * If the specified object is an instance of Throwable, it
     * becomes the cause of the newly constructed assertion error.
     *
     * @param detailMessage value to be used in constructing detail message
     * @see   Throwable#getCause()
     */
    public AssertionError(java.lang.Object detailMessage) { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified boolean, which is converted to
     * a string as defined in The Java Language Specification,
     * Second Edition, Section 15.18.1.1.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(boolean detailMessage) { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified char, which is converted to a
     * string as defined in The Java Language Specification, Second
     * Edition, Section 15.18.1.1.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(char detailMessage) { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified int, which is converted to a
     * string as defined in The Java Language Specification, Second
     * Edition, Section 15.18.1.1.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(int detailMessage) { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified long, which is converted to a
     * string as defined in The Java Language Specification, Second
     * Edition, Section 15.18.1.1.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(long detailMessage) { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified float, which is converted to a
     * string as defined in The Java Language Specification, Second
     * Edition, Section 15.18.1.1.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(float detailMessage) { }

    /** 
     * Constructs an AssertionError with its detail message derived
     * from the specified double, which is converted to a
     * string as defined in The Java Language Specification, Second
     * Edition, Section 15.18.1.1.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(double detailMessage) { }
}