Package org.apache.commons.io.output
Class LockableFileWriter.Builder
- java.lang.Object
-
- org.apache.commons.io.build.AbstractSupplier<T,B>
-
- org.apache.commons.io.build.AbstractOriginSupplier<T,B>
-
- org.apache.commons.io.build.AbstractStreamBuilder<LockableFileWriter,LockableFileWriter.Builder>
-
- org.apache.commons.io.output.LockableFileWriter.Builder
-
- All Implemented Interfaces:
IOSupplier<LockableFileWriter>
- Enclosing class:
- LockableFileWriter
public static class LockableFileWriter.Builder extends AbstractStreamBuilder<LockableFileWriter,LockableFileWriter.Builder>
Builds a newLockableFileWriter
instance.Using a CharsetEncoder:
LockableFileWriter w = LockableFileWriter.builder() .setPath(path) .setAppend(false) .setLockDirectory("Some/Directory") .get();
- Since:
- 2.12.0
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LockableFileWriter
get()
Constructs a new instance.LockableFileWriter.Builder
setAppend(boolean append)
Sets whether to append (true) or overwrite (false).LockableFileWriter.Builder
setLockDirectory(java.io.File lockDirectory)
Sets the directory in which the lock file should be held.LockableFileWriter.Builder
setLockDirectory(java.lang.String lockDirectory)
Sets the directory in which the lock file should be held.-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getCharset, setBufferSize, setBufferSize, setCharset, setCharset, setOpenOptions
-
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
setByteArray, setCharSequence, setFile, setFile, setInputStream, setOutputStream, setPath, setPath, setReader, setURI, setWriter
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier
-
-
-
-
Method Detail
-
get
public LockableFileWriter get() throws java.io.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:
java.lang.UnsupportedOperationException
- if the origin cannot provide a File.java.lang.IllegalStateException
- if theorigin
isnull
.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractOrigin.getFile()
-
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(java.io.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(java.lang.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
-
-