Module dev.argon.esexpr

Package dev.argon.esexpr

Interface ESExprCodec.FailurePath

All Known Implementing Classes:

ESExprCodec.FailurePath.Constructor, ESExprCodec.FailurePath.Current, ESExprCodec.FailurePath.Keyword, ESExprCodec.FailurePath.Positional

Enclosing class:

ESExprCodec<T>

public static sealed interface ESExprCodec.FailurePath
permits ESExprCodec.FailurePath.Current, ESExprCodec.FailurePath.Constructor, ESExprCodec.FailurePath.Positional, ESExprCodec.FailurePath.Keyword

The path of a decode failure.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ESExprCodec.FailurePath.Constructor	Indicates that the path ends at a constructor value.
static final record	ESExprCodec.FailurePath.Current	Indicates that the path ends at the current object.
static final record	ESExprCodec.FailurePath.Keyword	Indicates that the next part of the path is a keyword argument.
static final record	ESExprCodec.FailurePath.Positional	Indicates that the next part of the path is a positional argument.

Method Summary

Modifier and Type	Method	Description
ESExprCodec.FailurePath	append(String constructor, int index)	Gets a sub-path for a positional argument.
ESExprCodec.FailurePath	append(String constructor, String keyword)	Gets a sub-path for a keyword argument.
default VarargCodec.PositionalPathBuilder	appenderWithOffset(String constructor, int offset)	Creates a path builder for a vararg.
ESExprCodec.FailurePath	withConstructor(String constructor)	Specifies the name of the constructor at the current path.

Method Details

append

ESExprCodec.FailurePath append(String constructor,
 int index)

Gets a sub-path for a positional argument.

Parameters:

constructor - The constructor name of the object containing the value indicated by the new subpath.

index - The index of the positional argument indicated by the new subpath.

Returns:

The sub-path.

appenderWithOffset

default VarargCodec.PositionalPathBuilder appenderWithOffset(String constructor,
 int offset)

Creates a path builder for a vararg.

Parameters:

constructor - The constructor name of the object containing the value indicated by the new subpath.

offset - The index offset of the positional argument indicated by the new subpath.

Returns:

The path builder.

append

ESExprCodec.FailurePath append(String constructor,
 String keyword)

Gets a sub-path for a keyword argument.

Parameters:

constructor - The constructor name of the object containing the value indicated by the new subpath.

keyword - The name of the keyword argument indicated by the new subpath.

Returns:

The sub-path.

withConstructor

ESExprCodec.FailurePath withConstructor(String constructor)

Specifies the name of the constructor at the current path.

Parameters:

constructor - The constructor name.

Returns:

The sub-path.