### Get Options

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Retrieves the set of options used by this configuration.

```APIDOC
## getOptions()

### Description
Returns the options used by this configuration.

### Method
Instance

### Returns
Set<Option>
```

--------------------------------

### Configuration.builder()

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Returns a new ConfigurationBuilder to start building a JSONPath configuration.

```APIDOC
## Static method in class com.jayway.jsonpath.Configuration

### Description
Returns a new ConfigurationBuilder

### Method
Static

### Signature
`builder()`
```

--------------------------------

### get() Method

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/function/latebinding/PathLateBindingValue.html

Obtains the value of the parameter at runtime.

```APIDOC
## get()

### Description
Obtain the value of the parameter at runtime using the parameter state and invocation of other late binding values rather than maintaining cached state which ends up in a global store and won't change as a result of external reference changes.

### Returns
- **Object** - the late value
```

--------------------------------

### get() Method

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/function/latebinding/JsonLateBindingValue.html

Evaluates the JSON document at the point of need.

```APIDOC
## get()

### Description
Evaluate the JSON document at the point of need using the JSON parameter and associated document model which may itself originate from yet another function thus recursively invoking late binding methods.

### Returns
* **Object** - the late value
```

--------------------------------

### Get Configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/JsonContext.html

Retrieves the configuration object used for reading JSON.

```APIDOC
## configuration

### Description
Returns the configuration used for reading.

### Method Signature
`Configuration configuration()`
```

--------------------------------

### get Method

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/cache/NOOPCache.html

Retrieves a JsonPath from the cache. In the NOOPCache, this method always returns null as nothing is ever stored.

```APIDOC
## get(String key)

### Description
Get the Cached JsonPath. This implementation always returns null.

### Method Signature
`JsonPath get(String key)`

### Parameters
* **key** (String) - The cache key to lookup the JsonPath.

### Returns
* JsonPath - Always null for NOOPCache.
```

--------------------------------

### isRootPath

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/CompiledPath.html

Checks if the path is a root path (starts with '$').

```APIDOC
## isRootPath()

### Description
Checks if this path is a root path.

### Returns
- **boolean**: true if the path starts with '$', false if it starts with '@'.
```

--------------------------------

### Default Configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Creates a configuration with default settings.

```APIDOC
## defaultConfiguration()

### Description
Creates a new configuration based on default values.

### Method
static

### Returns
Configuration
```

--------------------------------

### length

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/GsonJsonProvider.html

Gets the length of a JSON array or object.

```APIDOC
## length

### Description
Gets the number of entries in a JSON array or the number of properties in a JSON object.

### Method Signature
`int length(Object obj)`

### Parameters
* `obj` (Object) - The array or object whose length is to be determined.

### Returns
* `int` - The number of entries in the array or properties in the object.
```

--------------------------------

### JakartaMappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/JakartaMappingProvider.html

Provides details on how to instantiate the JakartaMappingProvider.

```APIDOC
## JakartaMappingProvider()

### Description
Default constructor for JakartaMappingProvider.

### Constructor
`JakartaMappingProvider()`

## JakartaMappingProvider(jakarta.json.bind.JsonbConfig jsonbConfiguration)

### Description
Constructor for JakartaMappingProvider that accepts a JsonbConfig.

### Constructor
`JakartaMappingProvider(jakarta.json.bind.JsonbConfig jsonbConfiguration)`
```

--------------------------------

### getRoot

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/CompiledPath.html

Gets the root token of the compiled path.

```APIDOC
## getRoot()

### Description
Gets the root token of the compiled path.

### Returns
- **RootPathToken**: The root token of the path.
```

--------------------------------

### Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JakartaJsonProvider.html

Details on how to instantiate the JakartaJsonProvider.

```APIDOC
## JakartaJsonProvider()

### Description
Constructs a new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider. JSON files, strings, and streams can be loaded, parsed, and navigated with JsonPath expressions, and values retrieved - but no changes to the loaded JSON document are permitted, and will yield exceptions.

### Method
`public JakartaJsonProvider()`
```

```APIDOC
## JakartaJsonProvider(boolean mutableJson)

### Description
Constructs a new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider, and optionally enables proxying of `JsonObject` and `JsonArray` entities to implement mutable JSON structures. By default, all structures and values produced and consumed by JSON-P are immutable. This comes at an extra cost to perfomance and memory consumption, so enable only if expected use cases include add/put/replace/delete operations on JSON document.

### Parameters
- **mutableJson** (boolean) - enable dynamic proxies for JSON structures

### Method
`public JakartaJsonProvider(boolean mutableJson)`
```

--------------------------------

### PathToken Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PathToken.html

Initializes a new PathToken instance.

```APIDOC
## PathToken()

### Description
Initializes a new PathToken instance.

### Constructor
`PathToken()`
```

--------------------------------

### Add Options

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Creates a new Configuration with additional options.

```APIDOC
## addOptions(Option... options)

### Description
Creates a new configuration by adding the new options to the options used in this configuration.

### Method
Instance

### Parameters
#### Path Parameters
- **options** (Option...) - The options to add.
```

--------------------------------

### length

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/AbstractJsonProvider.html

Gets the number of entries in a JSON array or object.

```APIDOC
## length
public int length(Object obj)

### Description
Get the length of an array or object.

Specified by:
`length` in interface `JsonProvider`

### Parameters
* `obj` (Object) - an array or an object

### Returns
* `int` - the number of entries in the array or object
```

--------------------------------

### get

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/cache/LRUCache.html

Retrieves a JsonPath object from the cache using its key.

```APIDOC
## JsonPath get(String key)

### Description
Get the Cached JsonPath.

### Parameters
#### Path Parameters
- **key** (String) - Required - cache key to lookup the JsonPath

### Returns
- **JsonPath** - The cached JsonPath object.
```

