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

Enclosing class:

NIOFSDirectory

protected static class NIOFSDirectory.NIOFSIndexInput
extends BufferedIndexInput

Reads bytes with FileChannel.read(ByteBuffer, long)

Field Summary

Fields

Modifier and Type	Field and Description
protected FileChannel	channel the file channel we will read from
protected long	end end offset (start+length)
protected long	off start offset: non-zero in the slice case

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

buffer, BUFFER_SIZE, MERGE_BUFFER_SIZE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NIOFSDirectory.NIOFSIndexInput	clone() Returns a clone of this stream.
void	close() Closes the stream to further operations.
long	length() The number of bytes in the file.
protected void	newBuffer(byte[] newBuffer)
protected void	readInternal(byte[] b, int offset, int len) Expert: implements buffer refill.
protected void	seekInternal(long pos) Expert: implements seek.

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

bufferSize, flushBuffer, getBufferSize, getFilePointer, readByte, readBytes, readBytes, readInt, readLong, readShort, readVInt, readVLong, seek, setBufferSize

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

toString

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

readString, readStringSet, readStringStringMap, skipBytes

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected final FileChannel channel

the file channel we will read from

off

protected final long off

start offset: non-zero in the slice case

end

protected final long end

end offset (start+length)

Constructor Detail

NIOFSDirectory.NIOFSIndexInput

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

Throws:

IOException

NIOFSDirectory.NIOFSIndexInput

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

Method Detail

close

public void close()
           throws IOException

Description copied from class: IndexInput

Closes the stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

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 do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.

Overrides:

clone in class BufferedIndexInput

length

public final long length()

Description copied from class: IndexInput

The number of bytes in the file.

Specified by:

length in class IndexInput

newBuffer

protected void newBuffer(byte[] newBuffer)

Overrides:

newBuffer in class BufferedIndexInput

readInternal

protected void readInternal(byte[] b,
                int offset,
                int len)
                     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 array to read bytes into

offset - the offset in the array to start storing bytes

len - the number of bytes to read

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(byte[],int,int) will occur.

Specified by:

seekInternal in class BufferedIndexInput

Throws:

IOException

See Also:

BufferedIndexInput.readInternal(byte[],int,int)