Module org.apache.lucene.core

Package org.apache.lucene.store

Class BufferedIndexInput.SlicedIndexInput

java.lang.Object

org.apache.lucene.store.DataInput

org.apache.lucene.store.IndexInput

org.apache.lucene.store.BufferedIndexInput

org.apache.lucene.store.BufferedIndexInput.SlicedIndexInput

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, RandomAccessInput

Enclosing class:

BufferedIndexInput

private static final class BufferedIndexInput.SlicedIndexInput
extends BufferedIndexInput

Implementation of an IndexInput that reads from a portion of a file.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) IndexInput	base
(package private) long	fileOffset
(package private) long	length

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

BUFFER_SIZE, MERGE_BUFFER_SIZE, MIN_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
SlicedIndexInput(String sliceDescription, IndexInput base, long offset, long length)

Method Summary

Modifier and Type	Method	Description
BufferedIndexInput.SlicedIndexInput	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	readInternal(ByteBuffer b)	Expert: implements buffer refill.
protected void	seekInternal(long pos)	Expert: implements seek.

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, slice, 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

base

IndexInput base

fileOffset

long fileOffset

length

long length

Constructor Details

SlicedIndexInput

SlicedIndexInput(String sliceDescription,
 IndexInput base,
 long offset,
 long length)

Method Details

clone

public BufferedIndexInput.SlicedIndexInput 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

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)

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

See Also:

• BufferedIndexInput.readInternal(ByteBuffer)

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

length

public 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