--------------------------------

### Criteria Creation and Basic Operators

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Criteria.html

Demonstrates how to create Criteria objects and use basic comparison operators like 'eq', 'ne', 'gt', 'gte', 'lt', 'lte'.

```APIDOC
## Criteria Methods

### `eq(Object o)`

Creates a criterion using equality.

### `is(Object o)`

Creates a criterion using equality.

### `ne(Object o)`

Creates a criterion using the `!=` operator.

### `gt(Object o)`

Creates a criterion using the `>` operator.

### `gte(Object o)`

Creates a criterion using the `>=` operator.

### `lt(Object o)`

Creates a criterion using the `<` operator.

### `lte(Object o)`

Creates a criterion using the `<=` operator.

### `regex(Pattern pattern)`

Creates a criterion using a Regex.

### `exists(boolean shouldExist)`

Check for existence (or lack thereof) of a field.

### `empty(boolean empty)`

The `notEmpty` operator checks that an array or String is empty.

### `size(int size)`

The `size` operator matches:

```

--------------------------------

### StandardDeviation Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/function/numeric/StandardDeviation.html

Initializes a new instance of the StandardDeviation class.

```APIDOC
## StandardDeviation()

### Description
Initializes a new instance of the StandardDeviation class.

### Constructor
public StandardDeviation()
```

--------------------------------

### Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/Jackson3JsonProvider.html

Provides information on how to initialize the Jackson3JsonProvider.

```APIDOC
## Jackson3JsonProvider()

### Description
Initializes the JacksonProvider with the default ObjectMapper and ObjectReader.

### Constructor
public Jackson3JsonProvider()

## Jackson3JsonProvider(ObjectMapper objectMapper)

### Description
Initializes the JacksonProvider with a custom ObjectMapper.

### Parameters
- **objectMapper** (ObjectMapper) - the ObjectMapper to use

### Constructor
public Jackson3JsonProvider(ObjectMapper objectMapper)

## Jackson3JsonProvider(ObjectMapper objectMapper, ObjectReader objectReader)

### Description
Initializes the JacksonProvider with a custom ObjectMapper and ObjectReader.

### Parameters
- **objectMapper** (ObjectMapper) - the ObjectMapper to use
- **objectReader** (ObjectReader) - the ObjectReader to use

### Constructor
public Jackson3JsonProvider(ObjectMapper objectMapper, ObjectReader objectReader)
```

--------------------------------

### options()

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/DefaultsImpl.html

Returns the default set of Options.

```APIDOC
## options()

### Description
Returns default setOptions.

### Method
public Set<Option> options()

### Returns
default setOptions
```

--------------------------------

### Default Configuration Creation

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Provides a static method to create a configuration with default settings.

```APIDOC
## defaultConfiguration

### Description
Creates and returns a new Configuration instance initialized with default values.

### Method
`public static Configuration defaultConfiguration()`

### Returns
A new Configuration instance based on default settings.
```

--------------------------------

### isRootPath()

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/Path.html

Checks if the JSON path starts from the root of the JSON document.

```APIDOC
## isRootPath()

### Description
Checks if this path starts with '$' or '@'.

### Returns
* **boolean** - true if this path starts with '$' and false if the path starts with '@'
```

--------------------------------

### JsonOrgMappingProvider Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/JsonOrgMappingProvider.html

Initializes a new instance of the JsonOrgMappingProvider class.

```APIDOC
## JsonOrgMappingProvider()

### Description
Initializes a new instance of the JsonOrgMappingProvider class.

### Constructor
`JsonOrgMappingProvider()`
```

--------------------------------

### configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PredicateContextImpl.html

Returns the configuration to use when evaluating.

```APIDOC
## configuration

### Description
Returns the configuration to use when evaluating.

### Returns
* **Configuration** - The configuration object.
```

--------------------------------

### Get Mapping Provider

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Retrieves the mapping provider used by this configuration.

```APIDOC
## mappingProvider()

### Description
Returns `MappingProvider` used by this configuration.

### Method
Instance

### Returns
MappingProvider
```

--------------------------------

### Get JSON Provider

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Retrieves the JSON provider used by this configuration.

```APIDOC
## jsonProvider()

### Description
Returns `JsonProvider` used by this configuration.

### Method
Instance

### Returns
JsonProvider
```

--------------------------------

### GsonMappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/GsonMappingProvider.html

Provides different ways to instantiate the GsonMappingProvider.

```APIDOC
## GsonMappingProvider Constructors

### GsonMappingProvider()

Default constructor.

### GsonMappingProvider(com.google.gson.Gson gson)

Constructor that accepts a pre-configured Gson instance.

### GsonMappingProvider(Callable<com.google.gson.Gson> factory)

Constructor that accepts a factory for creating Gson instances.
```

--------------------------------

### Get Evaluation Listeners

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Retrieves the currently registered evaluation listeners.

```APIDOC
## getEvaluationListeners()

### Description
Returns the evaluation listeners registered in this configuration.

### Method
Instance

### Returns
Collection<EvaluationListener>
```

--------------------------------

### Configuration.ConfigurationBuilder.build()

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Builds the immutable Configuration instance.

```APIDOC
## Method in class com.jayway.jsonpath.Configuration.ConfigurationBuilder

### Description
Builds the immutable Configuration instance.

### Method
Instance

### Signature
`build()`
```

--------------------------------

### get(String) - Cache

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Retrieves a cached JsonPath using a String key.

```APIDOC
## get(String)

### Description
Retrieves a cached JsonPath using a String key.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **JsonPath** (Object) - The cached JsonPath object.

#### Response Example
N/A
```

