jdk/src/share/classes/java/lang/AssertionError.java
author ohair
Tue, 28 Dec 2010 15:53:50 -0800
changeset 7668 d4a77089c587
parent 5776 5f48622225ab
child 9266 121fb370f179
permissions -rw-r--r--
6962318: Update copyright year Reviewed-by: xdono
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
7668
d4a77089c587 6962318: Update copyright year
ohair
parents: 5776
diff changeset
     2
 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1320
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * Thrown to indicate that an assertion has failed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <p>The seven one-argument public constructors provided by this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * class ensure that the assertion error returned by the invocation:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *     new AssertionError(<i>expression</i>)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * has as its detail message the <i>string conversion</i> of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * <i>expression</i> (as defined in <a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * href="http://java.sun.com/docs/books/jls/second_edition/html/j.title.doc.html">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <i>The Java Language Specification, Second Edition</i></a>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <a href="http://java.sun.com/docs/books/jls/second_edition/html/expressions.doc.html#40220">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * Section  15.18.1.1</a>), regardless of the type of <i>expression</i>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * @since   1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
public class AssertionError extends Error {
1320
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    46
    private static final long serialVersionUID = -5013299493970297370L;
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    47
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * Constructs an AssertionError with no detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    public AssertionError() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * This internal constructor does no processing on its string argument,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * even if it is a null reference.  The public constructors will
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * never call this constructor with a null argument.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    private AssertionError(String detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        super(detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * from the specified object, which is converted to a string as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * defined in <i>The Java Language Specification, Second
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     *<p>
5776
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
    69
     * If the specified object is an instance of {@code Throwable}, it
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * becomes the <i>cause</i> of the newly constructed assertion error.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * @see   Throwable#getCause()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    public AssertionError(Object detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
        if (detailMessage instanceof Throwable)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
            initCause((Throwable) detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * from the specified <code>boolean</code>, which is converted to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * a string as defined in <i>The Java Language Specification,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * Second Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    public AssertionError(boolean detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     * from the specified <code>char</code>, which is converted to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     * string as defined in <i>The Java Language Specification, Second
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     * Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    public AssertionError(char detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * from the specified <code>int</code>, which is converted to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * string as defined in <i>The Java Language Specification, Second
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
    public AssertionError(int detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     * from the specified <code>long</code>, which is converted to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * string as defined in <i>The Java Language Specification, Second
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     * Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
    public AssertionError(long detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
     * from the specified <code>float</code>, which is converted to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
     * string as defined in <i>The Java Language Specification, Second
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
     * Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
    public AssertionError(float detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
     * Constructs an AssertionError with its detail message derived
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
     * from the specified <code>double</code>, which is converted to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
     * string as defined in <i>The Java Language Specification, Second
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
     * Edition</i>, Section 15.18.1.1.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     * @param detailMessage value to be used in constructing detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
    public AssertionError(double detailMessage) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
        this("" +  detailMessage);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
    }
5776
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   152
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   153
    /**
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   154
     * Constructs a new {@code AssertionError} with the specified
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   155
     * detail message and cause.
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   156
     *
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   157
     * <p>Note that the detail message associated with
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   158
     * {@code cause} is <i>not</i> automatically incorporated in
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   159
     * this error's detail message.
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   160
     *
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   161
     * @param  message the detail message, may be {@code null}
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   162
     * @param  cause the cause, may be {@code null}
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   163
     *
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   164
     * @since 1.7
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   165
     */
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   166
    public AssertionError(String message, Throwable cause) {
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   167
        super(message, cause);
5f48622225ab 6935997: Please add a nested throwable constructor to AssertionError
darcy
parents: 5506
diff changeset
   168
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
}