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

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

getCharset, setBufferSize, setBufferSize, setCharset, 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 BufferedFileChannelInputStream get()
                                   throws java.io.IOException

Constructs a new instance.

This builder use the aspects Path and buffer size.

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

Returns:

a new instance.

Throws:

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

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

See Also:

AbstractOrigin.getPath()