org.conqat.lib.commons.string

Class LineSplitter

java.lang.Object

org.conqat.lib.commons.string.LineSplitter

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, java.util.Iterator<java.lang.String>

public class LineSplitter
extends java.lang.Object
implements java.util.Iterator<java.lang.String>, java.lang.Iterable<java.lang.String>

This class is used to split a string in lines using an Iterator. The default setting is to not return trailing empty lines. Use setIncludeTrailingEmptyLine(boolean) to include them.

Note: According to tests I performed this is the fastest method to split a string. It is about nine times faster than the regex-bases split with:

 Pattern pattern = Pattern.compile("\r\n|\r|\n");
 pattern.split(content);
 

Constructor Summary

Constructors

Constructor and Description
LineSplitter() Constructor for empty content.
LineSplitter(java.lang.String content) Constructor which calls setContent(String).

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
java.util.Iterator<java.lang.String>	iterator()
java.lang.String	next() Obtain next identified line.
void	remove()
void	setContent(java.lang.String content) Set the string to split and reset the iterator.
void	setIncludeTrailingEmptyLine(boolean includeTrailingEmptyLine) Enables returning of trailing empty lines during the iteration.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

LineSplitter

public LineSplitter()

Constructor for empty content.

LineSplitter

public LineSplitter(java.lang.String content)

Constructor which calls setContent(String).

Method Detail

setContent

public void setContent(java.lang.String content)

Set the string to split and reset the iterator.

Parameters:

content - The string to split. If string is null or the empty string, next() will return null.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.lang.String>

next

public java.lang.String next()

Obtain next identified line.

Specified by:

next in interface java.util.Iterator<java.lang.String>

Returns:

null if all lines were returned. On returning the last line all references to the input string are deleted. So it is free for garbage collection.

setIncludeTrailingEmptyLine

public void setIncludeTrailingEmptyLine(boolean includeTrailingEmptyLine)

Enables returning of trailing empty lines during the iteration. Default is false

If true the string Foo\nBar\nwill yield three items (Foo, Bar and the empty string), otherwise two items (Foo and Bar).

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<java.lang.String>

iterator

public java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>