WordSegmentFinder


public class WordSegmentFinder
extends SegmentFinder

java.lang.Object
   ↳ android.text.SegmentFinder
     ↳ android.text.WordSegmentFinder


Implementation of SegmentFinder using words as the text segment. Word boundaries are found using WordIterator. Whitespace characters are excluded, so they are not included in any text segments.

For example, the text "Hello, World!" would be subdivided into four text segments: "Hello", ",", "World", "!". The space character does not belong to any text segments.

Summary

Inherited constants

int DONE

Return value of previousStartBoundary(int), previousEndBoundary(int), nextStartBoundary(int), and nextEndBoundary(int) when there are no boundaries of the specified type in the specified direction.

Public constructors

WordSegmentFinder(CharSequence text, ULocale locale)

Constructs a WordSegmentFinder instance for the specified text which uses the provided locale to determine word boundaries.

Public methods

int nextEndBoundary(int offset)

Returns the character offset of the next text segment end boundary after the specified character offset, or DONE if there are none.

int nextStartBoundary(int offset)

Returns the character offset of the next text segment start boundary after the specified character offset, or DONE if there are none.

int previousEndBoundary(int offset)

Returns the character offset of the previous text segment end boundary before the specified character offset, or DONE if there are none.

int previousStartBoundary(int offset)

Returns the character offset of the previous text segment start boundary before the specified character offset, or DONE if there are none.

Inherited methods

abstract int nextEndBoundary(int offset)

Returns the character offset of the next text segment end boundary after the specified character offset, or DONE if there are none.

abstract int nextStartBoundary(int offset)

Returns the character offset of the next text segment start boundary after the specified character offset, or DONE if there are none.

abstract int previousEndBoundary(int offset)

Returns the character offset of the previous text segment end boundary before the specified character offset, or DONE if there are none.

abstract int previousStartBoundary(int offset)

Returns the character offset of the previous text segment start boundary before the specified character offset, or DONE if there are none.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

WordSegmentFinder

Added in API level 34
public WordSegmentFinder (CharSequence text, 
                ULocale locale)

Constructs a WordSegmentFinder instance for the specified text which uses the provided locale to determine word boundaries.

Parameters
text CharSequence: text to be segmented This value cannot be null.

locale ULocale: locale used for analyzing the text This value cannot be null.

Public methods

nextEndBoundary

Added in API level 34
public int nextEndBoundary (int offset)

Returns the character offset of the next text segment end boundary after the specified character offset, or DONE if there are none.

Parameters
offset int: Value is 0 or greater

Returns
int

nextStartBoundary

Added in API level 34
public int nextStartBoundary (int offset)

Returns the character offset of the next text segment start boundary after the specified character offset, or DONE if there are none.

Parameters
offset int: Value is 0 or greater

Returns
int

previousEndBoundary

Added in API level 34
public int previousEndBoundary (int offset)

Returns the character offset of the previous text segment end boundary before the specified character offset, or DONE if there are none.

Parameters
offset int: Value is 0 or greater

Returns
int

previousStartBoundary

Added in API level 34
public int previousStartBoundary (int offset)

Returns the character offset of the previous text segment start boundary before the specified character offset, or DONE if there are none.

Parameters
offset int: Value is 0 or greater

Returns
int