jdk/src/java.base/share/classes/java/lang/IndexOutOfBoundsException.java
author thartmann
Tue, 03 Nov 2015 09:42:11 +0100
changeset 33663 2cd62a4bd471
parent 32929 7e1bb9268b8a
child 37345 9cb6e1141bdb
permissions -rw-r--r--
8141132: JEP 254: Compact Strings Summary: Adopt a more space-efficient internal representation for strings. Reviewed-by: alanb, bdelsart, coleenp, iklam, jiangli, jrose, kevinw, naoto, pliden, roland, smarks, twisti Contributed-by: Brent Christian <brent.christian@oracle.com>, Vivek Deshpande <vivek.r.deshpande@intel.com>, Tobias Hartmann <tobias.hartmann@oracle.com>, Charlie Hunt <charlie.hunt@oracle.com>, Vladimir Kozlov <vladimir.kozlov@oracle.com>, Roger Riggs <roger.riggs@oracle.com>, Xueming Shen <xueming.shen@oracle.com>, Aleksey Shipilev <aleksey.shipilev@oracle.com>, Sandhya Viswanathan <sandhya.viswanathan@intel.com>
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
     2
 * Copyright (c) 1995, 2015, 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 index of some sort (such as to an array, to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * string, or to a vector) is out of range.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * Applications can subclass this class to indicate similar exceptions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    34
 * @author Frank Yellin
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    35
 * @since 1.0
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 */
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    37
public class IndexOutOfBoundsException extends RuntimeException {
1320
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    38
    private static final long serialVersionUID = 234122996006267687L;
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    39
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    /**
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    41
     * Constructs an {@code IndexOutOfBoundsException} with no detail message.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    public IndexOutOfBoundsException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
        super();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
    /**
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    48
     * Constructs an {@code IndexOutOfBoundsException} with the specified detail
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    49
     * message.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     *
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    51
     * @param s the detail message
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    public IndexOutOfBoundsException(String s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
        super(s);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    }
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    56
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    57
    /**
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    58
     * Constructs a new {@code IndexOutOfBoundsException} class with an
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    59
     * argument indicating the illegal index.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    60
     *
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    61
     * <p>The index is included in this exception's detail message.  The
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    62
     * exact presentation format of the detail message is unspecified.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    63
     *
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    64
     * @param index the illegal index.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    65
     * @since 9
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    66
     */
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    67
    public IndexOutOfBoundsException(int index) {
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    68
        super("Index out of range: " + index);
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    69
    }
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    70
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    71
    /**
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    72
     * Constructs an {@code IndexOutOfBoundsException} with arguments indicating
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    73
     * two out of bound values.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    74
     *
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    75
     * <p>The out of bound values are included in this exception's detail
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    76
     * message.  The exact presentation format of the detail message is
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    77
     * unspecified.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    78
     *
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    79
     * @param a the first out of bound value
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    80
     * @param b the second out of bound value
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    81
     * @since 9
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    82
     */
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    83
    public IndexOutOfBoundsException(int a, int b) {
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    84
        super("Indexed access out of bounds: " + a + ", " + b);
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    85
    }
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    86
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
}