1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package java.lang;
19
20/**
21 * Thrown when the an array is indexed with a value less than zero, or greater
22 * than or equal to the size of the array.
23 */
24public class ArrayIndexOutOfBoundsException extends IndexOutOfBoundsException {
25
26    private static final long serialVersionUID = -5116101128118950844L;
27
28    /**
29     * Constructs a new {@code ArrayIndexOutOfBoundsException} that includes the
30     * current stack trace.
31     */
32    public ArrayIndexOutOfBoundsException() {
33    }
34
35    /**
36     * Constructs a new {@code ArrayIndexOutOfBoundsException} with the current
37     * stack trace and a detail message that is based on the specified invalid
38     * {@code index}.
39     *
40     * @param index
41     *            the invalid index.
42     */
43    public ArrayIndexOutOfBoundsException(int index) {
44        super("index=" + index);
45    }
46
47    /**
48     * Constructs a new {@code ArrayIndexOutOfBoundsException} with the current
49     * stack trace and the specified detail message.
50     *
51     * @param detailMessage
52     *            the detail message for this exception.
53     */
54    public ArrayIndexOutOfBoundsException(String detailMessage) {
55        super(detailMessage);
56    }
57
58    /**
59     * Used internally for consistent high-quality error reporting.
60     * @hide
61     */
62    public ArrayIndexOutOfBoundsException(int sourceLength, int index) {
63        super("length=" + sourceLength + "; index=" + index);
64    }
65
66    /**
67     * Used internally for consistent high-quality error reporting.
68     * @hide
69     */
70    public ArrayIndexOutOfBoundsException(int sourceLength, int offset,
71            int count) {
72        super("length=" + sourceLength + "; regionStart=" + offset
73                + "; regionLength=" + count);
74    }
75}
76