CharSequence
, Cloneable
, CharacterIterator
public class Segment extends Object implements Cloneable, CharacterIterator, CharSequence
The Segment implements the java.text.CharacterIterator interface to support use with the i18n support without copying text into a string.
Modifier and Type | Field | Description |
---|---|---|
char[] |
array |
This is the array containing the text of
interest.
|
int |
count |
This is the number of array elements that
make up the text of interest.
|
int |
offset |
This is the offset into the array that
the desired text begins.
|
DONE
Constructor | Description |
---|---|
Segment() |
Creates a new segment.
|
Segment(char[] array,
int offset,
int count) |
Creates a new segment referring to an existing array.
|
Modifier and Type | Method | Description |
---|---|---|
char |
charAt(int index) |
Returns the
char value at the specified index. |
Object |
clone() |
Creates a shallow copy.
|
char |
current() |
Gets the character at the current position (as returned by getIndex()).
|
char |
first() |
Sets the position to getBeginIndex() and returns the character at that
position.
|
int |
getBeginIndex() |
Returns the start index of the text.
|
int |
getEndIndex() |
Returns the end index of the text.
|
int |
getIndex() |
Returns the current index.
|
boolean |
isPartialReturn() |
Flag to indicate that partial returns are valid.
|
char |
last() |
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty)
and returns the character at that position.
|
int |
length() |
Returns the length of this character sequence.
|
char |
next() |
Increments the iterator's index by one and returns the character
at the new index.
|
char |
previous() |
Decrements the iterator's index by one and returns the character
at the new index.
|
char |
setIndex(int position) |
Sets the position to the specified position in the text and returns that
character.
|
void |
setPartialReturn(boolean p) |
Flag to indicate that partial returns are valid.
|
CharSequence |
subSequence(int start,
int end) |
Returns a
CharSequence that is a subsequence of this sequence. |
String |
toString() |
Converts a segment into a String.
|
chars, codePoints
public char[] array
public int offset
public int count
public Segment()
public Segment(char[] array, int offset, int count)
array
- the array to refer tooffset
- the offset into the arraycount
- the number of characterspublic void setPartialReturn(boolean p)
p
- whether or not partial returns are valid.public boolean isPartialReturn()
public String toString()
toString
in interface CharSequence
toString
in class Object
public char first()
first
in interface CharacterIterator
getBeginIndex()
public char last()
last
in interface CharacterIterator
getEndIndex()
public char current()
current
in interface CharacterIterator
getIndex()
public char next()
next
in interface CharacterIterator
public char previous()
previous
in interface CharacterIterator
public char setIndex(int position)
setIndex
in interface CharacterIterator
position
- the position within the text. Valid values range from
getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown
if an invalid value is supplied.public int getBeginIndex()
getBeginIndex
in interface CharacterIterator
public int getEndIndex()
getEndIndex
in interface CharacterIterator
public int getIndex()
getIndex
in interface CharacterIterator
public char charAt(int index)
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.
charAt
in interface CharSequence
index
- the index of the char
value to be returnedchar
valuepublic int length()
char
s in the sequence.length
in interface CharSequence
char
s in this sequencepublic CharSequence subSequence(int start, int end)
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 char
s) of the
returned sequence is end - start
, so if start == end
then an empty sequence is returned.subSequence
in interface CharSequence
start
- the start index, inclusiveend
- the end index, exclusive Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps