org.apache.commons.io.input

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

org.apache.commons.io.input.UnsynchronizedBufferedInputStream.Builder

All Implemented Interfaces:

IOSupplier<UnsynchronizedBufferedInputStream>

Enclosing class:

UnsynchronizedBufferedInputStream

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

Builds a new UnsynchronizedBufferedInputStream.

Using File IO:

 UnsynchronizedBufferedInputStream s = UnsynchronizedBufferedInputStream.builder()
   .setFile(file)
   .setBufferSize(8192)
   .get();
 

Using NIO Path:

 UnsynchronizedBufferedInputStream s = UnsynchronizedBufferedInputStream.builder()
   .setPath(path)
   .setBufferSize(8192)
   .get();
 

See Also:

get()

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a builder of UnsynchronizedBufferedInputStream.

Method Summary

Modifier and Type	Method and Description
UnsynchronizedBufferedInputStream	get() Builds a new UnsynchronizedBufferedInputStream.

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

getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions

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

checkOrigin, 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, 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, getUnchecked

Constructor Detail

Builder

public Builder()

Constructs a builder of UnsynchronizedBufferedInputStream.

Method Detail

get

public UnsynchronizedBufferedInputStream get()
                                      throws IOException

Builds a new UnsynchronizedBufferedInputStream.

You must set an aspect that supports AbstractStreamBuilder.getInputStream() on this builder, otherwise, this method throws an exception.

This builder uses the following aspects:

• AbstractStreamBuilder.getInputStream()
• AbstractStreamBuilder.getBufferSize()

Returns:

a new instance.

Throws:

IllegalStateException - if the origin is null.

UnsupportedOperationException - if the origin cannot be converted to an InputStream.

IOException - if an I/O error occurs converting to an InputStream using AbstractStreamBuilder.getInputStream().

See Also:

AbstractStreamBuilder.getInputStream(), AbstractStreamBuilder.getBufferSize(), IOSupplier.getUnchecked()