java.text
Class BreakIterator
- Cloneable
This class iterates over text elements such as words, lines, sentences,
and characters. It can only iterate over one of these text elements at
a time. An instance of this class configured for the desired iteration
type is created by calling one of the static factory methods, not
by directly calling a constructor.
The standard iterators created by the factory methods in this
class will be valid upon creation. That is, their methods will
not cause exceptions if called before you call setText().
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.
|
BreakIterator()- This method initializes a new instance of
BreakIterator.
|
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.
|
void | setText(String newText)- This method sets the text string to iterate over.
|
abstract void | setText(CharacterIterator newText)- This method sets the text to iterate over from the specified
CharacterIterator.
|
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait |
DONE
public static final int DONE
This value is returned by the next() and
previous in order to indicate that the end of the
text has been reached.
BreakIterator
protected BreakIterator()
This method initializes a new instance of BreakIterator.
This protected constructor is available to subclasses as a default
no-arg superclass constructor.
current
public abstract int current()
This method returns the index of the current text element boundary.
- The current text boundary.
first
public abstract int first()
This method returns the first text element boundary in the text being
iterated over.
following
public abstract int following(int pos)
This methdod returns the offset of the text element boundary following
the specified offset.
pos - The text index from which to find the next text boundary.
- The next text boundary following the specified index.
getAvailableLocales
public static Locale[] getAvailableLocales()
This method returns a list of locales for which instances of
BreakIterator are available.
- A list of available locales
getCharacterInstance
public static BreakIterator getCharacterInstance()
This method returns an instance of BreakIterator that will
iterate over characters as defined in the default locale.
- A
BreakIterator instance for the default locale.
getCharacterInstance
public static BreakIterator getCharacterInstance(Locale locale)
This method returns an instance of BreakIterator that will
iterate over characters as defined in the specified locale.
locale - The desired locale.
- A
BreakIterator instance for the specified locale.
getLineInstance
public static BreakIterator getLineInstance()
This method returns an instance of BreakIterator that will
iterate over line breaks as defined in the default locale.
- A
BreakIterator instance for the default locale.
getLineInstance
public static BreakIterator getLineInstance(Locale locale)
This method returns an instance of BreakIterator that will
iterate over line breaks as defined in the specified locale.
locale - The desired locale.
- A
BreakIterator instance for the default locale.
getSentenceInstance
public static BreakIterator getSentenceInstance()
This method returns an instance of BreakIterator that will
iterate over sentences as defined in the default locale.
- A
BreakIterator instance for the default locale.
getSentenceInstance
public static BreakIterator getSentenceInstance(Locale locale)
This method returns an instance of BreakIterator that will
iterate over sentences as defined in the specified locale.
locale - The desired locale.
- A
BreakIterator instance for the default locale.
getText
public abstract CharacterIterator getText()
This method returns the text this object is iterating over as a
CharacterIterator.
- The text being iterated over.
getWordInstance
public static BreakIterator getWordInstance()
This method returns an instance of BreakIterator that will
iterate over words as defined in the default locale.
- A
BreakIterator instance for the default locale.
getWordInstance
public static BreakIterator getWordInstance(Locale locale)
This method returns an instance of BreakIterator that will
iterate over words as defined in the specified locale.
locale - The desired locale.
- A
BreakIterator instance for the default locale.
isBoundary
public boolean isBoundary(int pos)
This method tests whether or not the specified position is a text
element boundary.
pos - The text position to test.
true if the position is a boundary,
false otherwise.
last
public abstract int last()
This method returns the last text element boundary in the text being
iterated over.
next
public abstract int next()
This method returns the text element boundary following the current
text position.
next
public abstract int next(int n)
This method returns the n'th text element boundary following the current
text position.
n - The number of text element boundaries to skip.
preceding
public int preceding(int pos)
This methdod returns the offset of the text element boundary preceding
the specified offset.
pos - The text index from which to find the preceding text boundary.
previous
public abstract int previous()
This method returns the text element boundary preceding the current
text position.
- The previous text boundary.
setText
public void setText(String newText)
This method sets the text string to iterate over.
newText - The String to iterate over.
setText
public abstract void setText(CharacterIterator newText)
This method sets the text to iterate over from the specified
CharacterIterator.
newText - The desired CharacterIterator.
BreakIterator.java -- Breaks text into elements
Copyright (C) 1998, 1999, 2001, 2004, 2005, 2007
Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.