Module ojalgo

Package org.ojalgo.netio

Interface FromFileReader<T>

All Superinterfaces:

AutoCloseable, Closeable, Iterable<T>

All Known Implementing Classes:

DataReader, TextLineReader

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface FromFileReader<T>
extends Iterable<T>, Closeable

Essentially just a Supplier, but assumed to be reading from a file or some other source of data, and therefore extends Closeable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FromFileReader.Builder<F>

Method Summary

Modifier and Type	Method	Description
default void	close()
static void	copy(File sourceFile, Properties destinationMap)	Read the properties file and copy the entries to the supplied destination Properties instance.
static void	delete(File file)	Delete this file or directory (does not need to be empty).
static <T extends Serializable> T	deserializeObjectFromFile(File file)
default int	drainTo(Collection<? super T> container, int maxElements)	Behaves similar to BlockingQueue.drainTo(Collection, int) except that returning 0 means there are no more items to read.
static <T> FromFileReader<T>	empty()
default void	forEachInBacthes(int batchSize, Consumer<? super T> action)	Similar to Iterable.forEach(Consumer) but processes items in batches.
static InputStream	input(File file)
static InputStream	input(File file, OperatorWithException<InputStream> filter)
default Iterator<T>	iterator()
default <U> FromFileReader<U>	map(Function<T,U> mapper)
static <F> FromFileReader.Builder<F>	newBuilder(F... file)
static FromFileReader.Builder<File>	newBuilder(File file)
static FromFileReader.Builder<Path>	newBuilder(Path file)
static FromFileReader.Builder<SegmentedFile.Segment>	newBuilder(SegmentedFile segmented)
static FromFileReader.Builder<File>	newBuilder(ShardedFile sharded)
T	read()	Returning null indicates that there are no more items to read.
default Stream<T>	stream()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

copy

static void copy(File sourceFile,
 Properties destinationMap)

Read the properties file and copy the entries to the supplied destination Properties instance.

Parameters:

sourceFile - Source properties file

destinationMap - Destination properties map

delete

static void delete(File file)

Delete this file or directory (does not need to be empty).

Parameters:

file - Path to a file or directory to be deleted

deserializeObjectFromFile

static <T extends Serializable> T deserializeObjectFromFile(File file)

empty

static <T> FromFileReader<T> empty()

input

static InputStream input(File file)

input

static InputStream input(File file,
 OperatorWithException<InputStream> filter)

newBuilder

static <F> FromFileReader.Builder<F> newBuilder(F... file)

newBuilder

static FromFileReader.Builder<File> newBuilder(File file)

newBuilder

static FromFileReader.Builder<Path> newBuilder(Path file)

newBuilder

static FromFileReader.Builder<SegmentedFile.Segment> newBuilder(SegmentedFile segmented)

newBuilder

static FromFileReader.Builder<File> newBuilder(ShardedFile sharded)

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

drainTo

default int drainTo(Collection<? super T> container,
 int maxElements)

Behaves similar to BlockingQueue.drainTo(Collection, int) except that returning 0 means there are no more items to read.

forEachInBacthes

default void forEachInBacthes(int batchSize,
 Consumer<? super T> action)

Similar to Iterable.forEach(Consumer) but processes items in batches. Will extract up to batchSize items before calling the action, and then repeat until no more items are available.

iterator

default Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

map

default <U> FromFileReader<U> map(Function<T,U> mapper)

read

T read()

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.

stream

default Stream<T> stream()