gnu.java.text

Class BaseBreakIterator

Implemented Interfaces:
Cloneable
Known Direct Subclasses:
CharacterBreakIterator, LineBreakIterator, SentenceBreakIterator, WordBreakIterator

public abstract class BaseBreakIterator
extends BreakIterator

Field Summary

protected CharacterIterator
iter

Fields inherited from class java.text.BreakIterator

DONE

Constructor Summary

BaseBreakIterator()
This method initializes a new instance of BreakIterator.

Method Summary

int
current()
This method returns the index of the current text element boundary.
int
first()
This method returns the first text element boundary in the text being iterated over.
int
following(int pos)
Return the first boundary after pos.
CharacterIterator
getText()
This method returns the text this object is iterating over as a CharacterIterator.
int
last()
This method returns the last text element boundary in the text being iterated over.
int
next(int n)
This method returns the n'th text element boundary following the current text position.
void
setText(CharacterIterator newText)
This method sets the text to iterate over from the specified CharacterIterator.

Methods inherited from class java.text.BreakIterator

clone, current, first, following, getAvailableLocales, getCharacterInstance, getCharacterInstance, getLineInstance, getLineInstance, getSentenceInstance, getSentenceInstance, getText, getWordInstance, getWordInstance, isBoundary, last, next, next, preceding, previous, setText, setText

Methods inherited from class java.lang.Object

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

Field Details

iter

protected CharacterIterator iter

Constructor Details

BaseBreakIterator

public BaseBreakIterator()
This method initializes a new instance of BreakIterator. This protected constructor is available to subclasses as a default no-arg superclass constructor.

Method Details

current

public int current()
This method returns the index of the current text element boundary.
Overrides:
current in interface BreakIterator
Returns:
The current text boundary.

first

public int first()
This method returns the first text element boundary in the text being iterated over.
Overrides:
first in interface BreakIterator
Returns:
The first text boundary.

following

public int following(int pos)
Return the first boundary after pos. This has the side effect of setting the index of the CharacterIterator.
Overrides:
following in interface BreakIterator

getText

public CharacterIterator getText()
This method returns the text this object is iterating over as a CharacterIterator.
Overrides:
getText in interface BreakIterator
Returns:
The text being iterated over.

last

public int last()
This method returns the last text element boundary in the text being iterated over.
Overrides:
last in interface BreakIterator
Returns:
The last text boundary.

next

public int next(int n)
This method returns the n'th text element boundary following the current text position.
Overrides:
next in interface BreakIterator
Parameters:
n - The number of text element boundaries to skip.
Returns:
The next text boundary.

setText

public void setText(CharacterIterator newText)
This method sets the text to iterate over from the specified CharacterIterator.
Overrides:
setText in interface BreakIterator
Parameters:
newText - The desired CharacterIterator.

BaseBreakIterator.java -- Base class for default BreakIterators Copyright (C) 1999, 2001, 2004 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.