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 new
LockableFileWriter
instance.
Using a CharsetEncoder:
LockableFileWriter w = LockableFileWriter.builder()
.setPath(path)
.setAppend(false)
.setLockDirectory("Some/Directory")
.get();
- Since:
- 2.12.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()
Constructs a new instance.setAppend
(boolean append) Sets whether to append (true) or overwrite (false).setLockDirectory
(File lockDirectory) Sets the directory in which the lock file should be held.setLockDirectory
(String lockDirectory) Sets the directory in which the lock file should be held.Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setReader, setURI, setWriter
Methods inherited from class org.apache.commons.io.build.AbstractSupplier
asThis
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier
-
Constructor Details
-
Builder
public Builder()Constructs a new Builder.
-
-
Method Details
-
get
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 theorigin
isnull
.IOException
- if an I/O error occurs.- See Also:
-
setAppend
Sets whether to append (true) or overwrite (false).- Parameters:
append
- whether to append (true) or overwrite (false).- Returns:
- this
-
setLockDirectory
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
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
-