com.github.robtimus.io.stream

Class MultiLineReader

java.lang.Object

com.github.robtimus.io.stream.MultiLineReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<MultiLineReader.Entry>

public final class MultiLineReader
extends Object
implements Iterable<MultiLineReader.Entry>, Closeable

A class for reading multiple lines at a time. This can be useful for files where some entries span multiple lines, e.g. log files.

Although MultiLineReader implements Iterable, it only supports iterating over the entries once. This iterating can be done using iterator(), spliterator() or entries(). Only one of these methods may be used per MultiLineReader instance, and only once. Attempting to call more than one of these methods, or one of these methods multiple times, will result in an IllegalStateException.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiLineReader.Entry An entry that can be read using a MultiLineReader.

Constructor Summary

Constructors

Constructor and Description
MultiLineReader(Reader reader, Pattern newEntryStart) Creates a new multi-line reader.
MultiLineReader(Reader reader, Predicate<? super String> newEntryStart) Creates a new multi-line reader.

Method Summary

Modifier and Type	Method and Description
void	close()
Stream<MultiLineReader.Entry>	entries() Returns a stream over the entries.
Iterator<MultiLineReader.Entry>	iterator() Returns an iterator over the entries.
Spliterator<MultiLineReader.Entry>	spliterator() Returns a Spliterator over the entries.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

MultiLineReader

public MultiLineReader(Reader reader,
                       Pattern newEntryStart)

Creates a new multi-line reader. This method is short for MultiLineReader(reader, newEntryStart.asPredicate()).

Parameters:

reader - The backing reader.

newEntryStart - The pattern that determines when a line indicates the start of a new entry.

Throws:

NullPointerException - If the reader or pattern is null.

MultiLineReader

public MultiLineReader(Reader reader,
                       Predicate<? super String> newEntryStart)

Creates a new multi-line reader.

Parameters:

reader - The backing reader.

newEntryStart - The predicate that determines when a line indicates the start of a new entry.

Throws:

NullPointerException - If the reader or predicate is null.

Method Detail

iterator

public Iterator<MultiLineReader.Entry> iterator()

Returns an iterator over the entries. This method may be called only once, and may not be used in combination with spliterator() and entries().

Specified by:

iterator in interface Iterable<MultiLineReader.Entry>

Returns:

An iterator over the entries.

Throws:

IllegalStateException - If this method is called for a second time, or if spliterator() or entries() has already been called.

spliterator

public Spliterator<MultiLineReader.Entry> spliterator()

Returns a Spliterator over the entries. This method may be called only once, and may not be used in combination with iterator() and entries().

Specified by:

spliterator in interface Iterable<MultiLineReader.Entry>

Returns:

A Spliterator over the entries.

Throws:

IllegalStateException - If this method is called for a second time, or if spliterator() or entries() has already been called.

entries

public Stream<MultiLineReader.Entry> entries()

Returns a stream over the entries. This method may be called only once, and may not be used in combination with iterator() and spliterator().

Returns:

A stream over the entries.

Throws:

IllegalStateException - If this method is called for a second time, or if iterator() or spliterator() has already been called.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException