diff options
Diffstat (limited to 'libjava/java/lang')
| -rw-r--r-- | libjava/java/lang/CharSequence.java | 80 | ||||
| -rw-r--r-- | libjava/java/lang/String.java | 24 | ||||
| -rw-r--r-- | libjava/java/lang/StringBuffer.java | 65 |
3 files changed, 152 insertions, 17 deletions
diff --git a/libjava/java/lang/CharSequence.java b/libjava/java/lang/CharSequence.java new file mode 100644 index 0000000..8ba677e --- /dev/null +++ b/libjava/java/lang/CharSequence.java @@ -0,0 +1,80 @@ +/* java.lang.CharSequence -- Anything that has an indexed sequence of chars + Copyright (C) 2001 Free Software Foundation, Inc. + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ + + +package java.lang; + +/** + * General functions on a sequence of chars. This interface is implemented + * by <code>String</code>, <code>StringBuffer</code> and + * <code>CharBuffer</code> to give a uniform way to get chars at a certain + * index, the number of characters in the sequence and a subrange of the + * chars. Indexes start at 0 and the last index is <code>length()-1</code>. + * <p> + * Even when classes implement this interface they are not always + * exchangeble because they might implement their compare, equals or hash + * function differently. This means that in general one should not use a + * <code>CharSequence</code> as keys in collections since two sequences + * with the same chars at the same indexes with the same length might not + * have the same hash code, be equal or be comparable since the are + * represented by different classes. + * + * @author Mark Wielaard (mark@klomp.org) + * + * @since 1.4 + */ + +public interface CharSequence { + + /** + * Returns the character at the given index. + * + * @exception IndexOutOfBoundsException when <code>i < 0</code> or + * <code>i > length()-1</code>. + */ + char charAt(int i); + + /** + * Returns the length of the sequence. + */ + int length(); + + /** + * Returns a new <code>CharSequence</char> of the indicated range. + * + * @exception IndexOutOfBoundsException when <code>begin < 0</code>, + * <code>end < 0</code>, <code>end > length()</code> or + * <code>begin > end</code> + */ + CharSequence subSequence(int begin, int end); + + /** + * Returns the complete <code>CharSequence</code> as a <code>String</code>. + * Classes that implement this interface should return a <code>String</code> + * which contains only the characters in the sequence in the correct order. + */ + String toString(); +} diff --git a/libjava/java/lang/String.java b/libjava/java/lang/String.java index bed3171..8dadfb5 100644 --- a/libjava/java/lang/String.java +++ b/libjava/java/lang/String.java @@ -22,7 +22,7 @@ import java.util.Locale; * Status: Complete to 1.3. */ -public final class String implements Serializable, Comparable +public final class String implements Serializable, Comparable, CharSequence { private Object data; private int boffset; // Note this is a byte offset - don't use in Java code! @@ -297,6 +297,28 @@ public final class String implements Serializable, Comparable } } + /** + * Creates a substring of this String, starting at a specified index + * and ending at one character before a specified index. + * <p> + * To implement <code>CharSequence</code>. + * Calls <code>substring(beginIndex, endIndex)</code>. + * + * @param beginIndex index to start substring (base 0) + * @param endIndex index after the last character to be + * copied into the substring + * + * @return new String which is a substring of this String + * + * @exception StringIndexOutOfBoundsException + * if (beginIndex < 0 || endIndex > this.length() || beginIndex > endIndex) + */ + public CharSequence subSequence(int beginIndex, int endIndex) + throws IndexOutOfBoundsException + { + return substring(beginIndex, endIndex); + } + public String substring (int beginIndex) { return substring (beginIndex, count); diff --git a/libjava/java/lang/StringBuffer.java b/libjava/java/lang/StringBuffer.java index 211574a..38978b1 100644 --- a/libjava/java/lang/StringBuffer.java +++ b/libjava/java/lang/StringBuffer.java @@ -1,21 +1,32 @@ -// StringBuffer.java - Growable strings. - -/* Copyright (C) 1998, 1999, 2000 Free Software Foundation - - This file is part of libgcj. - -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -details. */ +/* StringBuffer.java -- Growable strings + Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc. + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ package java.lang; import java.io.Serializable; -/** - * @author Tom Tromey <tromey@cygnus.com> - * @date October 23, 1998. - */ - /* Written using "Java Class Libraries", 2nd edition, ISBN 0-201-31002-3 * Updated using online JDK 1.2 docs. * Believed complete and correct to JDK 1.2. @@ -57,7 +68,7 @@ import java.io.Serializable; * @author Tom Tromey * @see java.lang.String */ -public final class StringBuffer implements Serializable +public final class StringBuffer implements Serializable, CharSequence { /** Append the <code>String</code> value of the argument to this <code>StringBuffer</code>. * Uses <code>String.valueOf()</code> to convert to @@ -198,7 +209,7 @@ public final class StringBuffer implements Serializable * @param index the index of the character to get, starting at 0. * @return the character at the specified index. * @exception IndexOutOfBoundsException if the desired character index - * is not between 0 and length() - 1 (inclusive). + * is negative or greater then length() - 1. */ public synchronized char charAt (int index) { @@ -653,6 +664,28 @@ public final class StringBuffer implements Serializable return new String (value, beginIndex, endIndex - beginIndex); } + /** + * Creates a substring of this StringBuffer, starting at a specified index + * and ending at one character before a specified index. + * <p> + * To implement <code>CharSequence</code>. + * Calls <code>substring(beginIndex, endIndex)</code>. + * + * @param beginIndex index to start substring (base 0) + * @param endIndex index after the last character to be + * copied into the substring + * + * @return new String which is a substring of this StringBuffer + * + * @exception StringIndexOutOfBoundsException + * if (beginIndex < 0 || endIndex > this.length() || beginIndex > endIndex) + */ + public CharSequence subSequence (int beginIndex, int endIndex) + { + return substring(beginIndex, endIndex); + } + + /** Convert this <code>StringBuffer</code> to a <code>String</code>. * @return the characters in this StringBuffer */ |