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 instance.

Using File IO:

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

Using NIO Path:

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getWriter, setBufferSize, setBufferSize, setBufferSizeDefault, 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, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, 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

Constructor Detail

Builder

public Builder()

Method Detail

get

public UnsynchronizedBufferedInputStream get()
                                      throws IOException

Constructs a new instance.

This builder use the aspects InputStream, OpenOption[] and buffer size.

You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an UnsupportedOperationException.

Returns:

a new instance.

Throws:

UnsupportedOperationException - if the origin cannot provide an InputStream.

IOException - if an I/O error occurs.

See Also:

AbstractStreamBuilder.getInputStream()