io.burt.jmespath

Class BaseRuntime<T>

java.lang.Object

io.burt.jmespath.BaseRuntime<T>

All Implemented Interfaces:

Adapter<T>, JmesPath<T>, Comparator<T>

Direct Known Subclasses:

JcfRuntime

public abstract class BaseRuntime<T>
extends Object
implements Adapter<T>

This class can be extended instead of implementing Adapter directly, in order to not have to implement a few of the methods that have non-specific implementations, like Adapter.functionRegistry(), Adapter.typeOf(T) or the Comparable interface. Subclasses are encouraged to override these methods if they have more efficient means to perform the same job.

Constructor Summary

Constructors

Constructor and Description
BaseRuntime() Create a new runtime with a default function registry.
BaseRuntime(RuntimeConfiguration configuration) Create a new runtime with configuration.

Method Summary

Modifier and Type	Method and Description
int	compare(T value1, T value2) Basic implementation of Comparator.compare(T, T).
Expression<T>	compile(String expression) Compile a JMESPath expression into a reusable expression object.
boolean	equals(Object o) Required method from the Comparator interface, returns true when the argument is of the same class, or a subclass of, the receiver.
FunctionRegistry	functionRegistry() Returns a function registry that can be used by the expression compiler to look up functions.
T	getProperty(T value, String name) Deprecated.
T	handleArgumentTypeError(Function function, String expectedType, String actualType) Throws ArgumentTypeException unless RuntimeConfiguration.silentTypeErrors is true, in which case it returns a null value (not Java null).
int	hashCode()
NodeFactory<T>	nodeFactory() Returns a node factory that can be used by the expression compiler to build the interpreter AST.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.burt.jmespath.Adapter

createArray, createBoolean, createNull, createNumber, createNumber, createObject, createString, getProperty, getPropertyNames, isTruthy, parseString, toList, toNumber, toString, typeOf

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

BaseRuntime

public BaseRuntime()

Create a new runtime with a default function registry.

BaseRuntime

public BaseRuntime(RuntimeConfiguration configuration)

Create a new runtime with configuration.

Method Detail

compile

public Expression<T> compile(String expression)

Description copied from interface: JmesPath

Compile a JMESPath expression into a reusable expression object.

The expression objects should be stateless and thread safe, but the exact details are up to the concrete implementations.

Specified by:

compile in interface JmesPath<T>

compare

public int compare(T value1,
                   T value2)

Basic implementation of Comparator.compare(T, T).

Subclasses should override this method if they have a more efficient way to compare booleans, numbers and strings than to convert them to Java types using Adapter.isTruthy(T), Adapter.toNumber(T), Adapter.toString(T), etc.

This only implements Comparator.compare(T, T) fully for null, number and string, for boolean array and object it only does equality – specifically this means that it will return 0 for equal booleans, objects or arrays, and -1 otherwise. The reason is that JMESPath doesn't have any mechanisms for comparing objects or arrays, and doesn't define how objects and arrays should be compared.

When the arguments are not of the same type -1 is returned.

Specified by:

compare in interface Comparator<T>

handleArgumentTypeError

public T handleArgumentTypeError(Function function,
                                 String expectedType,
                                 String actualType)

Throws ArgumentTypeException unless RuntimeConfiguration.silentTypeErrors is true, in which case it returns a null value (not Java null).

Specified by:

handleArgumentTypeError in interface Adapter<T>

functionRegistry

public FunctionRegistry functionRegistry()

Description copied from interface: Adapter

Returns a function registry that can be used by the expression compiler to look up functions.

Specified by:

functionRegistry in interface Adapter<T>

nodeFactory

public NodeFactory<T> nodeFactory()

Description copied from interface: Adapter

Returns a node factory that can be used by the expression compiler to build the interpreter AST.

Specified by:

nodeFactory in interface Adapter<T>

equals

public boolean equals(Object o)

Required method from the Comparator interface, returns true when the argument is of the same class, or a subclass of, the receiver.

Specified by:

equals in interface Comparator<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getProperty

@Deprecated
public T getProperty(T value,
                                 String name)

Deprecated.

Description copied from interface: Adapter

Returns the value of a property of an object. The first argument must be an object and the second argument may be the name of a property on that object. When the property does not exist a null value (not Java null) is returned.

Specified by:

getProperty in interface Adapter<T>