BreakIterator

Kotlin |Java

abstract class BreakIterator : Cloneable

kotlin.Any
↳	android.icu.text.BreakIterator

[icu enhancement] ICU's replacement for java.text.BreakIterator. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.

A class that locates boundaries in text. This class defines a protocol for objects that break up a piece of natural-language text according to a set of criteria. Instances or subclasses of BreakIterator can be provided, for example, to break a piece of text into words, sentences, or logical characters according to the conventions of some language or group of languages. We provide five built-in types of BreakIterator:

getTitleInstance() returns a BreakIterator that locates boundaries between title breaks.
getSentenceInstance() returns a BreakIterator that locates boundaries between sentences. This is useful for triple-click selection, for example.
getWordInstance() returns a BreakIterator that locates boundaries between words. This is useful for double-click selection or "find whole words" searches. This type of BreakIterator makes sure there is a boundary position at the beginning and end of each legal word. (Numbers count as words, too.) Whitespace and punctuation are kept separate from real words.
getLineInstance() returns a BreakIterator that locates positions where it is legal for a text editor to wrap lines. This is similar to word breaking, but not the same: punctuation and whitespace are generally kept with words (you don't want a line to start with whitespace, for example), and some special characters can force a position to be considered a line-break position or prevent a position from being a line-break position.
getCharacterInstance() returns a BreakIterator that locates boundaries between logical characters. Because of the structure of the Unicode encoding, a logical character may be stored internally as more than one Unicode code point. (A with an umlaut may be stored as an a followed by a separate combining umlaut character, for example, but the user still thinks of it as one character.) This iterator allows various processes (especially text editors) to treat as characters the units of text that a user would think of as characters, rather than the units of text that the computer sees as "characters".

The text boundary positions are found according to the rules described in Unicode Standard Annex #29, Text Boundaries, and Unicode Standard Annex #14, Line Breaking Properties. These are available at http://www.unicode.org/reports/tr14/ and http://www.unicode.org/reports/tr29/.

BreakIterator's interface follows an "iterator" model (hence the name), meaning it has a concept of a "current position" and methods like first(), last(), next(), and previous() that update the current position. All BreakIterators uphold the following invariants:

The beginning and end of the text are always treated as boundary positions.
The current position of the iterator is always a boundary position (random- access methods move the iterator to the nearest boundary position before or after the specified position, not to the specified position).
DONE is used as a flag to indicate when iteration has stopped. DONE is only returned when the current position is the end of the text and the user calls next(), or when the current position is the beginning of the text and the user calls previous().
Break positions are numbered by the positions of the characters that follow them. Thus, under normal circumstances, the position before the first character is 0, the position after the first character is 1, and the position after the last character is 1 plus the length of the string.
The client can change the position of an iterator, or the text it analyzes, at will, but cannot change the behavior. If the user wants different behavior, he must instantiate a new iterator.

BreakIterator accesses the text it analyzes through a CharacterIterator, which makes it possible to use BreakIterator to analyze text in any text-storage vehicle that provides a CharacterIterator interface. Note: Some types of BreakIterator can take a long time to create, and instances of BreakIterator are not currently cached by the system. For optimal performance, keep instances of BreakIterator around as long as makes sense. For example, when word-wrapping a document, don't create and destroy a new BreakIterator for each line. Create one break iterator for the whole document (or whatever stretch of text you're wrapping) and use it to do the whole job of wrapping the text.

Examples:

Creating and using text boundaries

public static void main(String args[]) {
       if (args.length == 1) {
           String stringToExamine = args[0];
           //print each word in order
           BreakIterator boundary = BreakIterator.getWordInstance();
           boundary.setText(stringToExamine);
           printEachForward(boundary, stringToExamine);
           //print each sentence in reverse order
           boundary = BreakIterator.getSentenceInstance(Locale.US);
           boundary.setText(stringToExamine);
           printEachBackward(boundary, stringToExamine);
           printFirst(boundary, stringToExamine);
           printLast(boundary, stringToExamine);
       }
  }

Print each element in order

public static void printEachForward(BreakIterator boundary, String source) {
      int start = boundary.first();
      for (int end = boundary.next();
           end != BreakIterator.DONE;
           start = end, end = boundary.next()) {
           System.out.println(source.substring(start,end));
      }
  }

Print each element in reverse order

public static void printEachBackward(BreakIterator boundary, String source) {
      int end = boundary.last();
      for (int start = boundary.previous();
           start != BreakIterator.DONE;
           end = start, start = boundary.previous()) {
          System.out.println(source.substring(start,end));
      }
  }

Print first element

public static void printFirst(BreakIterator boundary, String source) {
      int start = boundary.first();
      int end = boundary.next();
      System.out.println(source.substring(start,end));
  }

Print last element

public static void printLast(BreakIterator boundary, String source) {
      int end = boundary.last();
      int start = boundary.previous();
      System.out.println(source.substring(start,end));
  }

Print the element at a specified position

public static void printAt(BreakIterator boundary, int pos, String source) {
      int end = boundary.following(pos);
      int start = boundary.previous();
      System.out.println(source.substring(start,end));
  }

Find the next word

public static int nextWordStartAfter(int pos, String text) {
      BreakIterator wb = BreakIterator.getWordInstance();
      wb.setText(text);
      int wordStart = wb.following(pos);
      for (;;) {
          int wordLimit = wb.next();
          if (wordLimit == BreakIterator.DONE) {
              return BreakIterator.DONE;
          }
          int wordStatus = wb.getRuleStatus();
          if (wordStatus != BreakIterator.WORD_NONE) {
              return wordStart;
          }
          wordStart = wordLimit;
       }
  }

