-
- All Known Subinterfaces:
- Name
- All Known Implementing Classes:
- CharBuffer, Segment, String, StringBuffer, StringBuilder
public interface CharSequence
A CharSequence is a readable sequence ofchar
values. This interface provides uniform, read-only access to many different kinds ofchar
sequences. Achar
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
andhashCode
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
Methods Modifier and Type Method and Description char
charAt(int index)
Returns thechar
value at the specified index.int
length()
Returns the length of this character sequence.CharSequence
subSequence(int start, int end)
Returns a newCharSequence
that is a subsequence of this sequence.String
toString()
Returns a string containing the characters in this sequence in the same order as this sequence.
-
-
-
Method Detail
-
length
int length()
Returns the length of this character sequence. The length is the number of 16-bitchar
s in the sequence.- Returns:
- the number of
char
s in this sequence
-
charAt
char charAt(int index)
Returns thechar
value at the specified index. An index ranges from zero to length() - 1. The firstchar
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 thechar
value to be returned- Returns:
- the specified
char
value - Throws:
IndexOutOfBoundsException
- if the index argument is negative or not less than length()
-
subSequence
CharSequence subSequence(int start, int end)
Returns a newCharSequence
that is a subsequence of this sequence. The subsequence starts with thechar
value at the specified index and ends with thechar
value at index end - 1. The length (inchar
s) of the returned sequence is end - start, so if start == end then an empty sequence is returned.- Parameters:
start
- the start index, inclusiveend
- the end index, exclusive- Returns:
- the specified subsequence
- Throws:
IndexOutOfBoundsException
- if start or end are negative, if end is greater than length(), or if start is greater than end
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/lang/CharSequence.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.