--------------------------------

### Configuration and Parsing

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/JsonPath.html

Methods for creating parse contexts with custom configurations or JSON providers.

```APIDOC
## using(Configuration configuration)

### Description
Creates a `ParseContext` that can be used to parse JSON input with a specific configuration.

### Method
`using`

### Parameters
- **configuration** (Configuration) - The configuration to use for parsing.

### Return Type
`ParseContext`
```

```APIDOC
## using(JsonProvider provider)

### Description
Creates a `ParseContext` that can be used to parse JSON input with a specific JSON provider. Deprecated.

### Method
`using`

### Parameters
- **provider** (JsonProvider) - The JSON provider to use for parsing.

### Return Type
`ParseContext`
```

--------------------------------

### length(Object obj)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JettisonProvider.html

Gets the number of entries in a JSON array or object.

```APIDOC
## length(Object obj)

### Description
Get the length of an array or object.

### Signature
public int length(Object obj)

### Parameters
* `obj` (Object) - an array or an object

### Returns
the number of entries in the array or object
```

--------------------------------

### Get JSON String

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/WriteContext.html

Returns the JSON model as a formatted JSON string.

```APIDOC
## jsonString

String jsonString()

Returns the JSON model that this context is operating on as a JSON string.

Returns:
    json model as string
```

--------------------------------

### ConfigurationBuilder Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.ConfigurationBuilder.html

Initializes a new instance of the ConfigurationBuilder class.

```APIDOC
## ConfigurationBuilder()

### Description
Initializes a new instance of the ConfigurationBuilder class.

### Constructor
`ConfigurationBuilder()`
```

--------------------------------

### JettisonProvider Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JettisonProvider.html

Initializes a new instance of the JettisonProvider class.

```APIDOC
## JettisonProvider()

### Description
Constructs a new JettisonProvider.

### Constructor
`JettisonProvider()`
```

--------------------------------

### Get JSON Model

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/WriteContext.html

Returns the underlying JSON model that the context is operating on.

```APIDOC
## json

<T> T json()

Returns the JSON model that this context is operating on.

Returns:
    json model
```

--------------------------------

### JettisonProvider Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JettisonProvider.html

Initializes a new instance of the JettisonProvider class.

```APIDOC
## JettisonProvider Constructor

### Description
Initializes a new instance of the JettisonProvider class.

### Signature
public JettisonProvider()
```

--------------------------------

### Get JSON Model

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/WriteContext.html

Returns the underlying JSON model that the context is operating on.

```java
<T> T json()
Returns the JSON model that this context is operating on 

Returns:
    json model
```

--------------------------------

### Get Configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/WriteContext.html

Retrieves the immutable configuration used for reading the JSON document.

```java
Configuration configuration()
Returns the configuration used for reading 

Returns:
    an immutable configuration
```

--------------------------------

### Set Options

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Creates a new Configuration with a specific set of options.

```APIDOC
## setOptions(Option... options)

### Description
Creates a new configuration with the provided options.

### Method
Instance

### Parameters
#### Path Parameters
- **options** (Option...) - The options to set.
```

--------------------------------

### getPathList

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/EvaluationContext.html

Convenience method to get a list of hits as String path representations.

```APIDOC
## getPathList

### Description
Convenience method to get list of hits as String path representations.

### Method
`List<String> getPathList()`

### Returns
- `List<String>`: list of path representations
```

--------------------------------

### JacksonJsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JacksonJsonProvider.html

Provides details on how to initialize the JacksonJsonProvider with default or custom Jackson ObjectMapper and ObjectReader.

```APIDOC
## JacksonJsonProvider()

### Description
Initializes the JacksonProvider with the default ObjectMapper and ObjectReader.

### Constructor
`JacksonJsonProvider()`
```

```APIDOC
## JacksonJsonProvider(ObjectMapper objectMapper)

### Description
Initializes the JacksonProvider with a custom ObjectMapper.

### Parameters
* **objectMapper** (com.fasterxml.jackson.databind.ObjectMapper) - the ObjectMapper to use

### Constructor
`JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper)`
```

```APIDOC
## JacksonJsonProvider(ObjectMapper objectMapper, ObjectReader objectReader)

### Description
Initializes the JacksonProvider with a custom ObjectMapper and ObjectReader.

### Parameters
* **objectMapper** (com.fasterxml.jackson.databind.ObjectMapper) - the ObjectMapper to use
* **objectReader** (com.fasterxml.jackson.databind.ObjectReader) - the ObjectReader to use

### Constructor
`JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.databind.ObjectReader objectReader)`
```

--------------------------------

### Evaluation Context Path List

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Convenience method to get list of hits as String path representations.

```APIDOC
## getPathList()

### Description
Convenience method to get list of hits as String path representations.

### Method
Method

### Signature
`getPathList()`

### Returns
List of String path representations.
```

--------------------------------

### Configuration Options

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Retrieves the options used by this configuration.

```APIDOC
## getOptions()

### Description
Returns the options used by this configuration.

### Method
Method

### Signature
`getOptions()`

### Returns
Options used by the configuration.
```

--------------------------------

### Jackson3MappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/Jackson3MappingProvider.html

Provides two constructors for initializing the Jackson3MappingProvider. One with default settings and another allowing a custom ObjectMapper.

```APIDOC
## Jackson3MappingProvider()

### Description
Initializes a new instance of the `Jackson3MappingProvider` with default Jackson 3 ObjectMapper settings.

### Constructor
`Jackson3MappingProvider()`

### Parameters
None
```

