1 /*
   2  * Copyright (c) 1994, 2015, 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 by {@code String} methods to indicate that an index is either negative
  30  * or greater than the size of the string.  For some methods such as the
  31  * {@link String#charAt charAt} method, this exception also is thrown when the
  32  * index is equal to the size of the string.
  33  *
  34  * @see java.lang.String#charAt(int)
  35  * @since 1.0
  36  */
  37 public class StringIndexOutOfBoundsException extends IndexOutOfBoundsException {
  38     private static final long serialVersionUID = -6762910422159637258L;
  39 
  40     /**
  41      * Constructs a {@code StringIndexOutOfBoundsException} with no detail
  42      * message.
  43      */
  44     public StringIndexOutOfBoundsException() {
  45         super();
  46     }
  47 
  48     /**
  49      * Constructs a {@code StringIndexOutOfBoundsException} with the specified
  50      * detail message.
  51      *
  52      * @param s the detail message.
  53      */
  54     public StringIndexOutOfBoundsException(String s) {
  55         super(s);
  56     }
  57 
  58     /**
  59      * Constructs a new {@code StringIndexOutOfBoundsException} 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      */
  67     public StringIndexOutOfBoundsException(int index) {
  68         super("String index out of range: " + index);
  69     }
  70 }