Class CaseMapImpl.WholeStringBreakIterator
- All Implemented Interfaces:
Cloneable
- Enclosing class:
- CaseMapImpl
-
Field Summary
FieldsFields inherited from class com.ibm.icu.text.BreakIterator
DONE, KIND_CHARACTER, KIND_LINE, KIND_SENTENCE, KIND_TITLE, KIND_WORD, WORD_IDEO, WORD_IDEO_LIMIT, WORD_KANA, WORD_KANA_LIMIT, WORD_LETTER, WORD_LETTER_LIMIT, WORD_NONE, WORD_NONE_LIMIT, WORD_NUMBER, WORD_NUMBER_LIMIT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
current()
Return the iterator's current position.int
first()
Set the iterator to the first boundary position.int
following
(int offset) Sets the iterator's current iteration position to be the first boundary position following the specified position.getText()
Returns a CharacterIterator over the text being analyzed.int
last()
Set the iterator to the last boundary position.int
next()
Advances the iterator forward one boundary.int
next
(int n) Move the iterator by the specified number of steps in the text.private static void
int
previous()
Move the iterator backward one boundary.void
setText
(CharSequence newText) Sets the iterator to analyze a new piece of text.void
Sets the iterator to analyze a new piece of text.void
setText
(CharacterIterator newText) Sets the iterator to analyze a new piece of text.Methods inherited from class com.ibm.icu.text.BreakIterator
clone, getAvailableLocales, getAvailableULocales, getBreakInstance, getCharacterInstance, getCharacterInstance, getCharacterInstance, getLineInstance, getLineInstance, getLineInstance, getLocale, getRuleStatus, getRuleStatusVec, getSentenceInstance, getSentenceInstance, getSentenceInstance, getTitleInstance, getTitleInstance, getTitleInstance, getWordInstance, getWordInstance, getWordInstance, isBoundary, preceding, registerInstance, registerInstance, unregister
-
Field Details
-
length
private int length
-
-
Constructor Details
-
WholeStringBreakIterator
private WholeStringBreakIterator()
-
-
Method Details
-
notImplemented
private static void notImplemented() -
first
public int first()Description copied from class:BreakIterator
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.- Specified by:
first
in classBreakIterator
- Returns:
- The character offset of the beginning of the stretch of text being broken.
-
last
public int last()Description copied from class:BreakIterator
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().- Specified by:
last
in classBreakIterator
- Returns:
- The character offset of the end of the stretch of text being broken.
-
next
public int next(int n) Description copied from class:BreakIterator
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.- Specified by:
next
in classBreakIterator
- Parameters:
n
- The number of boundaries to advance over (if positive, moves forward; if negative, moves backwards).- Returns:
- 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.
-
next
public int next()Description copied from class:BreakIterator
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.- Specified by:
next
in classBreakIterator
- Returns:
- The position of the first boundary position following the iteration position.
-
previous
public int previous()Description copied from class:BreakIterator
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.- Specified by:
previous
in classBreakIterator
- Returns:
- The position of the last boundary position preceding the iteration position.
-
following
public int following(int offset) Description copied from class:BreakIterator
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.- Specified by:
following
in classBreakIterator
- Parameters:
offset
- The character position to start searching from.- Returns:
- 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.
-
current
public int current()Description copied from class:BreakIterator
Return the iterator's current position.- Specified by:
current
in classBreakIterator
- Returns:
- The iterator's current position.
-
getText
Description copied from class:BreakIterator
Returns a CharacterIterator over the text being analyzed.Caution:The state of the returned CharacterIterator must not be modified in any way while the BreakIterator is still in use. Doing so will lead to undefined behavior of the BreakIterator. Clone the returned CharacterIterator first and work with that.
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.
- Specified by:
getText
in classBreakIterator
- Returns:
- A CharacterIterator over the text being analyzed.
-
setText
Description copied from class:BreakIterator
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.)Caution: The supplied CharacterIterator is used directly by the BreakIterator, and must not be altered in any way by code outside of the BreakIterator. Doing so will lead to undefined behavior of the BreakIterator.
- Specified by:
setText
in classBreakIterator
- Parameters:
newText
- A CharacterIterator referring to the text to analyze with this BreakIterator (the iterator's current position is ignored, but its other state is significant).
-
setText
Description copied from class:BreakIterator
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).
- Overrides:
setText
in classBreakIterator
- Parameters:
newText
- A CharSequence containing the text to analyze with this BreakIterator.
-
setText
Description copied from class:BreakIterator
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.)- Overrides:
setText
in classBreakIterator
- Parameters:
newText
- A String containing the text to analyze with this BreakIterator.
-