Implements abstract com.ibm.icu.text.BreakIterator.current.

Doc from com.ibm.icu.text.BreakIterator.current.

Return the iterator's current position.

Returns:int

The iterator's current position.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.first.

Doc from com.ibm.icu.text.BreakIterator.first.

Set the iterator to the first boundary position. This is always the beginning index of the text this iterator iterates over. For example, if the iterator iterates over a whole string, this function will always return 0.

Returns:int

The character offset of the beginning of the stretch of text being broken.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.following.

Doc from com.ibm.icu.text.BreakIterator.following.

Sets the iterator's current iteration position to be the first boundary position following the specified position. (Whether the specified position is itself a boundary position or not doesn't matter-- this function always moves the iteration position to the first boundary after the specified position.) If the specified position is the past-the-end position, returns DONE.

Parameters

offset:int

The character position to start searching from.

Returns:int

The position of the first boundary position following "offset" (whether or not "offset" itself is a boundary position), or DONE if "offset" is the past-the-end offset.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.getText.

Doc from com.ibm.icu.text.BreakIterator.getText.

Returns a CharacterIterator over the text being analyzed.

The returned CharacterIterator is a reference to the actual iterator being used by the BreakIterator. No guarantees are made about the current position of this iterator when it is returned; it may differ from the BreakIterators current position. If you need to move that position to examine the text, clone this function's return value first.

Returns:CharacterIterator

A CharacterIterator over the text being analyzed.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.last.

Doc from com.ibm.icu.text.BreakIterator.last.

Set the iterator to the last boundary position. This is always the "past-the-end" index of the text this iterator iterates over. For example, if the iterator iterates over a whole string (call it "text"), this function will always return text.length().

Returns:int

The character offset of the end of the stretch of text being broken.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.next.

Doc from com.ibm.icu.text.BreakIterator.next.

Move the iterator by the specified number of steps in the text. A positive number moves the iterator forward; a negative number moves the iterator backwards. If this causes the iterator to move off either end of the text, this function returns DONE; otherwise, this function returns the position of the appropriate boundary. Calling this function is equivalent to calling next() or previous() n times.

Parameters

n:int

The number of boundaries to advance over (if positive, moves forward; if negative, moves backwards).

Returns:int

The position of the boundary n boundaries from the current iteration position, or DONE if moving n boundaries causes the iterator to advance off either end of the text.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.next.

Doc from com.ibm.icu.text.BreakIterator.next.

Advances the iterator forward one boundary. The current iteration position is updated to point to the next boundary position after the current position, and this is also the value that is returned. If the current position is equal to the value returned by last(), or to DONE, this function returns DONE and sets the current position to DONE.

Returns:int

The position of the first boundary position following the iteration position.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.previous.

Doc from com.ibm.icu.text.BreakIterator.previous.

Move the iterator backward one boundary. The current iteration position is updated to point to the last boundary position before the current position, and this is also the value that is returned. If the current position is equal to the value returned by first(), or to DONE, this function returns DONE and sets the current position to DONE.

Returns:int

The position of the last boundary position preceding the iteration position.

Annotations

@Override

Implements abstract com.ibm.icu.text.BreakIterator.setText.

Doc from com.ibm.icu.text.BreakIterator.setText.

Sets the iterator to analyze a new piece of text. This function resets the current iteration position to the beginning of the text. (The old iterator is dropped.)

Parameters

newText:CharacterIterator

A CharacterIterator referring to the text to analyze with this BreakIterator (the iterator's current position is ignored, but its other state is significant).

Annotations

@Override

Overrides com.ibm.icu.text.BreakIterator.setText.

Doc from com.ibm.icu.text.BreakIterator.setText.

Sets the iterator to analyze a new piece of text. The new piece of text is passed in as a CharSequence, and the current iteration position is reset to the beginning of the text. (The old text is dropped.)

The text underlying the CharSequence must not be be modified while the BreakIterator holds a references to it. (As could possibly occur with a StringBuilder, for example).

Parameters

newText:CharSequence

A CharSequence containing the text to analyze with this BreakIterator.

Annotations

@Override

Overrides com.ibm.icu.text.BreakIterator.setText.

Doc from com.ibm.icu.text.BreakIterator.setText.

Sets the iterator to analyze a new piece of text. The new piece of text is passed in as a String, and the current iteration position is reset to the beginning of the string. (The old text is dropped.)

Parameters

newText:String

A String containing the text to analyze with this BreakIterator.

Annotations

@Override