Package org.apache.commons.io.output
Class WriterOutputStream.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<WriterOutputStream,WriterOutputStream.Builder>
-
- org.apache.commons.io.output.WriterOutputStream.Builder
-
- All Implemented Interfaces:
IOSupplier<WriterOutputStream>
- Enclosing class:
- WriterOutputStream
public static class WriterOutputStream.Builder extends AbstractStreamBuilder<WriterOutputStream,WriterOutputStream.Builder>
Builds a newWriterOutputStream
instance.For example:
WriterOutputStream s = WriterOutputStream.builder() .setPath(path) .setBufferSize(8192) .setCharset(StandardCharsets.UTF_8) .setWriteImmediately(false) .get();
- Since:
- 2.12.0
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WriterOutputStream
get()
Constructs a new instance.WriterOutputStream.Builder
setCharset(java.lang.String charset)
Sets the Charset.WriterOutputStream.Builder
setCharset(java.nio.charset.Charset charset)
Sets the Charset.WriterOutputStream.Builder
setCharsetDecoder(java.nio.charset.CharsetDecoder charsetDecoder)
Sets the charset decoder.WriterOutputStream.Builder
setWriteImmediately(boolean writeImmediately)
Sets whether the output buffer will be flushed after each write operation (true
), i.e.-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getCharset, setBufferSize, setBufferSize, 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 WriterOutputStream get() throws java.io.IOException
Constructs a new instance.This builder use the aspect Writer, OpenOption[], Charset, CharsetDecoder, buffer size and writeImmediately.
You must provide an origin that can be converted to a Writer by this builder, otherwise, this call will throw an
UnsupportedOperationException
.- Returns:
- a new instance.
- Throws:
java.lang.UnsupportedOperationException
- if the origin cannot provide a Writer.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractStreamBuilder.getWriter()
-
setCharset
public WriterOutputStream.Builder setCharset(java.nio.charset.Charset charset)
Description copied from class:AbstractStreamBuilder
Sets the Charset.Subclasses may ignore this setting.
- Overrides:
setCharset
in classAbstractStreamBuilder<WriterOutputStream,WriterOutputStream.Builder>
- Parameters:
charset
- the Charset, null resets to the default.- Returns:
- this.
-
setCharset
public WriterOutputStream.Builder setCharset(java.lang.String charset)
Description copied from class:AbstractStreamBuilder
Sets the Charset.Subclasses may ignore this setting.
- Overrides:
setCharset
in classAbstractStreamBuilder<WriterOutputStream,WriterOutputStream.Builder>
- Parameters:
charset
- the Charset name, null resets to the default.- Returns:
- this.
-
setCharsetDecoder
public WriterOutputStream.Builder setCharsetDecoder(java.nio.charset.CharsetDecoder charsetDecoder)
Sets the charset decoder.- Parameters:
charsetDecoder
- the charset decoder.- Returns:
- this
-
setWriteImmediately
public WriterOutputStream.Builder setWriteImmediately(boolean writeImmediately)
Sets whether the output buffer will be flushed after each write operation (true
), i.e. all available data will be written to the underlyingWriter
immediately. Iffalse
, the output buffer will only be flushed when it overflows or whenWriterOutputStream.flush()
orWriterOutputStream.close()
is called.- Parameters:
writeImmediately
- Iftrue
the output buffer will be flushed after each write operation, i.e. all available data will be written to the underlyingWriter
immediately. Iffalse
, the output buffer will only be flushed when it overflows or whenWriterOutputStream.flush()
orWriterOutputStream.close()
is called.- Returns:
- this
-
-