1 /*
2  * Copyright (c) 1995, 2020, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package java.lang;
27 
28 /**
29  * Thrown to indicate that an index of some sort (such as to an array, to a
30  * string, or to a vector) is out of range.
31  * <p>
32  * Applications can subclass this class to indicate similar exceptions.
33  *
34  * @author Frank Yellin
35  * @since 1.0
36  */
37 public class IndexOutOfBoundsException extends RuntimeException {
38     @java.io.Serial
39     private static final long serialVersionUID = 234122996006267687L;
40 
41     /**
42      * Constructs an {@code IndexOutOfBoundsException} with no detail message.
43      */
IndexOutOfBoundsException()44     public IndexOutOfBoundsException() {
45         super();
46     }
47 
48     /**
49      * Constructs an {@code IndexOutOfBoundsException} with the specified detail
50      * message.
51      *
52      * @param s the detail message
53      */
IndexOutOfBoundsException(String s)54     public IndexOutOfBoundsException(String s) {
55         super(s);
56     }
57 
58     /**
59      * Constructs a new {@code IndexOutOfBoundsException} class with an
60      * argument indicating the illegal index.
61      *
62      * <p>The index is included in this exception's detail message.  The
63      * exact presentation format of the detail message is unspecified.
64      *
65      * @param index the illegal index.
66      * @since 9
67      */
IndexOutOfBoundsException(int index)68     public IndexOutOfBoundsException(int index) {
69         super("Index out of range: " + index);
70     }
71 
72     /**
73      * Constructs a new {@code IndexOutOfBoundsException} class with an
74      * argument indicating the illegal index.
75      *
76      * <p>The index is included in this exception's detail message.  The
77      * exact presentation format of the detail message is unspecified.
78      *
79      * @param index the illegal index.
80      * @since 16
81      */
IndexOutOfBoundsException(long index)82     public IndexOutOfBoundsException(long index) {
83         super("Index out of range: " + index);
84     }
85 }
86