```APIDOC
## Jackson3MappingProvider(tools.jackson.databind.ObjectMapper objectMapper)

### Description
Initializes a new instance of the `Jackson3MappingProvider` with a provided Jackson 3 `ObjectMapper`.

### Constructor
`Jackson3MappingProvider(ObjectMapper objectMapper)`

### Parameters
* **objectMapper** (tools.jackson.databind.ObjectMapper) - The `ObjectMapper` to use for JSON mapping.
```

--------------------------------

### Add Value to Array in JSON

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/WriteContext.html

Adds a value to an array at a specified path. Example demonstrates adding to a list.

```java
DocumentContext add(String path, Object value, Predicate... filters)
Add value to array 
```
 
 List array = new ArrayList(){
      add(0);
      add(1);
 };

 JsonPath.parse(array).add("$", 2);

 assertThat(array).containsExactly(0,1,2);
 
 
```


Parameters:
    `path` - path to array     `value` - value to add     `filters` - filters 

Returns:
    a document context
```

```java
DocumentContext add(JsonPath path, Object value)
Add value to array at the given path 

Parameters:
    `path` - path to array     `value` - value to add 

Returns:
    a document context
```

--------------------------------

### Configuration Builder

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Provides a static method to obtain a builder for creating `Configuration` objects.

```APIDOC
## builder

### Description
Returns a new `ConfigurationBuilder` instance, which can be used to construct a `Configuration` object step-by-step.

### Method
`public static Configuration.ConfigurationBuilder builder()`

### Returns
A new ConfigurationBuilder instance.
```

--------------------------------

### Get JSON String

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/ReadContext.html

Returns the entire JSON model as a formatted JSON string. Useful for logging or displaying the complete JSON content.

```java
String jsonString()
```

--------------------------------

### Get Configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/ReadContext.html

Retrieves the immutable configuration object used by this ReadContext. Provides access to settings like default parsers or JSON providers.

```java
Configuration configuration()
```

--------------------------------

### Utils.join methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Static methods for joining strings.

```APIDOC
## join(String, Iterable<?>) - Static method in class com.jayway.jsonpath.internal.Utils

### Method Signature
`static String join(String separator, Iterable<?> objects)`

## join(String, String, Iterable<?>) - Static method in class com.jayway.jsonpath.internal.Utils

### Method Signature
`static String join(String separator, String prefix, Iterable<?> objects)`
```

--------------------------------

### JacksonMappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/JacksonMappingProvider.html

Provides constructors for initializing the JacksonMappingProvider.

```APIDOC
## JacksonMappingProvider()

### Description
Initializes a new instance of the JacksonMappingProvider with default Jackson ObjectMapper.

### Constructor
public JacksonMappingProvider()
```

```APIDOC
## JacksonMappingProvider(ObjectMapper objectMapper)

### Description
Initializes a new instance of the JacksonMappingProvider with a custom Jackson ObjectMapper.

### Constructor
public JacksonMappingProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```

--------------------------------

### Add value to array using JsonPath

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/JsonContext.html

Demonstrates adding a value to an array at a specified path. This example shows how to append an element to an existing array.

```java
List array = new ArrayList(){{
      add(0);
      add(1);
 }};

 JsonPath.parse(array).add("$", 2);

 assertThat(array).containsExactly(0,1,2);
```

--------------------------------

### JsonSmartMappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/JsonSmartMappingProvider.html

Provides constructors for initializing JsonSmartMappingProvider. Users can create an instance with default settings, a custom JsonReader factory, or a pre-configured JsonReader.

```APIDOC
## Constructors

### JsonSmartMappingProvider()

Default constructor.

### JsonSmartMappingProvider(Callable<net.minidev.json.writer.JsonReader> factory)

Constructor that accepts a factory for creating JsonReader instances.

### JsonSmartMappingProvider(net.minidev.json.writer.JsonReader jsonReader)

Constructor that accepts a pre-configured JsonReader instance.
```

--------------------------------

### REQUIRE_PROPERTIES Option Example

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Option.html

When evaluating an indefinite path, this option enforces that properties defined in the path must exist. Without it, missing properties are ignored.

```json
[
     {
         "a" : "a-val",
         "b" : "b-val"
     },
     {
         "a" : "a-val",
     }
 ]
```

```text
evaluating the path "$[*].b" If REQUIRE_PROPERTIES option is present PathNotFoundException is thrown. If REQUIRE_PROPERTIES option is not present ["b-val"] is returned.
```

--------------------------------

### Get JSON Model

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/ReadContext.html

Returns the underlying JSON model (e.g., a Map or List) that the ReadContext is operating on. Allows direct manipulation or inspection of the JSON structure.

```java
<T> T json()
```

--------------------------------

### TapestryMappingProvider Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/TapestryMappingProvider.html

Initializes a new instance of the TapestryMappingProvider class.

```APIDOC
## TapestryMappingProvider()

### Description
Initializes a new instance of the TapestryMappingProvider class.

### Constructor
public TapestryMappingProvider()
```

--------------------------------

### DEFAULT_PATH_LEAF_TO_NULL Option Example

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Option.html

Illustrates how the DEFAULT_PATH_LEAF_TO_NULL option affects the return value when a path leaf is missing. Without the flag, missing leaves are omitted; with the flag, they are represented as null.

```json
[
      {
         "foo" : "foo1",
         "bar" : "bar1"
      }
      {
         "foo" : "foo2"
      }
 ]
```

```text
the path : "$[*].bar" Without flag ["bar1"] is returned With flag ["bar1", null] is returned
```

--------------------------------

### parse(String json, Configuration configuration)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/JsonPath.html

Parses the given JSON input as a String using a provided Configuration and returns a DocumentContext for path evaluation.

