net.obvj.jsonmerge.util

Class JsonPathExpression

java.lang.Object

net.obvj.jsonmerge.util.JsonPathExpression

public class JsonPathExpression
extends Object

An immutable object that represents a compiled JsonPath expression.

Since:

1.0.0

Author:

oswaldo.bapvic.jr

See Also:

JSONPath - XPath for JSON

Field Summary

Fields

Modifier and Type	Field and Description
static JsonPathExpression	ROOT A pre-compiled JsonPathExpression that represents the root element of a JSON document ('$').

Constructor Summary

Constructors

Constructor and Description
JsonPathExpression(String expression) Creates a compiled JsonPathExpression from the specified expression.

Method Summary

Modifier and Type	Method and Description
JsonPathExpression	append(String expression) Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and the given expression.
JsonPathExpression	appendChild(String name) Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and the given child element name.
JsonPathExpression	appendIndex(int index) Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and a given index.
JsonPathExpression	cleanUp() Performs a cleanup of the path associated with this JsonPathExpression.
boolean	equals(Object other)
int	hashCode()
String	toString() Returns the string representation of this JsonPathExpression, in the bracket-notation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROOT

public static final JsonPathExpression ROOT

A pre-compiled JsonPathExpression that represents the root element of a JSON document ('$').

Constructor Detail

JsonPathExpression

public JsonPathExpression(String expression)

Creates a compiled JsonPathExpression from the specified expression.

Parameters:

expression - the JsonPath expression to compile

Throws:

IllegalArgumentException - if the specified expression is null or empty

com.jayway.jsonpath.InvalidPathException - if the specified JsonPath expression is invalid

Method Detail

appendChild

public JsonPathExpression appendChild(String name)

Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and the given child element name.

Parameters:

name - the child name to be appended to the end of this JsonPathExpression

Returns:

a new, compiled JsonPathExpression

Throws:

com.jayway.jsonpath.InvalidPathException - if the resulting JsonPath expression is invalid

appendIndex

public JsonPathExpression appendIndex(int index)

Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and a given index.

Parameters:

index - the index to be appended to the end of this JsonPathExpression

Returns:

a new, compiled JsonPathExpression

Throws:

com.jayway.jsonpath.InvalidPathException - if the resulting JsonPath expression is invalid

Since:

1.1.0

append

public JsonPathExpression append(String expression)

Produces a new JsonPathExpression with the concatenation result of this JsonPathExpression and the given expression.

Parameters:

expression - a String representing the expression to be appended to the end of this JsonPathExpression

Returns:

a new, compiled JsonPathExpression

Throws:

com.jayway.jsonpath.InvalidPathException - if the resulting JsonPath expression is invalid

cleanUp

public JsonPathExpression cleanUp()

Performs a cleanup of the path associated with this JsonPathExpression.

During cleanup, arrays indexes are replaced with a wildcard character (*).

For example:

 new JsonPathExpression("$['foo'][0]['bar'][1]").cleanup(); // returns: $['foo'][*]['bar'][*]
 

Returns:

a new JsonPathExpression from the cleanup of this one

Since:

1.1.0

toString

public String toString()

Returns the string representation of this JsonPathExpression, in the bracket-notation. For example: $['store']['book'][0]['title']

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object