Package org.apache.commons.io.input

Class MemoryMappedFileInputStream.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<MemoryMappedFileInputStream,MemoryMappedFileInputStream.Builder>

org.apache.commons.io.build.AbstractOriginSupplier<MemoryMappedFileInputStream,MemoryMappedFileInputStream.Builder>

org.apache.commons.io.build.AbstractStreamBuilder<MemoryMappedFileInputStream,MemoryMappedFileInputStream.Builder>

org.apache.commons.io.input.MemoryMappedFileInputStream.Builder

All Implemented Interfaces:

IOSupplier<MemoryMappedFileInputStream>

Enclosing class:

MemoryMappedFileInputStream

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

Builds a new MemoryMappedFileInputStream.

For example:

 MemoryMappedFileInputStream s = MemoryMappedFileInputStream.builder()
   .setPath(path)
   .setBufferSize(256 * 1024)
   .get();
 

Since:

2.12.0

See Also:

• get()

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new builder of MemoryMappedFileInputStream.

Method Summary

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

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 Details

Builder

public Builder()

Constructs a new builder of MemoryMappedFileInputStream.

Method Details

get

public MemoryMappedFileInputStream get()
                                throws IOException

Builds a new MemoryMappedFileInputStream.

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

This builder uses the following aspects:

• AbstractStreamBuilder.getPath() gets the target aspect.
• AbstractStreamBuilder.getBufferSize()

Returns:

a new instance.

Throws:

IllegalStateException - if the origin is null.

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

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

See Also:

• AbstractStreamBuilder.getPath()
• AbstractStreamBuilder.getBufferSize()
• IOSupplier.getUnchecked()