```APIDOC
## parse(String json, Configuration configuration)

### Description
Parses the given JSON input using the provided `Configuration` and returns a `DocumentContext` for path evaluation.

### Method
static DocumentContext

### Parameters
* `json` - input

### Returns
a read context
```

--------------------------------

### PathTokenFactory Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PathTokenFactory.html

Initializes a new instance of the PathTokenFactory class.

```APIDOC
## PathTokenFactory Constructor

### Description
Initializes a new instance of the PathTokenFactory class.

### Constructor
`PathTokenFactory()`
```

--------------------------------

### get() - JsonLateBindingValue

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Evaluates the JSON document at the point of need using the JSON parameter and associated document model, which may originate from another function, recursively invoking late binding methods.

```APIDOC
## get()

### Description
Evaluates the JSON document at the point of need using the JSON parameter and associated document model, which may originate from another function, recursively invoking late binding methods.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### get() - ILateBindingValue

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Obtains the value of a parameter at runtime using parameter state and invocation of other late binding values, avoiding cached state that won't change due to external reference changes.

```APIDOC
## get()

### Description
Obtains the value of a parameter at runtime using parameter state and invocation of other late binding values, avoiding cached state that won't change due to external reference changes.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### build

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.ConfigurationBuilder.html

Builds and returns the immutable Configuration object.

```APIDOC
## build

### Description
Builds and returns the immutable Configuration object.

### Method Signature
`Configuration build()`
```

--------------------------------

### parse(File json, Configuration configuration)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/JsonPath.html

Parses the given JSON input as a File using a provided Configuration and returns a DocumentContext for path evaluation. This method can throw an IOException.

```APIDOC
## parse(File json, Configuration configuration)

### Description
Parses the given JSON input using the provided `Configuration` and returns a `DocumentContext` for path evaluation.

### Method
static DocumentContext

### Parameters
* `json` - input

### Returns
a read context

### Throws
`IOException`
```

--------------------------------

### JsonOrgJsonProvider Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JsonOrgJsonProvider.html

Initializes a new instance of the JsonOrgJsonProvider class.

```APIDOC
## Constructor Details
### JsonOrgJsonProvider
public JsonOrgJsonProvider()
```

--------------------------------

### StandardDeviation.next Method

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/function/numeric/StandardDeviation.html

Defines the next value in the array to the mathematical function.

```APIDOC
## next(Number value)

### Description
Defines the next value in the array to the mathematical function.

### Method
protected void next(Number value)

### Parameters
#### Path Parameters
- **value** (Number) - The numerical value to process next
```

--------------------------------

### KeySetFunction Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/function/json/KeySetFunction.html

Initializes a new instance of the KeySetFunction class.

```APIDOC
## KeySetFunction()

### Description
Constructs a new KeySetFunction.

### Constructor
`KeySetFunction()`
```

--------------------------------

### Index Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/function/sequence/Index.html

Constructs a new Index object.

```APIDOC
## Index()

### Description
Constructs a new Index object.

### Constructor
`Index()`
```

--------------------------------

### Jackson3MappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Constructors for Jackson3MappingProvider.

```APIDOC
## Jackson3MappingProvider()

### Constructor
`Jackson3MappingProvider()`

## Jackson3MappingProvider(ObjectMapper)

### Constructor
`Jackson3MappingProvider(ObjectMapper objectMapper)`
```

--------------------------------

### JakartaMappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Constructors for JakartaMappingProvider.

```APIDOC
## JakartaMappingProvider()

### Constructor
`JakartaMappingProvider()`

## JakartaMappingProvider(JsonbConfig)

### Constructor
`JakartaMappingProvider(JsonbConfig jsonbConfig)`
```

--------------------------------

### Configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/WriteContext.html

Returns the configuration used for reading the JSON document.

```APIDOC
## configuration

Configuration configuration()

Returns the configuration used for reading.

Returns:
    an immutable configuration
```

--------------------------------

### JakartaJsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JakartaJsonProvider.html

Provides constructors for initializing the JakartaJsonProvider.

```APIDOC
## JakartaJsonProvider()

### Description
Constructs a new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider.

### Constructor
`JakartaJsonProvider()`
```

```APIDOC
## JakartaJsonProvider(boolean mutableJson)

### Description
Constructs a new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider, and optionally enables proxying of `JsonObject` and `JsonArray` entities to implement mutable JSON structures.

### Constructor
`JakartaJsonProvider(boolean mutableJson)`

### Parameters
* **mutableJson** (boolean) - Optional - If true, enables proxying for mutable JSON structures.
```

--------------------------------

### Configuration Defaults

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Creates a new configuration based on default values.

```APIDOC
## defaultConfiguration()

### Description
Creates a new configuration based on default values.

### Method
Static method

### Class
com.jayway.jsonpath.Configuration
```

--------------------------------

### FunctionPathToken Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/FunctionPathToken.html

Initializes a new instance of the FunctionPathToken class with a path fragment and a list of parameters.

```APIDOC
## FunctionPathToken Constructor

### Signature
`public FunctionPathToken(String pathFragment, List<Parameter> parameters)`

### Description
Constructs a `FunctionPathToken` with the given path fragment and parameters.
```

--------------------------------

### Read from File with Configuration

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Applies this JsonPath to the provided JSON file with a specific configuration.

```APIDOC
## read(File, Configuration)

### Description
Applies this JsonPath to the provided json file.

### Method
Not specified (likely part of an object's method)

### Endpoint
Not applicable (SDK method)

### Parameters
- **file** (File) - The JSON file to read from.
- **configuration** (Configuration) - The configuration to use.
```

--------------------------------

### Criteria Creation

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Criteria.html

Static factory methods to initiate the creation of a Criteria object.

