Package org.apache.lucene.misc.store
Class RAFDirectory.RAFIndexInput
- java.lang.Object
-
- org.apache.lucene.store.DataInput
-
- org.apache.lucene.store.IndexInput
-
- org.apache.lucene.store.BufferedIndexInput
-
- org.apache.lucene.misc.store.RAFDirectory.RAFIndexInput
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Cloneable
,RandomAccessInput
- Enclosing class:
- RAFDirectory
static final class RAFDirectory.RAFIndexInput extends BufferedIndexInput
Reads bytes withRandomAccessFile.seek(long)
followed byRandomAccessFile.read(byte[], int, int)
.
-
-
Field Summary
Fields Modifier and Type Field Description private static int
CHUNK_SIZE
The maximum chunk size is 8192 bytes, becauseRandomAccessFile
mallocs a native buffer outside of stack if the read buffer size is larger.protected long
end
end offset (start+length)protected java.io.RandomAccessFile
file
the file channel we will read from(package private) boolean
isClone
is this instance a clone and hence does not own the file to close itprotected 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 RAFIndexInput(java.lang.String resourceDesc, java.io.RandomAccessFile file, long off, long length, int bufferSize)
RAFIndexInput(java.lang.String resourceDesc, java.io.RandomAccessFile file, IOContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RAFDirectory.RAFIndexInput
clone()
Returns a clone of this stream.void
close()
Closes the stream to further operations.(package private) boolean
isFDValid()
long
length()
The number of bytes in the file.protected void
readInternal(java.nio.ByteBuffer b)
IndexInput methodsprotected void
seekInternal(long pos)
Expert: implements seek.IndexInput
slice(java.lang.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, readInt, readInt, readLong, readLong, 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
readFloats, readInts, readLongs, readMapOfStrings, readSetOfStrings, readString, readZInt, readZLong
-
-
-
-
Field Detail
-
CHUNK_SIZE
private static final int CHUNK_SIZE
The maximum chunk size is 8192 bytes, becauseRandomAccessFile
mallocs a native buffer outside of stack if the read buffer size is larger.- See Also:
- Constant Field Values
-
file
protected final java.io.RandomAccessFile file
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 Detail
-
RAFIndexInput
public RAFIndexInput(java.lang.String resourceDesc, java.io.RandomAccessFile file, IOContext context) throws java.io.IOException
- Throws:
java.io.IOException
-
RAFIndexInput
public RAFIndexInput(java.lang.String resourceDesc, java.io.RandomAccessFile file, long off, long length, int bufferSize)
-
-
Method Detail
-
close
public void close() throws java.io.IOException
Description copied from class:IndexInput
Closes the stream to further operations.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classIndexInput
- Throws:
java.io.IOException
-
clone
public RAFDirectory.RAFIndexInput 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
IndexInput
s, it will only callIndexInput.close()
on the original object.If you access the cloned IndexInput after closing the original object, any
readXXX
methods will throwAlreadyClosedException
.This method is NOT thread safe, so if the current
IndexInput
is being used by one thread whileclone
is called by another, disaster could strike.- Overrides:
clone
in classBufferedIndexInput
-
slice
public IndexInput slice(java.lang.String sliceDescription, long offset, long length) throws java.io.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 classBufferedIndexInput
- Throws:
java.io.IOException
-
length
public final long length()
Description copied from class:IndexInput
The number of bytes in the file.- Specified by:
length
in classIndexInput
-
readInternal
protected void readInternal(java.nio.ByteBuffer b) throws java.io.IOException
IndexInput methods- Specified by:
readInternal
in classBufferedIndexInput
- Parameters:
b
- the buffer to read bytes into- Throws:
java.io.IOException
-
seekInternal
protected void seekInternal(long pos) throws java.io.IOException
Description copied from class:BufferedIndexInput
Expert: implements seek. Sets current position in this file, where the nextBufferedIndexInput.readInternal(ByteBuffer)
will occur.- Specified by:
seekInternal
in classBufferedIndexInput
- Throws:
java.io.IOException
- See Also:
BufferedIndexInput.readInternal(ByteBuffer)
-
isFDValid
boolean isFDValid() throws java.io.IOException
- Throws:
java.io.IOException
-
-