The iterator returned by #getWordInstance is unique in that the break positions it returns don't represent both the start and end of the thing being iterated over. That is, a sentence-break iterator returns breaks that each represent the end of one sentence and the beginning of the next. With the word-break iterator, the characters between two boundaries might be a word, or they might be the punctuation or whitespace between two words. The above code uses getRuleStatus to identify and ignore boundaries associated with punctuation or other non-word characters.

Summary

Constants
static Int	`DONE` DONE is returned by previous() and next() after all valid boundaries have been returned.
static Int	`KIND_CHARACTER` [icu]
static Int	`KIND_LINE` [icu]
static Int	`KIND_SENTENCE` [icu]
static Int	`KIND_TITLE` [icu]
static Int	`KIND_WORD` [icu]
static Int	`WORD_IDEO` Tag value for words containing ideographic characters, lower limit
static Int	`WORD_IDEO_LIMIT` Tag value for words containing ideographic characters, upper limit
static Int	`WORD_KANA` Tag value for words containing kana characters, lower limit
static Int	`WORD_KANA_LIMIT` Tag value for words containing kana characters, upper limit
static Int	`WORD_LETTER` Tag value for words that contain letters, excluding hiragana, katakana or ideographic characters, lower limit.
static Int	`WORD_LETTER_LIMIT` Tag value for words containing letters, upper limit
static Int	`WORD_NONE` Tag value for "words" that do not fit into any of other categories.
static Int	`WORD_NONE_LIMIT` Upper bound for tags for uncategorized words.
static Int	`WORD_NUMBER` Tag value for words that appear to be numbers, lower limit.
static Int	`WORD_NUMBER_LIMIT` Tag value for words that appear to be numbers, upper limit.

Protected constructors
`BreakIterator()` Default constructor.

Public methods
open Any	`clone()` Clone method.
abstract Int	`current()` Return the iterator's current position.
abstract Int	`first()` Set the iterator to the first boundary position.
abstract Int	`following(offset: Int)` Sets the iterator's current iteration position to be the first boundary position following the specified position.
open static Array<Locale!>!	`getAvailableLocales()` Returns a list of locales for which BreakIterators can be used.
open static BreakIterator!	`getCharacterInstance()` Returns a new instance of BreakIterator that locates logical-character boundaries.
open static BreakIterator!	`getCharacterInstance(where: Locale!)` Returns a new instance of BreakIterator that locates logical-character boundaries.
open static BreakIterator!	`getCharacterInstance(where: ULocale!)` [icu] Returns a new instance of BreakIterator that locates logical-character boundaries.
open static BreakIterator!	`getLineInstance()` Returns a new instance of BreakIterator that locates legal line- wrapping positions.
open static BreakIterator!	`getLineInstance(where: Locale!)` Returns a new instance of BreakIterator that locates legal line- wrapping positions.
open static BreakIterator!	`getLineInstance(where: ULocale!)` [icu] Returns a new instance of BreakIterator that locates legal line- wrapping positions.
open Int	`getRuleStatus()` For RuleBasedBreakIterators, return the status tag from the break rule that determined the boundary at the current iteration position.
open Int	`getRuleStatusVec(fillInArray: IntArray!)` For RuleBasedBreakIterators, get the status (tag) values from the break rule(s) that determined the the boundary at the current iteration position.
open static BreakIterator!	`getSentenceInstance()` Returns a new instance of BreakIterator that locates sentence boundaries.
open static BreakIterator!	`getSentenceInstance(where: Locale!)` Returns a new instance of BreakIterator that locates sentence boundaries.
open static BreakIterator!	`getSentenceInstance(where: ULocale!)` [icu] Returns a new instance of BreakIterator that locates sentence boundaries.
abstract CharacterIterator!	`getText()` Returns a CharacterIterator over the text being analyzed.
open static BreakIterator!	`getTitleInstance()` [icu] Returns a new instance of BreakIterator that locates title boundaries.
open static BreakIterator!	`getTitleInstance(where: Locale!)` [icu] Returns a new instance of BreakIterator that locates title boundaries.
open static BreakIterator!	`getTitleInstance(where: ULocale!)` [icu] Returns a new instance of BreakIterator that locates title boundaries.
open static BreakIterator!	`getWordInstance()` Returns a new instance of BreakIterator that locates word boundaries.
open static BreakIterator!	`getWordInstance(where: Locale!)` Returns a new instance of BreakIterator that locates word boundaries.
open static BreakIterator!	`getWordInstance(where: ULocale!)` [icu] Returns a new instance of BreakIterator that locates word boundaries.
open Boolean	`isBoundary(offset: Int)` Return true if the specified position is a boundary position.
abstract Int	`last()` Set the iterator to the last boundary position.
abstract Int	`next(n: Int)` Move the iterator by the specified number of steps in the text.
abstract Int	`next()` Advances the iterator forward one boundary.
open Int	`preceding(offset: Int)` Sets the iterator's current iteration position to be the last boundary position preceding the specified position.
abstract Int	`previous()` Move the iterator backward one boundary.
open Unit	`setText(newText: String!)` Sets the iterator to analyze a new piece of text.
open Unit	`setText(newText: CharSequence!)` Sets the iterator to analyze a new piece of text.
abstract Unit	`setText(newText: CharacterIterator!)` Sets the iterator to analyze a new piece of text.

BreakIterator

Summary

Constants

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

Protected constructors

BreakIterator

Public methods

clone

current

first

following

getAvailableLocales

getCharacterInstance

getCharacterInstance

getCharacterInstance

getLineInstance

getLineInstance

getLineInstance

getRuleStatus

getRuleStatusVec

getSentenceInstance

getSentenceInstance

getSentenceInstance

getText

getTitleInstance

getTitleInstance

getTitleInstance

getWordInstance

getWordInstance

getWordInstance

isBoundary

last

next

next

preceding

previous

setText

setText

setText