```APIDOC
## where(Path key)

### Description
Static factory method to create a Criteria using the provided key.

### Method
`static Criteria where(Path key)`

### Parameters
#### Path Parameters
- **key** (Path) - Description of the field name.

### Returns
the new criteria
```

```APIDOC
## where(String key)

### Description
Static factory method to create a Criteria using the provided key.

### Method
`static Criteria where(String key)`

### Parameters
#### Path Parameters
- **key** (String) - Description of the field name.

### Returns
the new criteria
```

--------------------------------

### MappingException Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/mapper/MappingException.html

Provides details on how to instantiate a MappingException.

```APIDOC
## MappingException(Throwable cause)

### Description
Constructs a new MappingException with the specified cause.

### Constructor
`MappingException(Throwable cause)`

### Parameters
* **cause** (Throwable) - The underlying cause of the exception.
```

```APIDOC
## MappingException(String message)

### Description
Constructs a new MappingException with the specified detail message.

### Constructor
`MappingException(String message)`

### Parameters
* **message** (String) - The detail message.
```

--------------------------------

### GsonMappingProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Provides constructors for initializing the GsonMappingProvider, supporting default, customized Gson objects, or a callable Gson object.

```APIDOC
## GsonMappingProvider()

### Description
Initializes the `GsonMappingProvider`.

### Constructor
`public GsonMappingProvider()`

## GsonMappingProvider(Gson gson)

### Description
Initializes the `GsonMappingProvider`.

### Constructor
`public GsonMappingProvider(Gson gson)`

## GsonMappingProvider(Callable<Gson> gsonProvider)

### Description
Initializes the `GsonMappingProvider`.

### Constructor
`public GsonMappingProvider(Callable<Gson> gsonProvider)`
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/AbstractJsonProvider.html

The default constructor for the AbstractJsonProvider class.

```APIDOC
## AbstractJsonProvider
public AbstractJsonProvider()

### Description
Default constructor.
```

--------------------------------

### Set JSON Provider

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Creates a new Configuration with a specified JSON provider.

```APIDOC
## jsonProvider(JsonProvider newJsonProvider)

### Description
Creates a new Configuration based on the given `JsonProvider`.

### Method
Instance

### Parameters
#### Path Parameters
- **newJsonProvider** (JsonProvider) - The new JSON provider to use.
```

--------------------------------

### PredicateContextImpl Constructor

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PredicateContextImpl.html

Constructs a new PredicateContextImpl with the specified context document, root document, configuration, and document path cache.

```APIDOC
## PredicateContextImpl Constructor

### Description
Constructs a new PredicateContextImpl.

### Parameters
* **contextDocument** (Object) - The current context document.
* **rootDocument** (Object) - The root document of the JSON.
* **configuration** (Configuration) - The configuration to use.
* **documentPathCache** (HashMap<Path,Object>) - A cache for document paths.
```

--------------------------------

### mappingProvider()

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/DefaultsImpl.html

Returns the default MappingProvider implementation.

```APIDOC
## mappingProvider()

### Description
Returns the default `MappingProvider`.

### Method
public MappingProvider mappingProvider()

### Returns
default mapping provider
```

--------------------------------

### PathRef Creation Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/PathRef.html

Static factory methods for creating PathRef instances.

```APIDOC
## PathRef Creation

### Description
Static methods to create `PathRef` instances for different scenarios.

### Methods

#### `create(Object obj, String property)`
Creates a `PathRef` for a property within an object.

#### `create(Object obj, Collection<String> properties)`
Creates a `PathRef` for a collection of properties within an object.

#### `create(Object array, int index)`
Creates a `PathRef` for an element within an array.

#### `createRoot(Object root)`
Creates a `PathRef` for the root of a JSON structure.
```

--------------------------------

### parse(Object json, Configuration configuration)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/JsonPath.html

Parses the given JSON input using a provided Configuration and returns a DocumentContext for path evaluation.

```APIDOC
## parse(Object json, Configuration configuration)

### Description
Parses the given JSON input using the provided `Configuration` and returns a `DocumentContext` for path evaluation.

### Method
static DocumentContext

### Parameters
* `json` - input

### Returns
a read context
```

--------------------------------

### parse(InputStream json, Configuration configuration)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/JsonPath.html

Parses the given JSON input as an InputStream using a provided Configuration and returns a DocumentContext for path evaluation.

```APIDOC
## parse(InputStream json, Configuration configuration)

### Description
Parses the given JSON input using the provided `Configuration` and returns a `DocumentContext` for path evaluation.

### Method
static DocumentContext

### Parameters
* `json` - input

### Returns
a read context
```

--------------------------------

### PathRef Static Method

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Static method for creating a root reference.

```APIDOC
## createRoot(Object)

### Description
Creates a root reference from an object.

### Method
Static method

### Class
com.jayway.jsonpath.internal.PathRef
```

--------------------------------

### Configuration Builder

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Provides a builder to construct a Configuration object.

```APIDOC
## builder()

### Description
Returns a new ConfigurationBuilder.

### Method
static

### Returns
Configuration.ConfigurationBuilder
```

--------------------------------

### Jackson3JsonNodeJsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/Jackson3JsonNodeJsonProvider.html

Provides constructors to initialize the Jackson3JsonNodeJsonProvider.

```APIDOC
## Jackson3JsonNodeJsonProvider()

### Description
Initializes the JacksonJsonNodeJsonProvider with the default ObjectMapper and ObjectReader.

### Constructor
`Jackson3JsonNodeJsonProvider()`
```

```APIDOC
## Jackson3JsonNodeJsonProvider(ObjectMapper objectMapper)

### Description
Initializes the JacksonJsonNodeJsonProvider with a custom ObjectMapper and ObjectReader.

