Module ojalgo

Package org.ojalgo.netio

Class TextLineReader

java.lang.Object

org.ojalgo.netio.TextLineReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.lang.String>, FromFileReader<java.lang.String>

public final class TextLineReader
extends java.lang.Object
implements FromFileReader<java.lang.String>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextLineReader.Parser<T>

Nested classes/interfaces inherited from interface org.ojalgo.netio.FromFileReader

FromFileReader.Builder<F>

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.BufferedReader	myReader

Constructor Summary

Constructors

Constructor	Description
TextLineReader(java.io.InputStream inputStream)
TextLineReader(java.io.Reader delegate)

Method Summary

Modifier and Type	Method	Description
void	close()
static boolean	isLineOK(java.lang.String line)	not null, not empty, not blank and not a comment (starts with '#')
static TextLineReader	of(java.io.File file)
static TextLineReader	of(java.io.File file, OperatorWithException<java.io.InputStream> filter)
static TextLineReader	of(java.lang.String pathname)
static TextLineReader	of(InMemoryFile file)
static TextLineReader	of(InMemoryFile file, OperatorWithException<java.io.InputStream> filter)
java.lang.String	read()	Returning null indicates that there are no more items to read.
<T> FromFileReader<T>	withFilteredParser(java.util.function.Predicate<java.lang.String> filter, TextLineReader.Parser<T> parser)	The filter could for instance be isLineOK(String)
<T> FromFileReader<T>	withFilteredParser(TextLineReader.Parser<T> parser)	The filter is isLineOK(String)
<T> FromFileReader<T>	withParser(TextLineReader.Parser<T> parser)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.netio.FromFileReader

drainTo, forEachInBacthes, iterator, map, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

myReader

private final java.io.BufferedReader myReader

Constructor Detail

TextLineReader

public TextLineReader(java.io.InputStream inputStream)

TextLineReader

TextLineReader(java.io.Reader delegate)

Method Detail

isLineOK

public static boolean isLineOK(java.lang.String line)

not null, not empty, not blank and not a comment (starts with '#')

of

public static TextLineReader of(java.io.File file)

of

public static TextLineReader of(java.io.File file,
                                OperatorWithException<java.io.InputStream> filter)

of

public static TextLineReader of(InMemoryFile file)

of

public static TextLineReader of(InMemoryFile file,
                                OperatorWithException<java.io.InputStream> filter)

of

public static TextLineReader of(java.lang.String pathname)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface FromFileReader<java.lang.String>

Throws:

java.io.IOException

read

public java.lang.String read()

Description copied from interface: FromFileReader

Returning null indicates that there are no more items to read. That's the same behaviour as BufferedReader.readLine(). All implementations must return null precisely once.

Specified by:

read in interface FromFileReader<java.lang.String>

withFilteredParser

public <T> FromFileReader<T> withFilteredParser(TextLineReader.Parser<T> parser)

The filter is isLineOK(String)

withFilteredParser

public <T> FromFileReader<T> withFilteredParser(java.util.function.Predicate<java.lang.String> filter,
                                                TextLineReader.Parser<T> parser)

The filter could for instance be isLineOK(String)

withParser

public <T> FromFileReader<T> withParser(TextLineReader.Parser<T> parser)