java.lang
Interface CharSequence

All Known Implementing Classes:
CharBuffer sample code for java.nio.CharBuffer definition code for java.nio.CharBuffer , String sample code for java.lang.String definition code for java.lang.String , StringBuffer sample code for java.lang.StringBuffer definition code for java.lang.StringBuffer , StringBuilder sample code for java.lang.StringBuilder definition code for java.lang.StringBuilder

public interface CharSequence

A CharSequence is a readable sequence of char values. This interface provides uniform, read-only access to many different kinds of char sequences. A char value represents a character in the Basic Multilingual Plane (BMP) or a surrogate. Refer to Unicode Character Representation for details.

This interface does not refine the general contracts of the equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) and hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() methods. The result of comparing two objects that implement CharSequence is therefore, in general, undefined. Each object may be implemented by a different class, and there is no guarantee that each class will be capable of testing its instances for equality with those of the other. It is therefore inappropriate to use arbitrary CharSequence instances as elements in a set or as keys in a map.

Since:
1.4

Method Summary
 char charAt sample code for java.lang.CharSequence.charAt(int) definition code for java.lang.CharSequence.charAt(int) (int index)
          Returns the char value at the specified index.
 int length sample code for java.lang.CharSequence.length() definition code for java.lang.CharSequence.length() ()
          Returns the length of this character sequence.
 CharSequence sample code for java.lang.CharSequence definition code for java.lang.CharSequence subSequence sample code for java.lang.CharSequence.subSequence(int, int) definition code for java.lang.CharSequence.subSequence(int, int) (int start, int end)
          Returns a new CharSequence that is a subsequence of this sequence.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.lang.CharSequence.toString() definition code for java.lang.CharSequence.toString() ()
          Returns a string containing the characters in this sequence in the same order as this sequence.
 

Method Detail

length sample code for java.lang.CharSequence.length() definition code for java.lang.CharSequence.length()

int length()
Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:
the number of chars in this sequence

charAt sample code for java.lang.CharSequence.charAt(int) definition code for java.lang.CharSequence.charAt(int)

char charAt(int index)
Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters:
index - the index of the char value to be returned
Returns:
the specified char value
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if the index argument is negative or not less than length()

subSequence sample code for java.lang.CharSequence.subSequence(int, int) definition code for java.lang.CharSequence.subSequence(int, int)

CharSequence sample code for java.lang.CharSequence definition code for java.lang.CharSequence  subSequence(int start,
                         int end)
Returns a new CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters:
start - the start index, inclusive
end - the end index, exclusive
Returns:
the specified subsequence
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if start or end are negative, if end is greater than length(), or if start is greater than end

toString sample code for java.lang.CharSequence.toString() definition code for java.lang.CharSequence.toString()

String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string consisting of exactly this sequence of characters