ToFileWriter

All Superinterfaces:: AutoCloseable, 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 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 final class

ToFileWriter.Builder<F>
Field Summary

Fields

Modifier and Type

Field

Description

static final ToFileWriter<?>

NULL
Method Summary

Modifier and Type

Method

Description

default void

close()

static void

mkdirs(File dir)

Make sure this directory exists, create if necessary

static <F> ToFileWriter.Builder<F>

newBuilder(F... file)

static ToFileWriter.Builder<File>

newBuilder(File file)

static ToFileWriter.Builder<Path>

newBuilder(Path file)

static ToFileWriter.Builder<File>

newBuilder(ShardedFile sharded)

static OutputStream

output(File file)

static <T extends Serializable> void

serializeObjectToFile(T object, File file)

void

write(T item)

Write the item to the consumer.

default void

writeBatch(Iterable<? extends T> batch)

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

Field Details
- NULL
  
  static final ToFileWriter<?> NULL
Method Details
- mkdirs
  
  static void mkdirs(File dir)
  
  Make sure this directory exists, create if necessary
- newBuilder
  
  static <F> ToFileWriter.Builder<F> newBuilder(F... file)
- newBuilder
  
  static ToFileWriter.Builder<File> newBuilder(File file)
- newBuilder
  
  static ToFileWriter.Builder<Path> newBuilder(Path file)
- newBuilder
  
  static ToFileWriter.Builder<File> newBuilder(ShardedFile sharded)
- output
  
  static OutputStream output(File file)
- serializeObjectToFile
  
  static <T extends Serializable> void serializeObjectToFile(T object, File file)
- close
  
  default void close() throws IOException
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable
  
  Throws:
  
  IOException
- write
  
  void write(T item)
  
  Write the item to the consumer.
  
  Parameters:
  
  item - The item to be written
- writeBatch
  
  default void writeBatch(Iterable<? extends T> batch)
  
  Write the batch (collection of items) to the consumer.
  
  Parameters:
  
  batch - The batch to be written