com.ibm.icu.impl

Class SimpleFilteredSentenceBreakIterator

java.lang.Object

com.ibm.icu.text.BreakIterator

com.ibm.icu.impl.SimpleFilteredSentenceBreakIterator

All Implemented Interfaces:

Cloneable

public class SimpleFilteredSentenceBreakIterator
extends BreakIterator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleFilteredSentenceBreakIterator.Builder

Field Summary

Fields 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

Constructor and Description
SimpleFilteredSentenceBreakIterator(BreakIterator adoptBreakIterator, CharsTrie forwardsPartialTrie, CharsTrie backwardsTrie)

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone method.
int	current() Return the iterator's current position.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
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.
CharacterIterator	getText() Returns a CharacterIterator over the text being analyzed.
int	hashCode() Returns an integer hash code for this object.
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.
int	preceding(int offset) Sets the iterator's current iteration position to be the last boundary position preceding the specified position.
int	previous() Move the iterator backward one boundary.
void	setText(CharacterIterator newText) Sets the iterator to analyze a new piece of text.

Methods inherited from class com.ibm.icu.text.BreakIterator

getAvailableLocales, getAvailableULocales, getBreakInstance, getCharacterInstance, getCharacterInstance, getCharacterInstance, getLineInstance, getLineInstance, getLineInstance, getLocale, getRuleStatus, getRuleStatusVec, getSentenceInstance, getSentenceInstance, getSentenceInstance, getTitleInstance, getTitleInstance, getTitleInstance, getWordInstance, getWordInstance, getWordInstance, isBoundary, registerInstance, registerInstance, setText, unregister

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleFilteredSentenceBreakIterator

public SimpleFilteredSentenceBreakIterator(BreakIterator adoptBreakIterator,
                                           CharsTrie forwardsPartialTrie,
                                           CharsTrie backwardsTrie)

Parameters:

adoptBreakIterator - break iterator to adopt

forwardsPartialTrie - forward & partial char trie to adopt

backwardsTrie - backward trie to adopt

Method Detail

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 class BreakIterator

Returns:

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

equals

public boolean equals(Object obj)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

clone

public Object clone()

Description copied from class: BreakIterator

Clone method. Creates another BreakIterator with the same behavior and current state as this one.

Overrides:

clone in class BreakIterator

Returns:

The clone.

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 class BreakIterator

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 class BreakIterator

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 class BreakIterator

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.

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 class BreakIterator

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 class BreakIterator

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 class BreakIterator

Returns:

The iterator's current position.

preceding

public int preceding(int offset)

Description copied from class: BreakIterator

Sets the iterator's current iteration position to be the last boundary position preceding 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 last boundary before the specified position.) If the specified position is the starting position, returns DONE.

Overrides:

preceding in class BreakIterator

Parameters:

offset - The character position to start searching from.

Returns:

The position of the last boundary position preceding "offset" (whether of not "offset" itself is a boundary position), or DONE if "offset" is the starting offset of the iterator.

getText

public CharacterIterator getText()

Description copied from class: BreakIterator

Returns a CharacterIterator over the text being analyzed. For at least some subclasses of BreakIterator, this is a reference to the actual iterator being used by the BreakIterator, and therefore, this function's return value should be treated as const. No guarantees are made about the current position of this iterator when it is returned. If you need to move that position to examine the text, clone this function's return value first.

Specified by:

getText in class BreakIterator

Returns:

A CharacterIterator over the text being analyzed.

setText

public void setText(CharacterIterator newText)

Description copied from class: BreakIterator

Sets the iterator to analyze a new piece of text. The BreakIterator is passed a CharacterIterator through which it will access the text itself. The current iteration position is reset to the CharacterIterator's start index. (The old iterator is dropped.)

Specified by:

setText in class BreakIterator

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).