com.ibm.icu.text

Class FilteredBreakIteratorBuilder

java.lang.Object

com.ibm.icu.text.FilteredBreakIteratorBuilder

Direct Known Subclasses:

SimpleFilteredSentenceBreakIterator.Builder

Deprecated.

This API might change or be removed in a future release.

@Deprecated
public abstract class FilteredBreakIteratorBuilder
extends Object

The BreakIteratorFilter is used to modify the behavior of a BreakIterator by constructing a new BreakIterator which suppresses certain segment boundaries. See http://www.unicode.org/reports/tr35/tr35-general.html#Segmentation_Exceptions . For example, a typical English Sentence Break Iterator would break on the space in the string "Mr. Smith" (resulting in two segments), but with "Mr." as an exception, a filtered break iterator would consider the string "Mr. Smith" to be a single segment.

Note: An instance of BreakIterator returned by this builder class currently does not support following operations in this technology preview version:

• next(int n)
• previous()
• following(int offset)
• preceding(int offset)

When one of above methods is called, UnsupportedOperationException will be thrown.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilteredBreakIteratorBuilder() Deprecated. This API might change or be removed in a future release.

Method Summary

Modifier and Type	Method and Description
abstract BreakIterator	build(BreakIterator adoptBreakIterator) Deprecated. This API might change or be removed in a future release.
static FilteredBreakIteratorBuilder	createInstance() Deprecated. This API might change or be removed in a future release.
static FilteredBreakIteratorBuilder	createInstance(ULocale where) Deprecated. This API might change or be removed in a future release.
abstract boolean	suppressBreakAfter(String str) Deprecated. This API might change or be removed in a future release.
abstract boolean	unsuppressBreakAfter(String str) Deprecated. This API might change or be removed in a future release.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilteredBreakIteratorBuilder

@Deprecated
protected FilteredBreakIteratorBuilder()

Deprecated. This API might change or be removed in a future release.

For subclass use

Method Detail

createInstance

@Deprecated
public static FilteredBreakIteratorBuilder createInstance(ULocale where)

Deprecated. This API might change or be removed in a future release.

Construct a FilteredBreakIteratorBuilder based on rules in a locale. The rules are taken from CLDR exception data for the locale, see http://www.unicode.org/reports/tr35/tr35-general.html#Segmentation_Exceptions This is the equivalent of calling createInstance(UErrorCode&) and then repeatedly calling addNoBreakAfter(...) with the contents of the CLDR exception data.

Parameters:

where - the locale.

Returns:

the new builder

createInstance

@Deprecated
public static FilteredBreakIteratorBuilder createInstance()

Deprecated. This API might change or be removed in a future release.

Construct an empty FilteredBreakIteratorBuilder. In this state, it will not suppress any segment boundaries.

Returns:

the new builder

suppressBreakAfter

@Deprecated
public abstract boolean suppressBreakAfter(String str)

Deprecated. This API might change or be removed in a future release.

Suppress a certain string from being the end of a segment. For example, suppressing "Mr.", then segments ending in "Mr." will not be returned by the iterator.

Parameters:

str - the string to suppress, such as "Mr."

Returns:

returns true if the string was not present and now added, false if the call was a no-op because the string was already being suppressed.

unsuppressBreakAfter

@Deprecated
public abstract boolean unsuppressBreakAfter(String str)

Deprecated. This API might change or be removed in a future release.

Stop suppressing a certain string from being the end of the segment. This function does not create any new segment boundaries, but only serves to un-do the effect of earlier calls to suppressBreakAfter, or to un-do the effect of locale data which may be suppressing certain strings.

Parameters:

str - the str the string to unsuppress, such as "Mr."

Returns:

returns true if the string was present and now removed, false if the call was a no-op because the string was not being suppressed.

build

@Deprecated
public abstract BreakIterator build(BreakIterator adoptBreakIterator)

Deprecated. This API might change or be removed in a future release.

Wrap (adopt) an existing break iterator in a new filtered instance. The resulting BreakIterator is owned by the caller. The BreakIteratorFilter may be destroyed before the BreakIterator is destroyed. Note that the adoptBreakIterator is adopted by the new BreakIterator and should no longer be used by the caller. The FilteredBreakIteratorBuilder may be reused.

Parameters:

adoptBreakIterator - the break iterator to adopt

Returns:

the new BreakIterator, owned by the caller.