Package software.amazon.smithy.model.jmespath.node

Class NodeJmespathRuntime

java.lang.Object

software.amazon.smithy.model.jmespath.node.NodeJmespathRuntime

All Implemented Interfaces:

Comparator<Node>, JmespathRuntime<Node>

public final class NodeJmespathRuntime
extends Object
implements JmespathRuntime<Node>

A singleton implementation of the JmespathRuntime interface based on instances of the Node class.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.smithy.jmespath.evaluation.JmespathRuntime

JmespathRuntime.ArrayBuilder<T>, JmespathRuntime.ObjectBuilder<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final NodeJmespathRuntime	INSTANCE	Singleton instance of the runtime.

Constructor Summary

Constructors

Constructor	Description
NodeJmespathRuntime()

Method Summary

Modifier and Type	Method	Description
JmespathRuntime.ArrayBuilder<Node>	arrayBuilder()	Creates a new ArrayBuilder.
boolean	asBoolean(Node value)	If the given value is a BOOLEAN, return it as a boolean.
Iterable<? extends Node>	asIterable(Node value)	Iterate over the elements of an ARRAY or the keys of an OBJECT.
Number	asNumber(Node value)	If the given value is a NUMBER, return it as a Number.
String	asString(Node value)	If the given value is a STRING, return it as a String.
Node	createBoolean(boolean b)	Creates a BOOLEAN value.
Node	createNull()	Returns `null`.
Node	createNumber(Number value)	Creates a NUMBER value.
Node	createString(String string)	Creates a STRING value.
Node	element(Node array, int index)	If the given value is an ARRAY, returns the element at the given index.
int	length(Node value)	Returns the number of elements in an ARRAY or the number of keys in an OBJECT.
NumberType	numberType(Node value)	Returns the type of Number that asNumber() will produce for this value.
JmespathRuntime.ObjectBuilder<Node>	objectBuilder()	Creates a new ObjectBuilder.
RuntimeType	typeOf(Node value)	Returns the basic type of the given value: NULL, BOOLEAN, STRING, NUMBER, OBJECT, or ARRAY.
Node	value(Node value, Node name)	If the given value is an OBJECT, returns the value mapped to the given key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface software.amazon.smithy.jmespath.evaluation.JmespathRuntime

compare, equal, is, isTruthy, slice, toString

Field Details

INSTANCE

public static final NodeJmespathRuntime INSTANCE

Singleton instance of the runtime.

Constructor Details

NodeJmespathRuntime

public NodeJmespathRuntime()

Method Details

typeOf

public RuntimeType typeOf(Node value)

Description copied from interface: JmespathRuntime

Returns the basic type of the given value: NULL, BOOLEAN, STRING, NUMBER, OBJECT, or ARRAY.

MUST NOT ever return EXPRESSION or ANY.

Specified by:

typeOf in interface JmespathRuntime<Node>

createNull

public Node createNull()

Description copied from interface: JmespathRuntime

Returns `null`.

Runtimes may or may not use a Java null value to represent a JSON null value.

Specified by:

createNull in interface JmespathRuntime<Node>

createBoolean

public Node createBoolean(boolean b)

Description copied from interface: JmespathRuntime

Creates a BOOLEAN value.

Specified by:

createBoolean in interface JmespathRuntime<Node>

asBoolean

public boolean asBoolean(Node value)

Description copied from interface: JmespathRuntime

If the given value is a BOOLEAN, return it as a boolean. Otherwise, throws a JmespathException of type INVALID_TYPE.

Specified by:

asBoolean in interface JmespathRuntime<Node>

createString

public Node createString(String string)

Description copied from interface: JmespathRuntime

Creates a STRING value.

Specified by:

createString in interface JmespathRuntime<Node>

asString

public String asString(Node value)

Description copied from interface: JmespathRuntime

If the given value is a STRING, return it as a String. Otherwise, throws a JmespathException of type INVALID_TYPE.

Note the distinction between this method and toString(), which can be called on any value and produces a JSON string.

Specified by:

asString in interface JmespathRuntime<Node>

createNumber

public Node createNumber(Number value)

Description copied from interface: JmespathRuntime

Creates a NUMBER value.

Specified by:

createNumber in interface JmespathRuntime<Node>

numberType

public NumberType numberType(Node value)

Description copied from interface: JmespathRuntime

Returns the type of Number that asNumber() will produce for this value. Will be more efficient for some runtimes than checking the class of asNumber().

Specified by:

numberType in interface JmespathRuntime<Node>

asNumber

public Number asNumber(Node value)

Description copied from interface: JmespathRuntime

If the given value is a NUMBER, return it as a Number. Otherwise, throws a JmespathException of type INVALID_TYPE.

Specified by:

asNumber in interface JmespathRuntime<Node>

length

public int length(Node value)

Description copied from interface: JmespathRuntime

Returns the number of elements in an ARRAY or the number of keys in an OBJECT. Otherwise, throws a JmespathException of type INVALID_TYPE.

Specified by:

length in interface JmespathRuntime<Node>

element

public Node element(Node array,
 int index)

Description copied from interface: JmespathRuntime

If the given value is an ARRAY, returns the element at the given index. Otherwise, throws a JmespathException of type INVALID_TYPE.

Specified by:

element in interface JmespathRuntime<Node>

asIterable

public Iterable<? extends Node> asIterable(Node value)

Description copied from interface: JmespathRuntime

Iterate over the elements of an ARRAY or the keys of an OBJECT. Otherwise, throws a JmespathException of type INVALID_TYPE.

Specified by:

asIterable in interface JmespathRuntime<Node>

arrayBuilder

public JmespathRuntime.ArrayBuilder<Node> arrayBuilder()

Description copied from interface: JmespathRuntime

Creates a new ArrayBuilder.

Specified by:

arrayBuilder in interface JmespathRuntime<Node>

value

public Node value(Node value,
 Node name)

Description copied from interface: JmespathRuntime

If the given value is an OBJECT, returns the value mapped to the given key. Otherwise, returns NULL.

Specified by:

value in interface JmespathRuntime<Node>

objectBuilder

public JmespathRuntime.ObjectBuilder<Node> objectBuilder()

Description copied from interface: JmespathRuntime

Creates a new ObjectBuilder.

Specified by:

objectBuilder in interface JmespathRuntime<Node>