java.text
public abstract class BreakIterator extends Object implements Cloneable
Modifier and Type | Field and Description |
---|---|
static int |
DONE
This value is returned by the
next() and
previous in order to indicate that the end of the
text has been reached. |
Modifier | Constructor and Description |
---|---|
protected |
BreakIterator()
This method initializes a new instance of
BreakIterator . |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Create a clone of this object.
|
abstract int |
current()
This method returns the index of the current text element boundary.
|
abstract int |
first()
This method returns the first text element boundary in the text being
iterated over.
|
abstract int |
following(int pos)
This methdod returns the offset of the text element boundary following
the specified offset.
|
static Locale[] |
getAvailableLocales()
This method returns a list of locales for which instances of
BreakIterator are available. |
static BreakIterator |
getCharacterInstance()
This method returns an instance of
BreakIterator that will
iterate over characters as defined in the default locale. |
static BreakIterator |
getCharacterInstance(Locale locale)
This method returns an instance of
BreakIterator that will
iterate over characters as defined in the specified locale. |
static BreakIterator |
getLineInstance()
This method returns an instance of
BreakIterator that will
iterate over line breaks as defined in the default locale. |
static BreakIterator |
getLineInstance(Locale locale)
This method returns an instance of
BreakIterator that will
iterate over line breaks as defined in the specified locale. |
static BreakIterator |
getSentenceInstance()
This method returns an instance of
BreakIterator that will
iterate over sentences as defined in the default locale. |
static BreakIterator |
getSentenceInstance(Locale locale)
This method returns an instance of
BreakIterator that will
iterate over sentences as defined in the specified locale. |
abstract CharacterIterator |
getText()
This method returns the text this object is iterating over as a
CharacterIterator . |
static BreakIterator |
getWordInstance()
This method returns an instance of
BreakIterator that will
iterate over words as defined in the default locale. |
static BreakIterator |
getWordInstance(Locale locale)
This method returns an instance of
BreakIterator that will
iterate over words as defined in the specified locale. |
boolean |
isBoundary(int pos)
This method tests whether or not the specified position is a text
element boundary.
|
abstract int |
last()
This method returns the last text element boundary in the text being
iterated over.
|
abstract int |
next()
This method returns the text element boundary following the current
text position.
|
abstract int |
next(int n)
This method returns the n'th text element boundary following the current
text position.
|
int |
preceding(int pos)
This methdod returns the offset of the text element boundary preceding
the specified offset.
|
abstract int |
previous()
This method returns the text element boundary preceding the current
text position.
|
abstract void |
setText(CharacterIterator newText)
This method sets the text to iterate over from the specified
CharacterIterator . |
void |
setText(String newText)
This method sets the text string to iterate over.
|
public static final int DONE
next()
and
previous
in order to indicate that the end of the
text has been reached.protected BreakIterator()
BreakIterator
.
This protected constructor is available to subclasses as a default
no-arg superclass constructor.public abstract int current()
public abstract int first()
public abstract int following(int pos)
pos
- The text index from which to find the next text boundary.public static Locale[] getAvailableLocales()
BreakIterator
are available.public static BreakIterator getCharacterInstance()
BreakIterator
that will
iterate over characters as defined in the default locale.BreakIterator
instance for the default locale.public static BreakIterator getCharacterInstance(Locale locale)
BreakIterator
that will
iterate over characters as defined in the specified locale.locale
- The desired locale.BreakIterator
instance for the specified locale.public static BreakIterator getLineInstance()
BreakIterator
that will
iterate over line breaks as defined in the default locale.BreakIterator
instance for the default locale.public static BreakIterator getLineInstance(Locale locale)
BreakIterator
that will
iterate over line breaks as defined in the specified locale.locale
- The desired locale.BreakIterator
instance for the default locale.public static BreakIterator getSentenceInstance()
BreakIterator
that will
iterate over sentences as defined in the default locale.BreakIterator
instance for the default locale.public static BreakIterator getSentenceInstance(Locale locale)
BreakIterator
that will
iterate over sentences as defined in the specified locale.locale
- The desired locale.BreakIterator
instance for the default locale.public abstract CharacterIterator getText()
CharacterIterator
.public static BreakIterator getWordInstance()
BreakIterator
that will
iterate over words as defined in the default locale.BreakIterator
instance for the default locale.public static BreakIterator getWordInstance(Locale locale)
BreakIterator
that will
iterate over words as defined in the specified locale.locale
- The desired locale.BreakIterator
instance for the default locale.public boolean isBoundary(int pos)
pos
- The text position to test.true
if the position is a boundary,
false
otherwise.public abstract int last()
public abstract int next()
public abstract int next(int n)
n
- The number of text element boundaries to skip.public int preceding(int pos)
pos
- The text index from which to find the preceding text boundary.public abstract int previous()
public void setText(String newText)
newText
- The String
to iterate over.public abstract void setText(CharacterIterator newText)
CharacterIterator
.newText
- The desired CharacterIterator
.