How json-path/jsonpath works
Jayway JsonPath is a Java library for querying and modifying JSON documents with JsonPath expressions, plus assertion and matcher APIs. The principal workflow is a caller providing JSON and a path, parsing the document into a context, compiling/evaluating the expression, then receiving a result or applying a mutation. The README documents path operators, filters, and functions; source excerpts show context caching, result mapping, and updates. Many implementation links are inferred only from the SOURCE INDEX, so unsampled links are omitted or marked unverified.
Main entry points: JsonContext.java Document Context · JsonPath.java JsonPath API · path Path Evaluation · EvaluationContextImpl.java Evaluation Context
Components 22
Public APIs
- Parse API
json-path/src/main/java/com/jayway/jsonpath/ParseContext.java - Read Context
json-path/src/main/java/com/jayway/jsonpath/ReadContext.java - Write Context
json-path/src/main/java/com/jayway/jsonpath/WriteContext.java - Configuration
json-path/src/main/java/com/jayway/jsonpath/Configuration.java - JsonPath API
json-path/src/main/java/com/jayway/jsonpath/JsonPath.java
Query Runtime
- Document Context
json-path/src/main/java/com/jayway/jsonpath/internal/JsonContext.java - Parse Context Impl
json-path/src/main/java/com/jayway/jsonpath/internal/ParseContextImpl.java - Path Compiler
json-path/src/main/java/com/jayway/jsonpath/internal/path/PathCompiler.java - Filter Compiler
json-path/src/main/java/com/jayway/jsonpath/internal/filter/FilterCompiler.java - Path Evaluation
json-path/src/main/java/com/jayway/jsonpath/internal/path - Evaluation Context
json-path/src/main/java/com/jayway/jsonpath/internal/path/EvaluationContextImpl.java - Update Operations
json-path/src/main/java/com/jayway/jsonpath/internal/PathRef.java - Path Functions
json-path/src/main/java/com/jayway/jsonpath/internal/function - Path Cache
json-path/src/main/java/com/jayway/jsonpath/spi/cache/CacheProvider.java
JSON Providers
- JSON Providers
json-path/src/main/java/com/jayway/jsonpath/spi/json - Mapping Providers
json-path/src/main/java/com/jayway/jsonpath/spi/mapper
Assertions
- JSON Assertions
json-path-assert/src/main/java/com/jayway/jsonassert/JsonAssert.java - Asserter Impl
json-path-assert/src/main/java/com/jayway/jsonassert/impl/JsonAsserterImpl.java - Hamcrest Matchers
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/JsonPathMatchers.java - JSON Matcher
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/IsJson.java - Path Matchers
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/WithJsonPath.java
Other components
- Library Caller
Connections 27
- Library Caller → Parse API: supplies JSON
README.md - Library Caller → Read Context: requests paths
README.md - Library Caller → Write Context: requests edits
json-path/src/main/java/com/jayway/jsonpath/WriteContext.java - Parse API → Parse Context Impl: delegates parsing
json-path/src/main/java/com/jayway/jsonpath/internal/ParseContextImpl.java - Parse Context Impl → Document Context: creates context
json-path/src/main/java/com/jayway/jsonpath/internal/ParseContextImpl.java - Read Context → Document Context: implemented by
json-path/src/main/java/com/jayway/jsonpath/internal/JsonContext.java - Write Context → Document Context: implemented by
- Document Context → Path Cache: gets compiled paths
json-path/src/main/java/com/jayway/jsonpath/internal/JsonContext.java - Document Context → JsonPath API: compiles paths
json-path/src/main/java/com/jayway/jsonpath/internal/JsonContext.java - JsonPath API → Evaluation Context: evaluates expression
json-path/src/main/java/com/jayway/jsonpath/JsonPath.java - Path Compiler → Path Evaluation: builds path
- Filter Compiler → Path Evaluation: builds predicates
- Path Evaluation → Evaluation Context: evaluates tokens
json-path/src/main/java/com/jayway/jsonpath/internal/path/EvaluationContextImpl.java - Evaluation Context → Update Operations: records updates
json-path/src/main/java/com/jayway/jsonpath/internal/path/EvaluationContextImpl.java - Evaluation Context → JSON Providers: accesses JSON model
json-path/src/main/java/com/jayway/jsonpath/internal/path/EvaluationContextImpl.java - Document Context → Mapping Providers: maps typed results
json-path/src/main/java/com/jayway/jsonpath/internal/JsonContext.java - Configuration → JSON Providers: configures provider
json-path/src/main/java/com/jayway/jsonpath/Configuration.java - Configuration → Mapping Providers: configures mapping
json-path/src/main/java/com/jayway/jsonpath/Configuration.java - Path Evaluation → Path Functions: applies functions
- Library Caller → JSON Assertions: asserts JSON
json-path-assert/src/main/java/com/jayway/jsonassert/JsonAssert.java - JSON Assertions → Asserter Impl: creates asserter
json-path-assert/src/main/java/com/jayway/jsonassert/JsonAssert.java - Asserter Impl → JsonPath API: evaluates assertions
json-path-assert/src/main/java/com/jayway/jsonassert/impl/JsonAsserterImpl.java - Library Caller → Hamcrest Matchers: uses matchers
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/JsonPathMatchers.java - Hamcrest Matchers → JSON Matcher: constructs matcher
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/JsonPathMatchers.java - Hamcrest Matchers → Path Matchers: constructs matcher
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/JsonPathMatchers.java - JSON Matcher → JsonPath API: parses JSON
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/IsJson.java - Path Matchers → JsonPath API: evaluates path
json-path-assert/src/main/java/com/jayway/jsonpath/matchers/WithJsonPath.java