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

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LockableFileWriter	get() Constructs a new instance.
LockableFileWriter.Builder	setAppend(boolean append) Sets whether to append (true) or overwrite (false).
LockableFileWriter.Builder	setLockDirectory(File lockDirectory) Sets the directory in which the lock file should be held.
LockableFileWriter.Builder	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, getCharset, getCharsetDefault, setBufferSize, setBufferSize, setBufferSizeDefault, setCharset, setCharset, setCharsetDefault

Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier

checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, 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 Detail

Builder

public Builder()

Method Detail

get

public LockableFileWriter get()
                       throws IOException

Constructs a new instance.

Returns:

a result

Throws:

UnsupportedOperationException - if the origin cannot be converted to a File.

IOException - if an I/O error occurs.

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