### Constructor
`Jackson3JsonNodeJsonProvider(tools.jackson.databind.ObjectMapper objectMapper)`
```

--------------------------------

### GsonJsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/GsonJsonProvider.html

Constructors for GsonJsonProvider.

```APIDOC
## GsonJsonProvider()

### Description
Initializes the `GsonJsonProvider` using the default `Gson` object.

### Constructor
`GsonJsonProvider()`
```

```APIDOC
## GsonJsonProvider(com.google.gson.Gson gson)

### Description
Initializes the `GsonJsonProvider` using a customized `Gson` object.

### Constructor
`GsonJsonProvider(com.google.gson.Gson gson)`
```

--------------------------------

### GsonJsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/GsonJsonProvider.html

Constructors for GsonJsonProvider.

```APIDOC
## Constructor Details

### GsonJsonProvider
public GsonJsonProvider()
Initializes the `GsonJsonProvider` using the default `Gson` object.

### GsonJsonProvider
public GsonJsonProvider(com.google.gson.Gson gson)
Initializes the `GsonJsonProvider` using a customized `Gson` object.

Parameters:
    `gson` - the customized Gson object.
```

--------------------------------

### WildcardPathToken Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/WildcardPathToken.html

Provides information about the constructors for the WildcardPathToken class.

```APIDOC
## WildcardPathToken()

### Description
Constructs a new WildcardPathToken.

### Constructor
`WildcardPathToken()`
```

--------------------------------

### RootPathToken Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/RootPathToken.html

This section details the concrete methods provided by the RootPathToken class.

```APIDOC
## Class: RootPathToken

### Description
Represents the root of a JSONPath.

### Methods

#### `append(PathToken next)`
Appends a PathToken to the current root.

#### `evaluate(String currentPath, PathRef pathRef, Object model, EvaluationContextImpl ctx)`
Evaluates the JSONPath starting from the root.

#### `getPathFragment()`
Returns the path fragment for the root token.

#### `getPathTokenAppender()`
Returns the PathTokenAppender for the root token.

#### `getTail()`
Returns the last token in the path.

#### `getTokenCount()`
Returns the number of tokens in the path.

#### `isFunctionPath()`
Checks if the path is a function path.

#### `isTokenDefinite()`
Checks if the token is definite.
```

--------------------------------

### options (Set)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.ConfigurationBuilder.html

Configures the JSONPath evaluation options using a Set of Option flags.

```APIDOC
## options (Set)

### Description
Configures the JSONPath evaluation options using a Set of Option flags.

### Method Signature
`Configuration.ConfigurationBuilder options(Set<Option> options)`
```

--------------------------------

### Configuration Defaults

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/Configuration.html

Allows setting default configuration values for JSONPath.

```APIDOC
## setDefaults

### Description
Sets the default configuration for JSONPath operations.

### Method
`public static void setDefaults(Configuration.Defaults defaults)`

### Parameters
* `defaults` (Configuration.Defaults) - The default configuration settings to apply.
```

--------------------------------

### PropertyPathToken Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PropertyPathToken.html

Constructors for creating a PropertyPathToken instance.

```APIDOC
## PropertyPathToken Constructor

### Description
Initializes a new instance of the `PropertyPathToken` class.

### Signature
`PropertyPathToken(List<String> properties, char stringDelimiter)`

### Parameters
* **properties** (List<String>) - A list of properties.
* **stringDelimiter** (char) - The character used as a string delimiter.
```

--------------------------------

### mappingProvider(MappingProvider)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Creates a new Configuration based on the given MappingProvider.

```APIDOC
## mappingProvider(MappingProvider)

### Description
Creates a new Configuration based on the given `MappingProvider`.

### Method
Not specified (likely part of a Java API)

### Parameters
* **MappingProvider** (MappingProvider) - The mapping provider to use for the configuration.
```

--------------------------------

### JacksonJsonNodeJsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/JacksonJsonNodeJsonProvider.html

Provides constructors to initialize the JacksonJsonNodeJsonProvider.

```APIDOC
## JacksonJsonNodeJsonProvider()

### Description
Initializes the JacksonJsonNodeJsonProvider with the default ObjectMapper and ObjectReader.

### Constructor
`JacksonJsonNodeJsonProvider()`
```

```APIDOC
## JacksonJsonNodeJsonProvider(ObjectMapper objectMapper)

### Description
Initializes the JacksonJsonNodeJsonProvider with a custom ObjectMapper and ObjectReader.

### Constructor
`JacksonJsonNodeJsonProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper)`
```

--------------------------------

### ValueNodes.ClassNode Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/filter/ValueNodes.ClassNode.html

This section outlines the concrete methods provided by the ValueNodes.ClassNode class, including its own methods and those inherited from ValueNode.

```APIDOC
## ValueNodes.ClassNode

### Methods

- `asClassNode()`: Returns this node as a ClassNode.
- `equals(Object o)`: Checks if this node is equal to another object.
- `getClazz()`: Retrieves the Class object represented by this node.
- `isClassNode()`: Returns true if this node is a ClassNode.
- `toString()`: Returns a string representation of the node.
- `type(Predicate.PredicateContext ctx)`: Determines the type of the node within a given predicate context.
```

--------------------------------

### PredicatePathToken Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PredicatePathToken.html

This section details the concrete methods implemented by the PredicatePathToken class.

```APIDOC
## PredicatePathToken

### Description
Represents a path token that handles predicates in JSONPath expressions.

### Methods

#### `accept`
```java
public boolean accept(Object obj, Object root, Configuration configuration, EvaluationContextImpl evaluationContext)
```

Checks if this token can accept the given object.

#### `evaluate`
```java
public void evaluate(String currentPath, PathRef ref, Object model, EvaluationContextImpl ctx)
```

