JsonPath Class

Namespace: Json.Path

Inheritance: JsonPath 🡒 object

Represents a JSON Path.

Properties

Name	Type	Summary
IsSingular	bool	Gets whether the path is a singular path. That is, it can only return a nodelist containing at most a single value.
Root	JsonPath	Gets a JSON Path with only a global root and no selectors, namely $.
Scope	PathScope	Gets the scope of the path.
Segments	PathSegment[]	Gets the segments of the path.

Methods

BuildString(StringBuilder builder)

Builds a string representation of the path using a System.Text.StringBuilder.

Declaration

public void BuildString(StringBuilder builder)

Parameter	Type	Description
builder	StringBuilder	The string builder.

Evaluate(JsonNode root, PathEvaluationOptions options)

Evaluates the path against a JSON instance.

Declaration

public PathResult Evaluate(JsonNode root, PathEvaluationOptions options)

Parameter	Type	Description
root	JsonNode	The root of the JSON instance.
options	PathEvaluationOptions	Evaluation options.

Returns

The results of the evaluation.

Parse(string source, PathParsingOptions options)

Parses a Json.Path.JsonPath from a string.

Declaration

public static JsonPath Parse(string source, PathParsingOptions options)

Parameter	Type	Description
source	string	The source string.
options	PathParsingOptions	(optional) The parsing options.

Returns

The parsed path.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

A string that represents the current object.

TryParse(string source, out JsonPath path, PathParsingOptions options)

Parses a Json.Path.JsonPath from a string.

Declaration

public static bool TryParse(string source, out JsonPath path, PathParsingOptions options)

Parameter	Type	Description
source	string	The source string.
options	out JsonPath	(optional) The parsing options.
path	PathParsingOptions	The parsed path, if successful; otherwise null.

Returns

True if successful; otherwise false.