Module dev.argon.esexpr

Package dev.argon.esexpr

Class ESExprBinaryReader

java.lang.Object

dev.argon.esexpr.ESExprBinaryReader

public class ESExprBinaryReader
extends Object

A reader for the ESExpr binary format.

Constructor Summary

Constructors

Constructor	Description
ESExprBinaryReader(@NotNull List<String> symbolTable, @NotNull InputStream is)	Create a reader for the ESExpr binary format.

Method Summary

Modifier and Type	Method	Description
@Nullable ESExpr	read()	Attempts to read an ESExpr from the stream.
@NotNull Stream<@NotNull ESExpr>	readAll()	Reads all ESExpr values from the stream.
static @NotNull Stream<@NotNull ESExpr>	readEmbeddedStringTable(InputStream is)	Reads all ESExpr values, using the first as the string table.

Methods inherited from class java.lang.Object

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

Constructor Details

ESExprBinaryReader

public ESExprBinaryReader(@NotNull
 @NotNull List<String> symbolTable,
 @NotNull
 @NotNull InputStream is)

Create a reader for the ESExpr binary format.

Parameters:

symbolTable - The symbol table used when parsing.

is - The stream.

Method Details

read

@Nullable
public @Nullable ESExpr read()
                      throws IOException,
SyntaxException

Attempts to read an ESExpr from the stream.

Returns:

The ESExpr, or null if at the end of the stream.

Throws:

IOException - when an error occurs in the underlying stream.

SyntaxException - when an expression cannot be read.

readAll

@NotNull
public @NotNull Stream<@NotNull ESExpr> readAll()

Reads all ESExpr values from the stream.

Returns:

A stream of ESExpr values.

readEmbeddedStringTable

@NotNull
public static @NotNull Stream<@NotNull ESExpr> readEmbeddedStringTable(InputStream is)
                                                                throws IOException,
SyntaxException

Reads all ESExpr values, using the first as the string table.

Parameters:

is - The input stream.

Returns:

A stream of ESExpr values.

Throws:

IOException - when an error occurs in the underlying stream.

SyntaxException - when an expression cannot be read.