Module org.apache.lucene.core

Package org.apache.lucene.store

Class NIOFSDirectory.NIOFSIndexInput

java.lang.Object

org.apache.lucene.store.DataInput

org.apache.lucene.store.IndexInput

org.apache.lucene.store.BufferedIndexInput

org.apache.lucene.store.NIOFSDirectory.NIOFSIndexInput

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, RandomAccessInput

Enclosing class:

NIOFSDirectory

static final class NIOFSDirectory.NIOFSIndexInput
extends BufferedIndexInput

Reads bytes with FileChannel.read(ByteBuffer, long)

Field Summary

Fields

Modifier and Type	Field	Description
protected final FileChannel	channel	the file channel we will read from
private static final int	CHUNK_SIZE	The maximum chunk size for reads of 16384 bytes.
protected final long	end	end offset (start+length)
(package private) boolean	isClone	is this instance a clone and hence does not own the file to close it
protected final long	off	start offset: non-zero in the slice case

Fields inherited from class org.apache.lucene.store.BufferedIndexInput

BUFFER_SIZE, MERGE_BUFFER_SIZE, MIN_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
NIOFSIndexInput(String resourceDesc, FileChannel fc, long off, long length, int bufferSize)
NIOFSIndexInput(String resourceDesc, FileChannel fc, IOContext context)

Method Summary

Modifier and Type	Method	Description
NIOFSDirectory.NIOFSIndexInput	clone()	Returns a clone of this stream.
void	close()	Closes the stream to further operations.
final long	length()	The number of bytes in the file.
protected void	readInternal(ByteBuffer b)	Expert: implements buffer refill.
protected void	seekInternal(long pos)	Expert: implements seek.
IndexInput	slice(String sliceDescription, long offset, long length)	Creates a slice of this index input, with the given description, offset, and length.

Methods inherited from class org.apache.lucene.store.BufferedIndexInput

bufferSize, getBufferSize, getFilePointer, readByte, readByte, readBytes, readBytes, readFloats, readGroupVInt, readInt, readInt, readInts, readLong, readLong, readLongs, readShort, readShort, readVInt, readVLong, seek, wrap

Methods inherited from class org.apache.lucene.store.IndexInput

getFullSliceDescription, randomAccessSlice, skipBytes, toString

Methods inherited from class org.apache.lucene.store.DataInput

readGroupVInts, readMapOfStrings, readSetOfStrings, readString, readZInt, readZLong

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CHUNK_SIZE

private static final int CHUNK_SIZE

The maximum chunk size for reads of 16384 bytes.

See Also:

• Constant Field Values

channel

protected final FileChannel channel

the file channel we will read from

isClone

boolean isClone

is this instance a clone and hence does not own the file to close it

off

protected final long off

start offset: non-zero in the slice case

end

protected final long end

end offset (start+length)

Constructor Details

NIOFSIndexInput

public NIOFSIndexInput(String resourceDesc,
 FileChannel fc,
 IOContext context)
                throws IOException

Throws:

IOException

NIOFSIndexInput

public NIOFSIndexInput(String resourceDesc,
 FileChannel fc,
 long off,
 long length,
 int bufferSize)

Method Details

close

public void close()
           throws IOException

Description copied from class: IndexInput

Closes the stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class IndexInput

Throws:

IOException

clone

public NIOFSDirectory.NIOFSIndexInput clone()

Description copied from class: IndexInput

Returns a clone of this stream.

Clones of a stream access the same data, and are positioned at the same point as the stream they were cloned from.

Expert: Subclasses must ensure that clones may be positioned at different points in the input from each other and from the stream they were cloned from.

Warning: Lucene never closes cloned IndexInputs, it will only call IndexInput.close() on the original object.

If you access the cloned IndexInput after closing the original object, any readXXX methods will throw AlreadyClosedException.

This method is NOT thread safe, so if the current IndexInput is being used by one thread while clone is called by another, disaster could strike.

Overrides:

clone in class BufferedIndexInput

slice

public IndexInput slice(String sliceDescription,
 long offset,
 long length)
                 throws IOException

Description copied from class: IndexInput

Creates a slice of this index input, with the given description, offset, and length. The slice is sought to the beginning.

Overrides:

slice in class BufferedIndexInput

Throws:

IOException

length

public final long length()

Description copied from class: IndexInput

The number of bytes in the file.

Specified by:

length in interface RandomAccessInput

Specified by:

length in class IndexInput

readInternal

protected void readInternal(ByteBuffer b)
                     throws IOException

Description copied from class: BufferedIndexInput

Expert: implements buffer refill. Reads bytes from the current position in the input.

Specified by:

readInternal in class BufferedIndexInput

Parameters:

b - the buffer to read bytes into

Throws:

IOException

seekInternal

protected void seekInternal(long pos)
                     throws IOException

Description copied from class: BufferedIndexInput

Expert: implements seek. Sets current position in this file, where the next BufferedIndexInput.readInternal(ByteBuffer) will occur.

Specified by:

seekInternal in class BufferedIndexInput

Throws:

IOException

See Also:

• BufferedIndexInput.readInternal(ByteBuffer)