Class DeferredFileOutputStream.Builder

All Implemented Interfaces:
IOSupplier<DeferredFileOutputStream>
Enclosing class:
DeferredFileOutputStream

public static class DeferredFileOutputStream.Builder extends AbstractStreamBuilder<DeferredFileOutputStream,DeferredFileOutputStream.Builder>
Builds a new DeferredFileOutputStream.

For example:


 DeferredFileOutputStream s = DeferredFileOutputStream.builder()
   .setBufferSize(4096)
   .setDirectory(dir)
   .setOutputFile(outputFile)
   .setPrefix(prefix)
   .setSuffix(suffix)
   .setThreshold(threshold)
   .get();
 

The only super's aspect used us buffer size.

Since:
2.12.0
See Also:
  • Field Details

    • threshold

      private int threshold
    • outputFile

      private Path outputFile
    • prefix

      private String prefix
    • suffix

      private String suffix
    • directory

      private Path directory
  • Constructor Details

    • Builder

      public Builder()
      Constructs a new builder.
  • Method Details

    • get

      Builds a new DeferredFileOutputStream.

      This builder use the following aspects:

      Returns:
      a new instance.
    • setDirectory

      public DeferredFileOutputStream.Builder setDirectory(File directory)
      Sets the temporary file directory.
      Parameters:
      directory - Temporary file directory.
      Returns:
      this
    • setDirectory

      public DeferredFileOutputStream.Builder setDirectory(Path directory)
      Sets the temporary file directory.
      Parameters:
      directory - Temporary file directory.
      Returns:
      this
      Since:
      2.14.0
    • setOutputFile

      public DeferredFileOutputStream.Builder setOutputFile(File outputFile)
      Sets the file to which data is saved beyond the threshold.
      Parameters:
      outputFile - The file to which data is saved beyond the threshold.
      Returns:
      this
    • setOutputFile

      public DeferredFileOutputStream.Builder setOutputFile(Path outputFile)
      Sets the file to which data is saved beyond the threshold.
      Parameters:
      outputFile - The file to which data is saved beyond the threshold.
      Returns:
      this
      Since:
      2.14.0
    • setPrefix

      public DeferredFileOutputStream.Builder setPrefix(String prefix)
      Sets the prefix to use for the temporary file.
      Parameters:
      prefix - Prefix to use for the temporary file.
      Returns:
      this
    • setSuffix

      public DeferredFileOutputStream.Builder setSuffix(String suffix)
      Sets the suffix to use for the temporary file.
      Parameters:
      suffix - Suffix to use for the temporary file.
      Returns:
      this
    • setThreshold

      public DeferredFileOutputStream.Builder setThreshold(int threshold)
      Sets the number of bytes at which to trigger an event.
      Parameters:
      threshold - The number of bytes at which to trigger an event.
      Returns:
      this