Package org.apache.commons.io.output
Class WriterOutputStream.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<WriterOutputStream,WriterOutputStream.Builder>
 
org.apache.commons.io.build.AbstractOriginSupplier<WriterOutputStream,WriterOutputStream.Builder>
 
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 new 
WriterOutputStream.
 For example:
 WriterOutputStream s = WriterOutputStream.builder()
   .setPath(path)
   .setBufferSize(8192)
   .setCharset(StandardCharsets.UTF_8)
   .setWriteImmediately(false)
   .get();
 - Since:
- 2.12.0
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionget()Builds a newWriterOutputStream.setCharset(String charset) Sets the Charset.setCharset(Charset charset) Sets the Charset.setCharsetDecoder(CharsetDecoder charsetDecoder) Sets the charset decoder.setWriteImmediately(boolean writeImmediately) Sets whether the output buffer will be flushed after each write operation (true), meaning all available data will be written to the underlyingWriterimmediately.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, 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 ofWriterOutputStream.
 
- 
- 
Method Details- 
getBuilds a newWriterOutputStream.You must set an aspect that supports AbstractStreamBuilder.getWriter()on this builder, otherwise, this method throws an exception.This builder uses the following aspects: - AbstractStreamBuilder.getWriter()
- AbstractStreamBuilder.getBufferSize()
- charsetDecoder
- writeImmediately
 - Returns:
- a new instance.
- Throws:
- UnsupportedOperationException- if the origin cannot provide a- Writer.
- IOException- if an I/O error occurs converting to an- Writerusing- AbstractStreamBuilder.getWriter().
- See Also:
 
- 
setCharsetDescription copied from class:AbstractStreamBuilderSets the Charset.Subclasses may ignore this setting. - Overrides:
- setCharsetin class- AbstractStreamBuilder<WriterOutputStream,- WriterOutputStream.Builder> 
- Parameters:
- charset- the Charset, null resets to the default.
- Returns:
- thisinstance.
 
- 
setCharsetDescription copied from class:AbstractStreamBuilderSets the Charset.Subclasses may ignore this setting. - Overrides:
- setCharsetin class- AbstractStreamBuilder<WriterOutputStream,- WriterOutputStream.Builder> 
- Parameters:
- charset- the Charset name, null resets to the default.
- Returns:
- thisinstance.
 
- 
setCharsetDecoderSets the charset decoder.- Parameters:
- charsetDecoder- the charset decoder.
- Returns:
- thisinstance.
 
- 
setWriteImmediatelySets whether the output buffer will be flushed after each write operation (true), meaning all available data will be written to the underlyingWriterimmediately. Iffalse, the output buffer will only be flushed when it overflows or whenWriterOutputStream.flush()orWriterOutputStream.close()is called.- Parameters:
- writeImmediately- If- truethe output buffer will be flushed after each write operation, meaning all available data will be written to the underlying- Writerimmediately. If- false, the output buffer will only be flushed when it overflows or when- WriterOutputStream.flush()or- WriterOutputStream.close()is called.
- Returns:
- thisinstance.
 
 
-