Package org.apache.pinot.segment.local.utils.nativefst

Class FSTHeader

java.lang.Object

org.apache.pinot.segment.local.utils.nativefst.FSTHeader

public final class FSTHeader
extends Object

Standard FST file header, as described in FST package documentation.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FST_MAGIC	FST magic (4 bytes).

Method Summary

Modifier and Type	Method	Description
static FSTHeader	read(InputStream in)	Read FST header and version from a stream, consuming read bytes.
static void	write(OutputStream os, byte version)	Writes FST magic bytes and version information.

Methods inherited from class java.lang.Object

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

Field Detail

FST_MAGIC

public static final int FST_MAGIC

FST magic (4 bytes).

See Also:

Constant Field Values

Method Detail

read

public static FSTHeader read(InputStream in)
                      throws IOException

Read FST header and version from a stream, consuming read bytes.

Parameters:

in - The input stream to read data from.

Returns:

Returns a valid FSTHeader with version information.

Throws:

IOException - If the stream ends prematurely or if it contains invalid data.

write

public static void write(OutputStream os,
                         byte version)
                  throws IOException

Writes FST magic bytes and version information.

Parameters:

os - The stream to write to.

version - Automaton version.

Throws:

IOException - Rethrown if writing fails.