Package org.apache.commons.io.output

Class FileWriterWithEncoding.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<FileWriterWithEncoding,FileWriterWithEncoding.Builder>

org.apache.commons.io.output.FileWriterWithEncoding.Builder

All Implemented Interfaces:

IOSupplier<FileWriterWithEncoding>

Enclosing class:

FileWriterWithEncoding

public static class FileWriterWithEncoding.Builder
extends AbstractStreamBuilder<FileWriterWithEncoding,FileWriterWithEncoding.Builder>

Builds a new FileWriterWithEncoding instance.

Using a CharsetEncoder:

 FileWriterWithEncoding s = FileWriterWithEncoding.builder()
   .setPath(path)
   .setAppend(false)
   .setCharsetEncoder(StandardCharsets.UTF_8.newEncoder())
   .get();
 

Using a Charset:

 FileWriterWithEncoding s = FileWriterWithEncoding.builder()
   .setPath(path)
   .setAppend(false)
   .setCharsetEncoder(StandardCharsets.UTF_8)
   .get();
 

Since:

2.12.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FileWriterWithEncoding	get()	Constructs a new instance.
FileWriterWithEncoding.Builder	setAppend(boolean append)	Sets whether or not to append.
FileWriterWithEncoding.Builder	setCharsetEncoder(java.nio.charset.CharsetEncoder charsetEncoder)	Sets charsetEncoder to use for encoding.

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

Constructor Detail

Builder

public Builder()

Method Detail

get

public FileWriterWithEncoding get()
                           throws java.io.IOException

Constructs a new instance.

This builder use the aspects File, CharsetEncoder, and append.

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 the origin is null.

java.io.IOException - if an I/O error occurs.

See Also:

AbstractOrigin.getFile()

setAppend

public FileWriterWithEncoding.Builder setAppend(boolean append)

Sets whether or not to append.

Parameters:

append - Whether or not to append.

Returns:

this

setCharsetEncoder

public FileWriterWithEncoding.Builder setCharsetEncoder(java.nio.charset.CharsetEncoder charsetEncoder)

Sets charsetEncoder to use for encoding.

Parameters:

charsetEncoder - The charsetEncoder to use for encoding.

Returns:

this