Package org.apache.commons.io.input

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

org.apache.commons.io.input.ReaderInputStream.Builder

All Implemented Interfaces:

IOSupplier<ReaderInputStream>

Enclosing class:

ReaderInputStream

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

Builds a new ReaderInputStream.

For example:

 ReaderInputStream s = ReaderInputStream.builder()
   .setPath(path)
   .setCharsetEncoder(Charset.defaultCharset().newEncoder())
   .get();
 

Since:

2.12.0

See Also:

get()

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReaderInputStream	get()	Builds a new ReaderInputStream.
ReaderInputStream.Builder	setCharset(java.nio.charset.Charset charset)	Sets the Charset.
ReaderInputStream.Builder	setCharsetEncoder(java.nio.charset.CharsetEncoder newEncoder)	Sets the charset encoder.

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

getCharset, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeMax, 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 ReaderInputStream get()
                      throws java.io.IOException

Builds a new ReaderInputStream.

You must set input that supports AbstractStreamBuilder.getReader(), otherwise, this method throws an exception.

This builder use the following aspects:

• AbstractStreamBuilder.getReader()
• AbstractStreamBuilder.getBufferSize()
• AbstractStreamBuilder.getCharset()
• CharsetEncoder

Returns:

a new instance.

Throws:

java.lang.UnsupportedOperationException - if the origin cannot provide a Reader.

java.lang.IllegalStateException - if the origin is null.

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

See Also:

AbstractStreamBuilder.getReader(), CharsetEncoder, AbstractStreamBuilder.getBufferSize()

setCharset

public ReaderInputStream.Builder setCharset(java.nio.charset.Charset charset)

Description copied from class: AbstractStreamBuilder

Sets the Charset.

Subclasses may ignore this setting.

Overrides:

setCharset in class AbstractStreamBuilder<ReaderInputStream,ReaderInputStream.Builder>

Parameters:

charset - the Charset, null resets to the default.

Returns:

this.

setCharsetEncoder

public ReaderInputStream.Builder setCharsetEncoder(java.nio.charset.CharsetEncoder newEncoder)

Sets the charset encoder. Assumes that the caller has configured the encoder.

Parameters:

newEncoder - the charset encoder, null resets to a default encoder.

Returns:

this