src/share/classes/java/lang/StringIndexOutOfBoundsException.java

Print this page
rev 6294 : 8005118: Javadoc styles are inconsistent
Summary: use a common javadoc style in the String classes
Reviewed-by: darcy
   1 /*
   2  * Copyright (c) 1994, 2008, 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</code> methods to indicate that an index
  30  * is either negative or greater than the size of the string.  For
  31  * some methods such as the charAt method, this exception also is
  32  * thrown when the index is equal to the size of the string.
  33  *
  34  * @author  unascribed
  35  * @see     java.lang.String#charAt(int)
  36  * @since   JDK1.0
  37  */
  38 public
  39 class StringIndexOutOfBoundsException extends IndexOutOfBoundsException {
  40     private static final long serialVersionUID = -6762910422159637258L;
  41 
  42     /**
  43      * Constructs a <code>StringIndexOutOfBoundsException</code> with no
  44      * detail message.
  45      *
  46      * @since   JDK1.0.
  47      */
  48     public StringIndexOutOfBoundsException() {
  49         super();
  50     }
  51 
  52     /**
  53      * Constructs a <code>StringIndexOutOfBoundsException</code> with
  54      * the specified detail message.
  55      *
  56      * @param   s   the detail message.
  57      */
  58     public StringIndexOutOfBoundsException(String s) {
  59         super(s);
  60     }
  61 
  62     /**
  63      * Constructs a new <code>StringIndexOutOfBoundsException</code>
  64      * class with an argument indicating the illegal index.
  65      *
  66      * @param   index   the illegal index.
  67      */
  68     public StringIndexOutOfBoundsException(int index) {
  69         super("String index out of range: " + index);
  70     }
  71 }
   1 /*
   2  * Copyright (c) 1994, 2012, 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
  30  * is either negative or greater than the size of the string.  For
  31  * some methods such as the charAt method, this exception also is
  32  * thrown when the index is equal to the size of the string.
  33  *
  34  * @author  unascribed
  35  * @see     java.lang.String#charAt(int)
  36  * @since   JDK1.0
  37  */
  38 public
  39 class StringIndexOutOfBoundsException extends IndexOutOfBoundsException {
  40     private static final long serialVersionUID = -6762910422159637258L;
  41 
  42     /**
  43      * Constructs a {@code StringIndexOutOfBoundsException} with no
  44      * detail message.
  45      *
  46      * @since   JDK1.0.
  47      */
  48     public StringIndexOutOfBoundsException() {
  49         super();
  50     }
  51 
  52     /**
  53      * Constructs a {@code StringIndexOutOfBoundsException} with
  54      * the specified detail message.
  55      *
  56      * @param   s   the detail message.
  57      */
  58     public StringIndexOutOfBoundsException(String s) {
  59         super(s);
  60     }
  61 
  62     /**
  63      * Constructs a new {@code StringIndexOutOfBoundsException}
  64      * class with an argument indicating the illegal index.
  65      *
  66      * @param   index   the illegal index.
  67      */
  68     public StringIndexOutOfBoundsException(int index) {
  69         super("String index out of range: " + index);
  70     }
  71 }