Class LockableFileWriter.Builder

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

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

Using a CharsetEncoder:


 LockableFileWriter w = LockableFileWriter.builder()
   .setPath(path)
   .setAppend(false)
   .setLockDirectory("Some/Directory")
   .get();
 
Since:
2.12.0
  • Field Details

    • append

      private boolean append
    • lockDirectory

      private AbstractOrigin<?,?> lockDirectory
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • get

      public LockableFileWriter get() throws IOException
      Constructs a new instance.

      This builder use the aspects File, Charset, append, and lockDirectory.

      You must provide an origin that can be converted to a File by this builder, otherwise, this call will throw an UnsupportedOperationException.

      Returns:
      a new instance.
      Throws:
      UnsupportedOperationException - if the origin cannot provide a File.
      IllegalStateException - if the origin is null.
      IOException - if an I/O error occurs.
      See Also:
    • setAppend

      public LockableFileWriter.Builder setAppend(boolean append)
      Sets whether to append (true) or overwrite (false).
      Parameters:
      append - whether to append (true) or overwrite (false).
      Returns:
      this
    • setLockDirectory

      public LockableFileWriter.Builder setLockDirectory(File lockDirectory)
      Sets the directory in which the lock file should be held.
      Parameters:
      lockDirectory - the directory in which the lock file should be held.
      Returns:
      this
    • setLockDirectory

      public LockableFileWriter.Builder setLockDirectory(String lockDirectory)
      Sets the directory in which the lock file should be held.
      Parameters:
      lockDirectory - the directory in which the lock file should be held.
      Returns:
      this