https://openjdk.java.net/ 
/*
 * Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

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 section 15.18.1.1 of
The Java Language Specification),
regardless of the type of expression.

Since:  1.4
/**
 * Thrown to indicate that an assertion has failed.
 *
 * <p>The seven one-argument public constructors provided by this
 * class ensure that the assertion error returned by the invocation:
 * <pre>
 *     new AssertionError(<i>expression</i>)
 * </pre>
 * has as its detail message the <i>string conversion</i> of
 * <i>expression</i> (as defined in section 15.18.1.1 of
 * <cite>The Java Language Specification</cite>),
 * regardless of the type of <i>expression</i>.
 *
 * @since   1.4
 */
public class AssertionError extends Error {
    @java.io.Serial
    private static final long serialVersionUID = -5013299493970297370L;

    
Constructs an AssertionError with no detail message.

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

    
This internal constructor does no processing on its string argument,
even if it is a null reference.  The public constructors will
never call this constructor with a null argument.

/**
     * This internal constructor does no processing on its string argument,
     * even if it is a null reference.  The public constructors will
     * never call this constructor with a null argument.
     */
    private AssertionError(String detailMessage) {
        super(detailMessage);
    }

    
Constructs an AssertionError with its detail message derived
from the specified object, which is converted to a string as
defined in section 15.18.1.1 of
The Java Language Specification.

 If the specified object is an instance of Throwable, it becomes the cause of the newly constructed assertion error.

Params:
  • detailMessage – value to be used in constructing detail message
See Also:
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified object, which is converted to a string as
     * defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *<p>
     * If the specified object is an instance of {@code Throwable}, it
     * becomes the <i>cause</i> of the newly constructed assertion error.
     *
     * @param detailMessage value to be used in constructing detail message
     * @see   Throwable#getCause()
     */
    public AssertionError(Object detailMessage) {
        this(String.valueOf(detailMessage));
        if (detailMessage instanceof Throwable)
            initCause((Throwable) detailMessage);
    }

    
Constructs an AssertionError with its detail message derived from the specified boolean, which is converted to a string as defined in section 15.18.1.1 of The Java Language Specification.

Params:
  • detailMessage – value to be used in constructing detail message
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified {@code boolean}, which is converted to
     * a string as defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(boolean detailMessage) {
        this(String.valueOf(detailMessage));
    }

    
Constructs an AssertionError with its detail message derived from the specified char, which is converted to a string as defined in section 15.18.1.1 of The Java Language Specification.

Params:
  • detailMessage – value to be used in constructing detail message
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified {@code char}, which is converted to a
     * string as defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(char detailMessage) {
        this(String.valueOf(detailMessage));
    }

    
Constructs an AssertionError with its detail message derived from the specified int, which is converted to a string as defined in section 15.18.1.1 of The Java Language Specification.

Params:
  • detailMessage – value to be used in constructing detail message
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified {@code int}, which is converted to a
     * string as defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(int detailMessage) {
        this(String.valueOf(detailMessage));
    }

    
Constructs an AssertionError with its detail message derived from the specified long, which is converted to a string as defined in section 15.18.1.1 of The Java Language Specification.

Params:
  • detailMessage – value to be used in constructing detail message
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified {@code long}, which is converted to a
     * string as defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(long detailMessage) {
        this(String.valueOf(detailMessage));
    }

    
Constructs an AssertionError with its detail message derived from the specified float, which is converted to a string as defined in section 15.18.1.1 of The Java Language Specification.

Params:
  • detailMessage – value to be used in constructing detail message
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified {@code float}, which is converted to a
     * string as defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(float detailMessage) {
        this(String.valueOf(detailMessage));
    }

    
Constructs an AssertionError with its detail message derived from the specified double, which is converted to a string as defined in section 15.18.1.1 of The Java Language Specification.

Params:
  • detailMessage – value to be used in constructing detail message
/**
     * Constructs an AssertionError with its detail message derived
     * from the specified {@code double}, which is converted to a
     * string as defined in section 15.18.1.1 of
     * <cite>The Java Language Specification</cite>.
     *
     * @param detailMessage value to be used in constructing detail message
     */
    public AssertionError(double detailMessage) {
        this(String.valueOf(detailMessage));
    }

    
Constructs a new AssertionError with the specified detail message and cause. 
Note that the detail message associated with cause is not automatically incorporated in
this error's detail message.

Params:
  • message – the detail message, may be null
  • cause – the cause, may be null
Since:1.7
/**
     * Constructs a new {@code AssertionError} with the specified
     * detail message and cause.
     *
     * <p>Note that the detail message associated with
     * {@code cause} is <i>not</i> automatically incorporated in
     * this error's detail message.
     *
     * @param  message the detail message, may be {@code null}
     * @param  cause the cause, may be {@code null}
     *
     * @since 1.7
     */
    public AssertionError(String message, Throwable cause) {
        super(message, cause);
    }
}