org.jfree.util

Class LineBreakIterator

Implemented Interfaces:
Iterator

public class LineBreakIterator
extends java.lang.Object
implements Iterator

An iterator that breaks text into lines. The result is equal to BufferedReader.readLine().
Author:
Thomas Morgner

Field Summary

static int
DONE
A useful constant.

Constructor Summary

LineBreakIterator()
Default constructor.
LineBreakIterator(String text)
Creates a new line break iterator.

Method Summary

String
getText()
Returns the text to be broken up.
boolean
hasNext()
Returns true if the iteration has more elements.
Object
next()
Returns the next element in the iteration.
int
nextPosition()
Returns the position of the next break.
int
nextWithEnd()
Same like next(), but returns the End-Of-Text as if there was a linebreak added (Reader.readLine() compatible)
void
remove()
Removes from the underlying collection the last element returned by the iterator (optional operation).
void
setText(String text)
Sets the text to be broken up.

Field Details

DONE

public static final int DONE
A useful constant.
Field Value:
-1

Constructor Details

LineBreakIterator

public LineBreakIterator()
Default constructor.

LineBreakIterator

public LineBreakIterator(String text)
Creates a new line break iterator.
Parameters:
text - the text to be broken up.

Method Details

getText

public String getText()
Returns the text to be broken up.
Returns:
The text.

hasNext

public boolean hasNext()
Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)
Returns:
true if the iterator has more elements.

next

public Object next()
Returns the next element in the iteration.
Returns:
the next element in the iteration.

nextPosition

public int nextPosition()
Returns the position of the next break.
Returns:
A position.

nextWithEnd

public int nextWithEnd()
Same like next(), but returns the End-Of-Text as if there was a linebreak added (Reader.readLine() compatible)
Returns:
The next position.

remove

public void remove()
Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

setText

public void setText(String text)
Sets the text to be broken up.
Parameters:
text - the text.