UCharacterIterator
abstract class UCharacterIterator : Cloneable
| kotlin.Any | |
| ↳ | android.icu.text.UCharacterIterator |
Abstract class that defines an API for iteration on text objects.This is an interface for forward and backward iteration and random access into a text object. Forward iteration is done with post-increment and backward iteration is done with pre-decrement semantics, while the java.text.CharacterIterator interface methods provided forward iteration with "pre-increment" and backward iteration with pre-decrement semantics. This API is more efficient for forward iteration over code points. The other major difference is that this API can do both code unit and code point iteration, java.text.CharacterIterator can only iterate over code units and is limited to BMP (0 - 0xFFFF)
Summary
| Constants | |
|---|---|
| static Int |
Indicator that we have reached the ends of the UTF16 text. |
| Protected constructors | |
|---|---|
|
Protected default constructor for the subclasses |
|
| Public methods | |
|---|---|
| open Any |
clone()Creates a copy of this iterator, independent from other iterators. |
| abstract Int |
current()Returns the code unit at the current index. |
| open Int |
Returns the codepoint at the current index. |
| open CharacterIterator! |
Returns a |
| abstract Int |
getIndex()Gets the current index in text. |
| static UCharacterIterator! |
getInstance(source: Replaceable!)Returns a |
| static UCharacterIterator! |
getInstance(source: String!)Returns a |
| static UCharacterIterator! |
getInstance(source: CharArray!)Returns a |
| static UCharacterIterator! |
getInstance(source: CharArray!, start: Int, limit: Int)Returns a |
| static UCharacterIterator! |
getInstance(source: StringBuffer!)Returns a |
| static UCharacterIterator! |
getInstance(source: CharacterIterator!)Returns a |
| abstract Int |
Returns the length of the text |
| abstract Int |
Fills the buffer with the underlying text storage of the iterator If the buffer capacity is not enough a exception is thrown. |
| Int |
Convenience override for |
| open String! |
getText()Convenience method for returning the underlying text storage as as string |
| open Int |
moveCodePointIndex(delta: Int)Moves the current position by the number of code points specified, either forward or backward depending on the sign of delta (positive or negative respectively). |
| open Int |
Moves the current position by the number of code units specified, either forward or backward depending on the sign of delta (positive or negative respectively). |
| abstract Int |
next()Returns the UTF16 code unit at index, and increments to the next code unit (post-increment semantics). |
| open Int |
Returns the code point at index, and increments to the next code point (post-increment semantics). |
| abstract Int |
previous()Decrement to the position of the previous code unit in the text, and return it (pre-decrement semantics). |
| open Int |
Retreat to the start of the previous code point in the text, and return it (pre-decrement semantics). |
| abstract Unit |
Sets the index to the specified index in the text. |
| open Unit |
Sets the current index to the limit. |
| open Unit |
Sets the current index to the start. |
Constants
DONE
static val DONE: Int
Indicator that we have reached the ends of the UTF16 text.
Value: -1
Protected constructors
UCharacterIterator
protected UCharacterIterator()
Protected default constructor for the subclasses
Public methods
clone
open fun clone(): Any
Creates a copy of this iterator, independent from other iterators. If it is not possible to clone the iterator, returns null.
| Return | |
|---|---|
Any |
copy of this iterator |
| Exceptions | |
|---|---|
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
current
abstract fun current(): Int
Returns the code unit at the current index. If index is out of range, returns DONE. Index is not changed.
| Return | |
|---|---|
Int |
current code unit |
currentCodePoint
open fun currentCodePoint(): Int
Returns the codepoint at the current index. If the current index is invalid, DONE is returned. If the current index points to a lead surrogate, and there is a following trail surrogate, then the code point is returned. Otherwise, the code unit at index is returned. Index is not changed.
| Return | |
|---|---|
Int |
current codepoint |
getCharacterIterator
open fun getCharacterIterator(): CharacterIterator!
Returns a java.text.CharacterIterator object for the underlying text of this iterator. The returned iterator is independent of this iterator.
| Return | |
|---|---|
CharacterIterator! |
java.text.CharacterIterator object |
getIndex
abstract fun getIndex(): Int
Gets the current index in text.
| Return | |
|---|---|
Int |
current index in text. |
getInstance
static fun getInstance(source: Replaceable!): UCharacterIterator!
Returns a UCharacterIterator object given a Replaceable object.
| Parameters | |
|---|---|
source |
Replaceable!: a valid source as a Replaceable object |
| Return | |
|---|---|
UCharacterIterator! |
UCharacterIterator object |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the argument is null |
getInstance
static fun getInstance(source: String!): UCharacterIterator!
Returns a UCharacterIterator object given a source string.
| Parameters | |
|---|---|
source |
String!: a string |
| Return | |
|---|---|
UCharacterIterator! |
UCharacterIterator object |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the argument is null |
getInstance
static fun getInstance(source: CharArray!): UCharacterIterator!
Returns a UCharacterIterator object given a source character array.
| Parameters | |
|---|---|
source |
CharArray!: an array of UTF-16 code units |
| Return | |
|---|---|
UCharacterIterator! |
UCharacterIterator object |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the argument is null |
getInstance
static fun getInstance(
source: CharArray!,
start: Int,
limit: Int
): UCharacterIterator!
Returns a UCharacterIterator object given a source character array.
| Parameters | |
|---|---|
source |
CharArray!: an array of UTF-16 code units |
| Return | |
|---|---|
UCharacterIterator! |
UCharacterIterator object |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the argument is null |
getInstance
static fun getInstance(source: StringBuffer!): UCharacterIterator!
Returns a UCharacterIterator object given a source StringBuffer.
| Parameters | |
|---|---|
source |
StringBuffer!: an string buffer of UTF-16 code units |
| Return | |
|---|---|
UCharacterIterator! |
UCharacterIterator object |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the argument is null |
getInstance
static fun getInstance(source: CharacterIterator!): UCharacterIterator!
Returns a UCharacterIterator object given a CharacterIterator.
| Parameters | |
|---|---|
source |
CharacterIterator!: a valid CharacterIterator object. |
| Return | |
|---|---|
UCharacterIterator! |
UCharacterIterator object |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the argument is null |
getLength
abstract fun getLength(): Int
Returns the length of the text
| Return | |
|---|---|
Int |
length of the text |
getText
abstract fun getText(
fillIn: CharArray!,
offset: Int
): Int
Fills the buffer with the underlying text storage of the iterator If the buffer capacity is not enough a exception is thrown. The capacity of the fill in buffer should at least be equal to length of text in the iterator obtained by calling getLength()). Usage:
UChacterIterator iter = new UCharacterIterator.getInstance(text);
char[] buf = new char[iter.getLength()];
iter.getText(buf);
OR
char[] buf= new char[1];
int len = 0;
for(;;){
try{
len = iter.getText(buf);
break;
}catch(IndexOutOfBoundsException e){
buf = new char[iter.getLength()];
}
}
| Parameters | |
|---|---|
fillIn |
CharArray!: an array of chars to fill with the underlying UTF-16 code units. |
offset |
Int: the position within the array to start putting the data. |
| Return | |
|---|---|
Int |
the number of code units added to fillIn, as a convenience |
| Exceptions | |
|---|---|
java.lang.IndexOutOfBoundsException |
exception if there is not enough room after offset in the array, or if offset < 0. |
getText
fun getText(fillIn: CharArray!): Int
Convenience override for getText(char[], int) that provides an offset of 0.
| Parameters | |
|---|---|
fillIn |
CharArray!: an array of chars to fill with the underlying UTF-16 code units. |
| Return | |
|---|---|
Int |
the number of code units added to fillIn, as a convenience |
| Exceptions | |
|---|---|
java.lang.IndexOutOfBoundsException |
exception if there is not enough room in the array. |
getText
open fun getText(): String!
Convenience method for returning the underlying text storage as as string
| Return | |
|---|---|
String! |
the underlying text storage in the iterator as a string |
moveCodePointIndex
open fun moveCodePointIndex(delta: Int): Int
Moves the current position by the number of code points specified, either forward or backward depending on the sign of delta (positive or negative respectively). If the current index is at a trail surrogate then the first adjustment is by code unit, and the remaining adjustments are by code points. If the resulting index would be less than zero, the index is set to zero, and if the resulting index would be greater than limit, the index is set to limit.
| Parameters | |
|---|---|
delta |
Int: the number of code units to move the current index. |
| Return | |
|---|---|
Int |
the new index |
| Exceptions | |
|---|---|
java.lang.IndexOutOfBoundsException |
is thrown if an invalid delta is supplied |
moveIndex
open fun moveIndex(delta: Int): Int
Moves the current position by the number of code units specified, either forward or backward depending on the sign of delta (positive or negative respectively). If the resulting index would be less than zero, the index is set to zero, and if the resulting index would be greater than limit, the index is set to limit.
| Parameters | |
|---|---|
delta |
Int: the number of code units to move the current index. |
| Return | |
|---|---|
Int |
the new index. |
| Exceptions | |
|---|---|
java.lang.IndexOutOfBoundsException |
is thrown if an invalid index is supplied |
next
abstract fun next(): Int
Returns the UTF16 code unit at index, and increments to the next code unit (post-increment semantics). If index is out of range, DONE is returned, and the iterator is reset to the limit of the text.
| Return | |
|---|---|
Int |
the next UTF16 code unit, or DONE if the index is at the limit of the text. |
nextCodePoint
open fun nextCodePoint(): Int
Returns the code point at index, and increments to the next code point (post-increment semantics). If index does not point to a valid surrogate pair, the behavior is the same as next(). Otherwise the iterator is incremented past the surrogate pair, and the code point represented by the pair is returned.
| Return | |
|---|---|
Int |
the next codepoint in text, or DONE if the index is at the limit of the text. |
previous
abstract fun previous(): Int
Decrement to the position of the previous code unit in the text, and return it (pre-decrement semantics). If the resulting index is less than 0, the index is reset to 0 and DONE is returned.
| Return | |
|---|---|
Int |
the previous code unit in the text, or DONE if the new index is before the start of the text. |
previousCodePoint
open fun previousCodePoint(): Int
Retreat to the start of the previous code point in the text, and return it (pre-decrement semantics). If the index is not preceded by a valid surrogate pair, the behavior is the same as previous(). Otherwise the iterator is decremented to the start of the surrogate pair, and the code point represented by the pair is returned.
| Return | |
|---|---|
Int |
the previous code point in the text, or DONE if the new index is before the start of the text. |
setIndex
abstract fun setIndex(index: Int): Unit
Sets the index to the specified index in the text.
| Parameters | |
|---|---|
index |
Int: the index within the text. |
| Exceptions | |
|---|---|
java.lang.IndexOutOfBoundsException |
is thrown if an invalid index is supplied |