src/java.base/share/classes/java/lang/IndexOutOfBoundsException.java
author darcy
Thu, 29 Aug 2019 16:31:34 -0700
changeset 57956 e0b8b019d2f5
parent 47216 71c04702a3d5
permissions -rw-r--r--
8229997: Apply java.io.Serial annotations in java.base Reviewed-by: alanb, rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 1995, 2019, 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 {
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
    38
    @java.io.Serial
1320
2412b1562801 6749308: java.io, java.lang, java.util exception classes don't specify serialVersionUID
chegar
parents: 2
diff changeset
    39
    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
    40
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
    /**
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    42
     * Constructs an {@code IndexOutOfBoundsException} with no detail message.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
    public IndexOutOfBoundsException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
        super();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    /**
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    49
     * Constructs an {@code IndexOutOfBoundsException} with the specified detail
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    50
     * message.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     *
32929
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    52
     * @param s the detail message
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    public IndexOutOfBoundsException(String s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
        super(s);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    }
32929
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
    /**
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    59
     * Constructs a new {@code IndexOutOfBoundsException} class with an
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    60
     * argument indicating the illegal index.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    61
     *
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    62
     * <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
    63
     * exact presentation format of the detail message is unspecified.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    64
     *
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    65
     * @param index the illegal index.
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    66
     * @since 9
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    67
     */
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    68
    public IndexOutOfBoundsException(int index) {
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    69
        super("Index out of range: " + index);
7e1bb9268b8a 8135248: Add utility methods to check indexes and ranges
psandoz
parents: 25859
diff changeset
    70
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
}