Package org.apache.commons.io.output
Class LockableFileWriter.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<LockableFileWriter,LockableFileWriter.Builder>
 
org.apache.commons.io.build.AbstractOriginSupplier<LockableFileWriter,LockableFileWriter.Builder>
 
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.
 Using a CharsetEncoder:
 LockableFileWriter w = LockableFileWriter.builder()
   .setPath(path)
   .setAppend(false)
   .setLockDirectory("Some/Directory")
   .get();
 - Since:
- 2.12.0
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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.AbstractStreamBuildergetBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptionsMethods inherited from class org.apache.commons.io.build.AbstractOriginSuppliercheckOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriterMethods inherited from class org.apache.commons.io.build.AbstractSupplierasThisMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.io.function.IOSupplierasSupplier, getUnchecked
- 
Constructor Details- 
Builderpublic Builder()Constructs a new builder ofLockableFileWriter.
 
- 
- 
Method Details- 
getConstructs a new instance.You must set an aspect that supports Fileon this builder, otherwise, this method throws an exception.This builder uses the following aspects: - Fileis the target aspect.
- AbstractStreamBuilder.getCharset()
- append
- lockDirectory
 - Returns:
- a new instance.
- Throws:
- UnsupportedOperationException- if the origin cannot provide a File.
- IllegalStateException- if the- originis- null.
- IOException- if an I/O error occurs converting to an- Fileusing- AbstractStreamBuilder.getFile().
- See Also:
 
- 
setAppendSets whether to append (true) or overwrite (false).- Parameters:
- append- whether to append (true) or overwrite (false).
- Returns:
- thisinstance.
 
- 
setLockDirectorySets the directory in which the lock file should be held.- Parameters:
- lockDirectory- the directory in which the lock file should be held.
- Returns:
- thisinstance.
 
- 
setLockDirectorySets the directory in which the lock file should be held.- Parameters:
- lockDirectory- the directory in which the lock file should be held.
- Returns:
- thisinstance.
 
 
-