Module ojalgo

Package org.ojalgo.netio

Interface ToFileWriter<T>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

ScoredDualWriter<T>

All Known Implementing Classes:

DataWriter, ManagedWriter, MappedWriter, QueuedWriter, ShardedWriter, ShardedWriter.GeneralShardedConsumer, ShardedWriter.PowerOf2ShardedConsumer, TextLineWriter

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 ToFileWriter<T>
extends java.io.Closeable

Essentially just a Consumer, but assumed to be writing to a file or similar, and therefore extends Closeable.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static ToFileWriter<?>	NULL

Method Summary

Modifier and Type	Method	Description
default void	close()
static void	mkdirs(java.io.File dir)	Make sure this directory exists, create if necessary
static <F> ToFileWriter.Builder<F>	newBuilder(F... file)
static ToFileWriter.Builder<java.io.File>	newBuilder(java.io.File file)
static ToFileWriter.Builder<java.nio.file.Path>	newBuilder(java.nio.file.Path file)
static ToFileWriter.Builder<java.io.File>	newBuilder(ShardedFile sharded)
static java.io.OutputStream	output(java.io.File file)
static <T extends java.io.Serializable> void	serializeObjectToFile(T object, java.io.File file)
void	write(T item)	Write the item to the consumer.
default void	writeBatch(java.lang.Iterable<? extends T> batch)	Write the batch (collection of items) to the consumer.

Field Detail

NULL

static final ToFileWriter<?> NULL

Method Detail

mkdirs

static void mkdirs(java.io.File dir)

Make sure this directory exists, create if necessary

newBuilder

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

newBuilder

static ToFileWriter.Builder<java.io.File> newBuilder(java.io.File file)

newBuilder

static ToFileWriter.Builder<java.nio.file.Path> newBuilder(java.nio.file.Path file)

newBuilder

static ToFileWriter.Builder<java.io.File> newBuilder(ShardedFile sharded)

output

static java.io.OutputStream output(java.io.File file)

serializeObjectToFile

static <T extends java.io.Serializable> void serializeObjectToFile(T object,
                                                                   java.io.File file)

close

default void close()
            throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

write

void write(T item)

Write the item to the consumer.

Parameters:

item - The item to be written

writeBatch

default void writeBatch(java.lang.Iterable<? extends T> batch)

Write the batch (collection of items) to the consumer.

Parameters:

batch - The batch to be written