Package org.jfree.util
Class LineBreakIterator
java.lang.Object
org.jfree.util.LineBreakIterator
- All Implemented Interfaces:
Iterator
An iterator that breaks text into lines.
The result is equal to BufferedReader.readLine().
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.LineBreakIterator
(String text) Creates a new line break iterator. -
Method Summary
Modifier and TypeMethodDescriptiongetText()
Returns the text to be broken up.boolean
hasNext()
Returns true if the iteration has more elements.next()
Returns the next element in the iteration.int
Returns the position of the next break.int
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
Sets the text to be broken up.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Field Details
-
DONE
public static final int DONEA useful constant.- See Also:
-
text
private char[] textStorage for the text. -
position
private int positionThe current position.
-
-
Constructor Details
-
LineBreakIterator
public LineBreakIterator()Default constructor. -
LineBreakIterator
Creates a new line break iterator.- Parameters:
text
- the text to be broken up.
-
-
Method Details
-
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.
-
getText
Returns the text to be broken up.- Returns:
- The text.
-
setText
Sets the text to be broken up.- Parameters:
text
- 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.) -
next
Returns the next element in the iteration. -
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.- Specified by:
remove
in interfaceIterator
- Throws:
UnsupportedOperationException
- if the remove operation is not supported by this Iterator.IllegalStateException
- if the next method has not yet been called, or the remove method has already been called after the last call to the next method.
-