Evaluates the path token against the given model.

#### `getPathFragment`
```java
public String getPathFragment()
```

Returns the string representation of this path token.

#### `isTokenDefinite`
```java
public boolean isTokenDefinite()
```

Indicates whether this token is definite (i.e., it resolves to a single value or set of values).

### Inherited Methods

Methods inherited from `com.jayway.jsonpath.internal.path.PathToken` include `equals`, `getNext`, `getTokenCount`, `handleArrayIndex`, `hashCode`, `invoke`, `isPathDefinite`, `setNext`, `setUpstreamArrayIndex`, `toString`.

Methods inherited from `java.lang.Object` include `clone`, `finalize`, `getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait`.
```

--------------------------------

### evaluate

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/path/PredicateContextImpl.html

Evaluates the given path within the current context.

```APIDOC
## evaluate

### Description
Evaluates the given path within the current context.

### Parameters
* **path** (Path) - The path to evaluate.

### Returns
* **Object** - The result of the evaluation.
```

--------------------------------

### PathNode Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/internal/filter/ValueNodes.PathNode.html

This section details the concrete methods available on the PathNode class, including methods for checking existence, retrieving the path, and evaluating the node within a predicate context.

```APIDOC
## PathNode Methods

### `getPath()`

Retrieves the `Path` object associated with this `PathNode`.

### `isExistsCheck()`

Returns `true` if this `PathNode` represents an existence check, `false` otherwise.

### `shouldExists()`

Indicates whether the path represented by this node should exist.

### `type(Predicate.PredicateContext ctx)`

Determines and returns the `Class<?>` type of the value at the path represented by this node, given a `PredicateContext`.

### `isPathNode()`

Overrides the superclass method to return `true`, indicating that this node is indeed a `PathNode`.

### `asPathNode()`

Overrides the superclass method to return `this`, as this node is already a `PathNode`.

### `asExistsCheck(boolean shouldExist)`

Configures this `PathNode` to perform an existence check, setting the desired existence state.

### `toString()`

Overrides the `Object.toString()` method to provide a string representation of the `PathNode`.
```

--------------------------------

### Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/json/Jackson3JsonProvider.html

Details the methods for JSON parsing, object creation, and conversion to JSON string.

```APIDOC
## getObjectMapper()

### Description
Returns the ObjectMapper used by this provider.

### Method
public tools.jackson.databind.ObjectMapper getObjectMapper()

## parse(String json)

### Description
Parses the given JSON string.

### Parameters
- **json** (String) - JSON string to parse

### Returns
Object representation of the JSON.

### Throws
- InvalidJsonException

### Method
public Object parse(String json) throws InvalidJsonException

## parse(byte[] json)

### Description
Parses the given JSON bytes in UTF-8 encoding.

### Parameters
- **json** (byte[]) - JSON bytes to parse

### Returns
Object representation of the JSON.

### Throws
- InvalidJsonException

### Method
public Object parse(byte[] json) throws InvalidJsonException

## parse(InputStream jsonStream, String charset)

### Description
Parses the given JSON string from an input stream.

### Parameters
- **jsonStream** (InputStream) - Input stream to parse
- **charset** (String) - Charset to use

### Returns
Object representation of the JSON.

### Throws
- InvalidJsonException

### Method
public Object parse(InputStream jsonStream, String charset) throws InvalidJsonException

## toJson(Object obj)

### Description
Converts the given object to a JSON string.

### Parameters
- **obj** (Object) - Object to transform

### Returns
JSON representation of the object.

### Method
public String toJson(Object obj)

## createArray()

### Description
Creates a provider-specific JSON array.

### Returns
A new array.

### Method
public List<Object> createArray()

## createMap()

### Description
Creates a provider-specific JSON object.

### Returns
A new object.

### Method
public Object createMap()
```

--------------------------------

### read (json string, configuration)

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/JsonPath.html

Applies this JsonPath to the provided JSON string with a specific configuration.

```APIDOC
## read

### Description
Applies this JsonPath to the provided json string.

### Method
public <T> T read(String json, Configuration configuration)

### Parameters
- `json` (String) - a json string
- `configuration` (Configuration) - configuration to use

### Returns
list of objects matched by the given path
```

--------------------------------

### CacheProvider Methods

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/com/jayway/jsonpath/spi/cache/CacheProvider.html

This section details the static methods available in the CacheProvider class for managing the cache.

```APIDOC
## getCache()

### Description
Retrieves the current cache instance.

### Method
static

### Returns
Cache - The current cache instance.

## setCache(Cache cache)

### Description
Sets the cache instance to be used by JsonPath.

### Method
static

### Parameters
#### Path Parameters
- **cache** (Cache) - Required - The cache instance to set.
```

--------------------------------

### Jackson3JsonProvider Constructors

Source: https://javadoc.io/doc/com.jayway.jsonpath/json-path/3.0.0/index-all.html

Initializes the Jackson3JsonProvider with default or custom ObjectMapper and ObjectReader.

```APIDOC
## Jackson3JsonProvider()

### Description
Initialize the JacksonProvider with the default ObjectMapper and ObjectReader.

### Constructor
`Jackson3JsonProvider()`

## Jackson3JsonProvider(ObjectMapper)

### Description
Initialize the JacksonProvider with a custom ObjectMapper.

### Constructor
`Jackson3JsonProvider(ObjectMapper objectMapper)`

## Jackson3JsonProvider(ObjectMapper, ObjectReader)

### Description
Initialize the JacksonProvider with a custom ObjectMapper and ObjectReader.

### Constructor
`Jackson3JsonProvider(ObjectMapper objectMapper, ObjectReader objectReader)`
```