org.apache.commons.io.input

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

org.apache.commons.io.input.BufferedFileChannelInputStream.Builder

All Implemented Interfaces:

IOSupplier<BufferedFileChannelInputStream>

Enclosing class:

BufferedFileChannelInputStream

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

Builds a new BufferedFileChannelInputStream.

Using File IO:

 BufferedFileChannelInputStream s = BufferedFileChannelInputStream.builder()
   .setFile(file)
   .setBufferSize(4096)
   .get();
 

Using NIO Path:

 BufferedFileChannelInputStream s = BufferedFileChannelInputStream.builder()
   .setPath(path)
   .setBufferSize(4096)
   .get();
 

Since:

2.12.0

See Also:

get()

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, 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, 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 BufferedFileChannelInputStream get()
                                   throws java.io.IOException

Builds a new BufferedFileChannelInputStream.

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

This builder use the following aspects:

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

Returns:

a new instance.

Throws:

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

java.lang.UnsupportedOperationException - if the origin cannot be converted to a Path.

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

See Also:

AbstractStreamBuilder.getPath(), AbstractStreamBuilder.getBufferSize()