Module org.apache.lucene.core

Package org.apache.lucene.util.fst

Class ReadWriteDataOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.util.fst.ReadWriteDataOutput

All Implemented Interfaces:

Accountable, FSTReader

final class ReadWriteDataOutput
extends DataOutput
implements FSTReader

An adapter class to use ByteBuffersDataOutput as a FSTReader. It allows the FST to be readable immediately after writing

Field Summary

Fields

Modifier and Type	Field	Description
private final int	blockBits
private final int	blockMask
private final int	blockSize
private List<ByteBuffer>	byteBuffers
private final ByteBuffersDataOutput	dataOutput
private boolean	frozen

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
ReadWriteDataOutput(int blockBits)

Method Summary

Modifier and Type	Method	Description
void	freeze()
FST.BytesReader	getReverseBytesReader()	Get the reverse BytesReader for this FST
long	ramBytesUsed()	Return the memory usage of this object in bytes.
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeTo(DataOutput out)	Write this FST to another DataOutput

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

copyBytes, writeBytes, writeGroupVInts, writeInt, writeLong, writeMapOfStrings, writeSetOfStrings, writeShort, writeString, writeVInt, writeVLong, writeZInt, writeZLong

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

dataOutput

private final ByteBuffersDataOutput dataOutput

blockBits

private final int blockBits

blockSize

private final int blockSize

blockMask

private final int blockMask

byteBuffers

private List<ByteBuffer> byteBuffers

frozen

private boolean frozen

Constructor Details

ReadWriteDataOutput

public ReadWriteDataOutput(int blockBits)

Method Details

writeByte

public void writeByte(byte b)

Description copied from class: DataOutput

Writes a single byte.

The most primitive data type is an eight-bit byte. Files are accessed as sequences of bytes. All other data types are defined as sequences of bytes, so file formats are byte-order independent.

Specified by:

writeByte in class DataOutput

See Also:

• DataInput.readByte()

writeBytes

public void writeBytes(byte[] b,
 int offset,
 int length)

Description copied from class: DataOutput

Writes an array of bytes.

Specified by:

writeBytes in class DataOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

See Also:

• DataInput.readBytes(byte[],int,int)

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

freeze

public void freeze()

getReverseBytesReader

public FST.BytesReader getReverseBytesReader()

Description copied from interface: FSTReader

Get the reverse BytesReader for this FST

Specified by:

getReverseBytesReader in interface FSTReader

Returns:

the reverse BytesReader

writeTo

public void writeTo(DataOutput out)
             throws IOException

Description copied from interface: FSTReader

Write this FST to another DataOutput

Specified by:

writeTo in interface FSTReader

Parameters:

out - the DataOutput

Throws:

IOException - if exception occurred during writing