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

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

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