Module org.apache.lucene.core

Package org.apache.lucene.index

Class ByteSliceReader

java.lang.Object

org.apache.lucene.store.DataInput

org.apache.lucene.index.ByteSliceReader

All Implemented Interfaces:

Cloneable

final class ByteSliceReader
extends DataInput

IndexInput that knows how to read the byte slices written by Posting and PostingVector. We read the bytes in each slice until we hit the end of that slice at which point we read the forwarding address of the next slice and then jump to it.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) byte[]	buffer
int	bufferOffset
(package private) int	bufferUpto
int	endIndex
(package private) int	level
(package private) int	limit
(package private) ByteBlockPool	pool
int	upto

Constructor Summary

Constructors

Constructor	Description
ByteSliceReader()

Method Summary

Modifier and Type	Method	Description
boolean	eof()
void	init(ByteBlockPool pool, int startIndex, int endIndex)
void	nextSlice()
byte	readByte()	Reads and returns a single byte.
void	readBytes(byte[] b, int offset, int len)	Reads a specified number of bytes into an array at the specified offset.
void	skipBytes(long numBytes)	Skip over numBytes bytes.
long	writeTo(DataOutput out)

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

clone, readBytes, readFloats, readGroupVInt, readGroupVInts, readInt, readInts, readLong, readLongs, readMapOfStrings, readSetOfStrings, readShort, readString, readVInt, readVLong, readZInt, readZLong

Methods inherited from class java.lang.Object

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

Field Details

pool

ByteBlockPool pool

bufferUpto

int bufferUpto

buffer

byte[] buffer

upto

public int upto

limit

int limit

level

int level

bufferOffset

public int bufferOffset

endIndex

public int endIndex

Constructor Details

ByteSliceReader

ByteSliceReader()

Method Details

init

public void init(ByteBlockPool pool,
 int startIndex,
 int endIndex)

eof

public boolean eof()

readByte

public byte readByte()

Description copied from class: DataInput

Reads and returns a single byte.

Specified by:

readByte in class DataInput

See Also:

• DataOutput.writeByte(byte)

writeTo

public long writeTo(DataOutput out)
             throws IOException

Throws:

IOException

nextSlice

public void nextSlice()

readBytes

public void readBytes(byte[] b,
 int offset,
 int len)

Description copied from class: DataInput

Reads a specified number of bytes into an array at the specified offset.

Specified by:

readBytes in class DataInput

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

See Also:

• DataOutput.writeBytes(byte[],int)

skipBytes

public void skipBytes(long numBytes)

Description copied from class: DataInput

Skip over numBytes bytes. This method may skip bytes in whatever way is most optimal, and may not have the same behavior as reading the skipped bytes. In general, negative numBytes are not supported.

Specified by:

skipBytes in class DataInput