Package org.scijava.io.nio

Interface NIOService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, SciJavaService, Service, Versioned

All Known Implementing Classes:

DefaultNIOService

public interface NIOService
extends SciJavaService

Interface for services that work with the java.nio package, particularly NIO ByteBuffer objects.

Author:

Chris Allan, Curtis Rueden

Method Summary

Modifier and Type	Method	Description
ByteBuffer	allocate(FileChannel channel, FileChannel.MapMode mapMode, long bufferStartPosition, int newSize)	Allocates or maps the desired file data into memory.

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Versioned

getVersion

Method Detail

allocate

ByteBuffer allocate(FileChannel channel,
                    FileChannel.MapMode mapMode,
                    long bufferStartPosition,
                    int newSize)
             throws IOException

Allocates or maps the desired file data into memory.

This method provides a facade to byte buffer allocation that enables FileChannel.map() usage on platforms where it's unlikely to give us problems and heap allocation where it is.

Parameters:

channel - File channel to allocate or map byte buffers from.

mapMode - The map mode. Required but only used if memory mapped I/O is to occur.

bufferStartPosition - The absolute position of the start of the buffer.

newSize - The buffer size.

Returns:

A newly allocated or mapped NIO byte buffer.

Throws:

IOException - If there is an issue mapping, aligning or allocating the buffer.

See Also:

"https://bugs.java.com/bugdatabase/view_bug.do?bug_id=5092131", "https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6417205"