Repository: json-path/JsonPath Branch: master Commit: 62a4c9f0f65b Files: 235 Total size: 1.0 MB Directory structure: gitextract_5g0slvqk/ ├── .github/ │ └── workflows/ │ └── ci.yml ├── .gitignore ├── .travis.yml ├── LICENSE ├── Procfile ├── README.md ├── build.gradle ├── changelog.md ├── gradle/ │ └── wrapper/ │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── json-path/ │ ├── build.gradle │ └── src/ │ ├── main/ │ │ └── java/ │ │ └── com/ │ │ └── jayway/ │ │ └── jsonpath/ │ │ ├── Configuration.java │ │ ├── Criteria.java │ │ ├── DocumentContext.java │ │ ├── EvaluationListener.java │ │ ├── Filter.java │ │ ├── InvalidCriteriaException.java │ │ ├── InvalidJsonException.java │ │ ├── InvalidModificationException.java │ │ ├── InvalidPathException.java │ │ ├── JsonPath.java │ │ ├── JsonPathException.java │ │ ├── MapFunction.java │ │ ├── Option.java │ │ ├── ParseContext.java │ │ ├── PathNotFoundException.java │ │ ├── Predicate.java │ │ ├── ReadContext.java │ │ ├── TypeRef.java │ │ ├── ValueCompareException.java │ │ ├── WriteContext.java │ │ ├── internal/ │ │ │ ├── CharacterIndex.java │ │ │ ├── DefaultsImpl.java │ │ │ ├── EvaluationAbortException.java │ │ │ ├── EvaluationContext.java │ │ │ ├── JsonContext.java │ │ │ ├── JsonFormatter.java │ │ │ ├── ParseContextImpl.java │ │ │ ├── Path.java │ │ │ ├── PathRef.java │ │ │ ├── Utils.java │ │ │ ├── filter/ │ │ │ │ ├── Evaluator.java │ │ │ │ ├── EvaluatorFactory.java │ │ │ │ ├── ExpressionNode.java │ │ │ │ ├── FilterCompiler.java │ │ │ │ ├── LogicalExpressionNode.java │ │ │ │ ├── LogicalOperator.java │ │ │ │ ├── PatternFlag.java │ │ │ │ ├── RelationalExpressionNode.java │ │ │ │ ├── RelationalOperator.java │ │ │ │ ├── ValueNode.java │ │ │ │ └── ValueNodes.java │ │ │ ├── function/ │ │ │ │ ├── ParamType.java │ │ │ │ ├── Parameter.java │ │ │ │ ├── PassthruPathFunction.java │ │ │ │ ├── PathFunction.java │ │ │ │ ├── PathFunctionFactory.java │ │ │ │ ├── json/ │ │ │ │ │ ├── Append.java │ │ │ │ │ └── KeySetFunction.java │ │ │ │ ├── latebinding/ │ │ │ │ │ ├── ILateBindingValue.java │ │ │ │ │ ├── JsonLateBindingValue.java │ │ │ │ │ └── PathLateBindingValue.java │ │ │ │ ├── numeric/ │ │ │ │ │ ├── AbstractAggregation.java │ │ │ │ │ ├── Average.java │ │ │ │ │ ├── Max.java │ │ │ │ │ ├── Min.java │ │ │ │ │ ├── StandardDeviation.java │ │ │ │ │ └── Sum.java │ │ │ │ ├── sequence/ │ │ │ │ │ ├── AbstractSequenceAggregation.java │ │ │ │ │ ├── First.java │ │ │ │ │ ├── Index.java │ │ │ │ │ └── Last.java │ │ │ │ └── text/ │ │ │ │ ├── Concatenate.java │ │ │ │ └── Length.java │ │ │ └── path/ │ │ │ ├── ArrayIndexOperation.java │ │ │ ├── ArrayIndexToken.java │ │ │ ├── ArrayPathToken.java │ │ │ ├── ArraySliceOperation.java │ │ │ ├── ArraySliceToken.java │ │ │ ├── CompiledPath.java │ │ │ ├── EvaluationContextImpl.java │ │ │ ├── FunctionPathToken.java │ │ │ ├── PathCompiler.java │ │ │ ├── PathToken.java │ │ │ ├── PathTokenAppender.java │ │ │ ├── PathTokenFactory.java │ │ │ ├── PredicateContextImpl.java │ │ │ ├── PredicatePathToken.java │ │ │ ├── PropertyPathToken.java │ │ │ ├── RootPathToken.java │ │ │ ├── ScanPathToken.java │ │ │ └── WildcardPathToken.java │ │ └── spi/ │ │ ├── cache/ │ │ │ ├── Cache.java │ │ │ ├── CacheProvider.java │ │ │ ├── LRUCache.java │ │ │ └── NOOPCache.java │ │ ├── json/ │ │ │ ├── AbstractJsonProvider.java │ │ │ ├── GsonJsonProvider.java │ │ │ ├── Jackson3JsonNodeJsonProvider.java │ │ │ ├── Jackson3JsonProvider.java │ │ │ ├── JacksonJsonNodeJsonProvider.java │ │ │ ├── JacksonJsonProvider.java │ │ │ ├── JakartaJsonProvider.java │ │ │ ├── JettisonProvider.java │ │ │ ├── JsonOrgJsonProvider.java │ │ │ ├── JsonProvider.java │ │ │ ├── JsonSmartJsonProvider.java │ │ │ └── TapestryJsonProvider.java │ │ └── mapper/ │ │ ├── GsonMappingProvider.java │ │ ├── Jackson3MappingProvider.java │ │ ├── JacksonMappingProvider.java │ │ ├── JakartaMappingProvider.java │ │ ├── JsonOrgMappingProvider.java │ │ ├── JsonSmartMappingProvider.java │ │ ├── MappingException.java │ │ ├── MappingProvider.java │ │ └── TapestryMappingProvider.java │ └── test/ │ ├── java/ │ │ └── com/ │ │ └── jayway/ │ │ └── jsonpath/ │ │ ├── BaseTest.java │ │ ├── Configurations.java │ │ ├── DeepScanTest.java │ │ ├── EscapeTest.java │ │ ├── EvaluationListenerTest.java │ │ ├── FilterCompilerTest.java │ │ ├── FilterParseTest.java │ │ ├── FilterTest.java │ │ ├── GsonJsonProviderTest.java │ │ ├── InlineFilterTest.java │ │ ├── Issue_487.java │ │ ├── Issue_537.java │ │ ├── Issue_721.java │ │ ├── Issue_762.java │ │ ├── Issue_786.java │ │ ├── Issue_970.java │ │ ├── Issue_973.java │ │ ├── Jackson3JsonNodeJsonProviderMapperSupportTest.java │ │ ├── Jackson3JsonNodeJsonProviderTest.java │ │ ├── Jackson3Test.java │ │ ├── JacksonJsonNodeJsonProviderMapperSupportTest.java │ │ ├── JacksonJsonNodeJsonProviderTest.java │ │ ├── JacksonTest.java │ │ ├── JakartaJsonProviderTest.java │ │ ├── JsonOrgJsonProviderTest.java │ │ ├── JsonProviderTest.java │ │ ├── JsonProviderTestObjectMapping.java │ │ ├── MapperTest.java │ │ ├── MultiPropTest.java │ │ ├── OptionsTest.java │ │ ├── PathCompilerTest.java │ │ ├── PredicateTest.java │ │ ├── ProviderInTest.java │ │ ├── ReadContextTest.java │ │ ├── ReturnTypeTest.java │ │ ├── ScientificNotationTest.java │ │ ├── TapestryJsonProviderTest.java │ │ ├── TestSuppressExceptions.java │ │ ├── TestUtils.java │ │ ├── WriteTest.java │ │ ├── internal/ │ │ │ ├── JsonContextTest.java │ │ │ ├── UtilsTest.java │ │ │ ├── filter/ │ │ │ │ ├── PatternFlagTest.java │ │ │ │ ├── RegexpEvaluatorTest.java │ │ │ │ └── RelationalOperatorTest.java │ │ │ ├── function/ │ │ │ │ ├── BaseFunctionTest.java │ │ │ │ ├── Issue191.java │ │ │ │ ├── Issue234.java │ │ │ │ ├── Issue273.java │ │ │ │ ├── Issue612.java │ │ │ │ ├── Issue629.java │ │ │ │ ├── Issue680.java │ │ │ │ ├── JSONEntityPathFunctionTest.java │ │ │ │ ├── KeySetFunctionTest.java │ │ │ │ ├── NestedFunctionTest.java │ │ │ │ ├── NumericPathFunctionTest.java │ │ │ │ └── SequentialPathFunctionTest.java │ │ │ └── path/ │ │ │ └── PathTokenTest.java │ │ ├── issue_613.java │ │ └── old/ │ │ ├── ArraySlicingTest.java │ │ ├── ComplianceTest.java │ │ ├── FilterTest.java │ │ ├── IssuesTest.java │ │ ├── JsonPathTest.java │ │ ├── JsonProviderTest.java │ │ ├── NullHandlingTest.java │ │ └── internal/ │ │ ├── ArrayIndexFilterTest.java │ │ ├── ArrayPathTokenTest.java │ │ ├── PredicatePathTokenTest.java │ │ ├── PropertyPathTokenTest.java │ │ ├── ScanPathTokenTest.java │ │ ├── TestBase.java │ │ └── TestInternal3.java │ └── resources/ │ ├── issue_191.json │ ├── issue_24.json │ ├── issue_76.json │ ├── issue_76_2.json │ ├── json-test-doc.json │ ├── json_array.json │ ├── json_array_multiple_delete.json │ ├── keyset.json │ └── simplelogger.properties ├── json-path-assert/ │ ├── README.md │ ├── build.gradle │ └── src/ │ ├── main/ │ │ └── java/ │ │ └── com/ │ │ └── jayway/ │ │ ├── jsonassert/ │ │ │ ├── JsonAssert.java │ │ │ ├── JsonAsserter.java │ │ │ └── impl/ │ │ │ ├── JsonAsserterImpl.java │ │ │ └── matcher/ │ │ │ ├── CollectionMatcher.java │ │ │ ├── IsCollectionWithSize.java │ │ │ ├── IsEmptyCollection.java │ │ │ ├── IsMapContainingKey.java │ │ │ ├── IsMapContainingValue.java │ │ │ └── MapTypeSafeMatcher.java │ │ └── jsonpath/ │ │ └── matchers/ │ │ ├── IsJson.java │ │ ├── JsonPathMatchers.java │ │ ├── WithJsonPath.java │ │ └── WithoutJsonPath.java │ └── test/ │ ├── java/ │ │ └── com/ │ │ └── jayway/ │ │ ├── jsonassert/ │ │ │ └── JsonAssertTest.java │ │ └── jsonpath/ │ │ └── matchers/ │ │ ├── DemoTest.java │ │ ├── HasNoJsonPathTest.java │ │ ├── IsJsonFileTest.java │ │ ├── IsJsonStringTest.java │ │ ├── IsJsonTest.java │ │ ├── JsonPathMatchersTest.java │ │ ├── WithJsonPathTest.java │ │ ├── WithoutJsonPathTest.java │ │ └── helpers/ │ │ ├── ResourceHelpers.java │ │ ├── StrictParsingConfiguration.java │ │ └── TestingMatchers.java │ └── resources/ │ ├── books.json │ ├── example.json │ ├── invalid.json │ ├── links.json │ └── lotto.json ├── settings.gradle └── system.properties ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/workflows/ci.yml ================================================ --- name: Java CI on: push: pull_request: jobs: test: runs-on: ubuntu-latest strategy: matrix: java: [ 17, 21 ] fail-fast: false max-parallel: 4 name: JDK ${{ matrix.java }} steps: - uses: actions/checkout@v4 - name: Set up JDK uses: actions/setup-java@v3 with: java-version: ${{ matrix.java }} distribution: temurin cache: 'gradle' - name: Grant execute permission for gradlew run: chmod +x gradlew - name: Build with Gradle run: ./gradlew build --warning-mode all - name: Run Tests run: ./gradlew check - name: Maven Install run: ./gradlew clean publishToMavenLocal ... ================================================ FILE: .gitignore ================================================ .idea/ target *.iws *.ipr *.iml .classpath .project .settings .springBeans .DS_Store .gradle .java-version TODO gradle.properties build bin/ out/ ================================================ FILE: .travis.yml ================================================ language: java sudo: false jdk: - openjdk17 cache: directories: - $HOME/.gradle arch: - amd64 - ppc64le ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2017 Jayway Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: Procfile ================================================ web: java $JAVA_OPTS -Dserver.http.port=$PORT -DresourceBase=json-path-web-test/build/resources/main/webapp/ -jar json-path-web-test/build/libs/json-path-web-test-*-all.jar ================================================ FILE: README.md ================================================ Jayway JsonPath ===================== **A Java DSL for reading JSON documents.** [![Build Status](https://travis-ci.org/json-path/JsonPath.svg?branch=master)](https://travis-ci.org/json-path/JsonPath) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.jayway.jsonpath/json-path/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.jayway.jsonpath/json-path) [![Javadoc](https://www.javadoc.io/badge/com.jayway.jsonpath/json-path.svg)](http://www.javadoc.io/doc/com.jayway.jsonpath/json-path) Jayway JsonPath is a Java port of [Stefan Goessner JsonPath implementation](http://goessner.net/articles/JsonPath/). Getting Started --------------- JsonPath is available at the Central Maven Repository. Maven users add this to your POM. > [!NOTE] > Version 3.0.0 Uses Java 17 baseline to support Jackson 3 ```xml com.jayway.jsonpath json-path 3.0.0 ``` If you need help ask questions at [Stack Overflow](http://stackoverflow.com/questions/tagged/jsonpath). Tag the question 'jsonpath' and 'java'. JsonPath expressions always refer to a JSON structure in the same way as XPath expression are used in combination with an XML document. The "root member object" in JsonPath is always referred to as `$` regardless if it is an object or array. JsonPath expressions can use the dot–notation `$.store.book[0].title` or the bracket–notation `$['store']['book'][0]['title']` Operators --------- | Operator | Description | |:--------------------------|:----------------------------------------------------------------| | `$` | The root element to query. This starts all path expressions. | | `@` | The current node being processed by a filter predicate. | | `*` | Wildcard. Available anywhere a name or numeric are required. | | `..` | Deep scan. Available anywhere a name is required. | | `.` | Dot-notated child | | `['' (, '')]` | Bracket-notated child or children | | `[ (, )]` | Array index or indexes | | `[start:end]` | Array slice operator | | `[?()]` | Filter expression. Expression must evaluate to a boolean value. | Functions --------- Functions can be invoked at the tail end of a path - the input to a function is the output of the path expression. The function output is dictated by the function itself. | Function | Description | Output type | |:------------|:-------------------------------------------------------------------------------------|:---------------------| | `min()` | Provides the min value of an array of numbers | Double | | `max()` | Provides the max value of an array of numbers | Double | | `avg()` | Provides the average value of an array of numbers | Double | | `stddev()` | Provides the standard deviation value of an array of numbers | Double | | `length()` | Provides the length of an array | Integer | | `sum()` | Provides the sum value of an array of numbers | Double | | `keys()` | Provides the property keys (An alternative for terminal tilde `~`) | `Set` | | `concat(X)` | Provides a concatinated version of the path output with a new item | like input | | `append(X)` | add an item to the json path output array | like input | | `first()` | Provides the first item of an array | Depends on the array | | `last()` | Provides the last item of an array | Depends on the array | | `index(X)` | Provides the item of an array of index: X, if the X is negative, take from backwards | Depends on the array | Filter Operators ----------------- Filters are logical expressions used to filter arrays. A typical filter would be `[?(@.age > 18)]` where `@` represents the current item being processed. More complex filters can be created with logical operators `&&` and `||`. String literals must be enclosed by single or double quotes (`[?(@.color == 'blue')]` or `[?(@.color == "blue")]`). | Operator | Description | |:-----------|:-------------------------------------------------------------------| | `==` | left is equal to right (note that 1 is not equal to '1') | | `!=` | left is not equal to right | | `<` | left is less than right | | `<=` | left is less or equal to right | | `>` | left is greater than right | | `>=` | left is greater than or equal to right | | `=~` | left matches regular expression [?(@.name =~ /foo.*?/i)] | | `in` | left exists in right [?(@.size in ['S', 'M'])] | | `nin` | left does not exists in right | | `subsetof` | left is a subset of right [?(@.sizes subsetof ['S', 'M', 'L'])] | | `anyof` | left has an intersection with right [?(@.sizes anyof ['M', 'L'])] | | `noneof` | left has no intersection with right [?(@.sizes noneof ['M', 'L'])] | | `size` | size of left (array or string) should match right | | `empty` | left (array or string) should be empty | Path Examples ------------- Given the json ```javascript { "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 }, { "category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99 }, { "category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99 } ], "bicycle": { "color": "red", "price": 19.95 } }, "expensive": 10 } ``` | JsonPath | Result | |:----------------------------------------|:-------------------------------------------------------------| | `$.store.book[*].author` | The authors of all books | | `$..author` | All authors | | `$.store.*` | All things, both books and bicycles | | `$.store..price` | The price of everything | | `$..book[2]` | The third book | | `$..book[-2]` | The second to last book | | `$..book[0,1]` | The first two books | | `$..book[:2]` | All books from index 0 (inclusive) until index 2 (exclusive) | | `$..book[1:2]` | All books from index 1 (inclusive) until index 2 (exclusive) | | `$..book[-2:]` | Last two books | | `$..book[2:]` | All books from index 2 (inclusive) to last | | `$..book[?(@.isbn)]` | All books with an ISBN number | | `$.store.book[?(@.price < 10)]` | All books in store cheaper than 10 | | `$..book[?(@.price <= $['expensive'])]` | All books in store that are not "expensive" | | `$..book[?(@.author =~ /.*REES/i)]` | All books matching regex (ignore case) | | `$..*` | Give me every thing | `$..book.length()` | The number of books | Reading a Document ------------------ The simplest most straight forward way to use JsonPath is via the static read API. ```java String json = "..."; List authors = JsonPath.read(json, "$.store.book[*].author"); ``` If you only want to read once this is OK. In case you need to read an other path as well this is not the way to go since the document will be parsed every time you call JsonPath.read(...). To avoid the problem you can parse the json first. ```java String json = "..."; Object document = Configuration.defaultConfiguration().jsonProvider().parse(json); String author0 = JsonPath.read(document, "$.store.book[0].author"); String author1 = JsonPath.read(document, "$.store.book[1].author"); ``` JsonPath also provides a fluent API. This is also the most flexible one. ```java String json = "..."; ReadContext ctx = JsonPath.parse(json); List authorsOfBooksWithISBN = ctx.read("$.store.book[?(@.isbn)].author"); List> expensiveBooks = JsonPath .using(configuration) .parse(json) .read("$.store.book[?(@.price > 10)]", List.class); ``` What is Returned When? ---------------------- When using JsonPath in java its important to know what type you expect in your result. JsonPath will automatically try to cast the result to the type expected by the invoker. ```java //Will throw an java.lang.ClassCastException List list = JsonPath.parse(json).read("$.store.book[0].author"); //Works fine String author = JsonPath.parse(json).read("$.store.book[0].author"); ``` When evaluating a path you need to understand the concept of when a path is `definite`. A path is `indefinite` if it contains: * `..` - a deep scan operator * `?()` - an expression * `[, (, )]` - multiple array indexes `Indefinite` paths always returns a list (as represented by current JsonProvider). By default a simple object mapper is provided by the MappingProvider SPI. This allows you to specify the return type you want and the MappingProvider will try to perform the mapping. In the example below mapping between `Long` and `Date` is demonstrated. ```java String json = "{\"date_as_long\" : 1411455611975}"; Date date = JsonPath.parse(json).read("$['date_as_long']", Date.class); ``` If you configure JsonPath to use `JacksonMappingProvider`, `Jackson3MappingProvider`, `GsonMappingProvider`, or `JakartaJsonProvider` you can even map your JsonPath output directly into POJO's. ```java Book book = JsonPath.parse(json).read("$.store.book[0]", Book.class); ``` To obtain full generics type information, use TypeRef. ```java TypeRef> typeRef = new TypeRef>() { }; List titles = JsonPath.parse(JSON_DOCUMENT).read("$.store.book[*].title", typeRef); ``` Predicates ---------- There are three different ways to create filter predicates in JsonPath. ### Inline Predicates Inline predicates are the ones defined in the path. ```java List> books = JsonPath.parse(json) .read("$.store.book[?(@.price < 10)]"); ``` You can use `&&` and `||` to combine multiple predicates `[?(@.price < 10 && @.category == 'fiction')]` , `[?(@.category == 'reference' || @.price > 10)]`. You can use `!` to negate a predicate `[?(!(@.price < 10 && @.category == 'fiction'))]`. ### Filter Predicates Predicates can be built using the Filter API as shown below: ```java import static com.jayway.jsonpath.JsonPath.parse; import static com.jayway.jsonpath.Criteria.where; import static com.jayway.jsonpath.Filter.filter; ... ... Filter cheapFictionFilter = filter( where("category").is("fiction").and("price").lte(10D) ); List> books = parse(json).read("$.store.book[?]", cheapFictionFilter); ``` Notice the placeholder `?` for the filter in the path. When multiple filters are provided they are applied in order where the number of placeholders must match the number of provided filters. You can specify multiple predicate placeholders in one filter operation `[?, ?]`, both predicates must match. Filters can also be combined with 'OR' and 'AND' ```java Filter fooOrBar = filter( where("foo").exists(true)).or(where("bar").exists(true) ); Filter fooAndBar = filter( where("foo").exists(true)).and(where("bar").exists(true) ); ``` ### Roll Your Own Third option is to implement your own predicates ```java Predicate booksWithISBN = new Predicate() { @Override public boolean apply(PredicateContext ctx) { return ctx.item(Map.class).containsKey("isbn"); } }; List> books = reader.read("$.store.book[?].isbn", List.class, booksWithISBN); ``` Path vs Value ------------- In the Goessner implementation a JsonPath can return either `Path` or `Value`. `Value` is the default and what all the examples above are returning. If you rather have the path of the elements our query is hitting this can be achieved with an option. ```java Configuration conf = Configuration.builder() .options(Option.AS_PATH_LIST).build(); List pathList = using(conf).parse(json).read("$..author"); assertThat(pathList). containsExactly( "$['store']['book'][0]['author']", "$['store']['book'][1]['author']", "$['store']['book'][2]['author']", "$['store']['book'][3]['author']"); ``` Set a value ----------- The library offers the possibility to set a value. ```java String newJson = JsonPath.parse(json).set("$['store']['book'][0]['author']", "Paul").jsonString(); ``` Tweaking Configuration ---------------------- ### Options When creating your Configuration there are a few option flags that can alter the default behaviour. **DEFAULT_PATH_LEAF_TO_NULL**
This option makes JsonPath return null for missing leafs. Consider the following json ```javascript [ { "name" : "john", "gender" : "male" }, { "name" : "ben" } ] ``` ```java Configuration conf = Configuration.defaultConfiguration(); //Works fine String gender0 = JsonPath.using(conf).parse(json).read("$[0]['gender']"); //PathNotFoundException thrown String gender1 = JsonPath.using(conf).parse(json).read("$[1]['gender']"); Configuration conf2 = conf.addOptions(Option.DEFAULT_PATH_LEAF_TO_NULL); //Works fine String gender0 = JsonPath.using(conf2).parse(json).read("$[0]['gender']"); //Works fine (null is returned) String gender1 = JsonPath.using(conf2).parse(json).read("$[1]['gender']"); ``` **ALWAYS_RETURN_LIST**
This option configures JsonPath to return a list even when the path is `definite`. ```java Configuration conf = Configuration.defaultConfiguration(); //ClassCastException thrown List genders0 = JsonPath.using(conf).parse(json).read("$[0]['gender']"); Configuration conf2 = conf.addOptions(Option.ALWAYS_RETURN_LIST); //Works fine List genders0 = JsonPath.using(conf2).parse(json).read("$[0]['gender']"); ``` **SUPPRESS_EXCEPTIONS**
This option makes sure no exceptions are propagated from path evaluation. It follows these simple rules: * If option `ALWAYS_RETURN_LIST` is present an empty list will be returned * If option `ALWAYS_RETURN_LIST` is **NOT** present null returned **REQUIRE_PROPERTIES**
This option configures JsonPath to require properties defined in path when an `indefinite` path is evaluated. ```java Configuration conf = Configuration.defaultConfiguration(); //Works fine List genders = JsonPath.using(conf).parse(json).read("$[*]['gender']"); Configuration conf2 = conf.addOptions(Option.REQUIRE_PROPERTIES); //PathNotFoundException thrown List genders = JsonPath.using(conf2).parse(json).read("$[*]['gender']"); ``` ### JsonProvider SPI JsonPath is shipped with five different JsonProviders: * [JsonSmartJsonProvider](https://github.com/netplex/json-smart-v2) (default) * [JacksonJsonProvider](https://github.com/FasterXML/jackson) * [JacksonJsonNodeJsonProvider](https://github.com/FasterXML/jackson) * [JacksonJson3Provider](https://github.com/FasterXML/jackson) * [JacksonJson3NodeJsonProvider](https://github.com/FasterXML/jackson) * [GsonJsonProvider](https://code.google.com/p/google-gson/) * [JsonOrgJsonProvider](https://github.com/stleary/JSON-java) * [JakartaJsonProvider](https://javaee.github.io/jsonp/) Changing the configuration defaults as demonstrated should only be done when your application is being initialized. Changes during runtime is strongly discouraged, especially in multi threaded applications. ```java Configuration.setDefaults(new Configuration.Defaults() { private final JsonProvider jsonProvider = new JacksonJsonProvider(); private final MappingProvider mappingProvider = new JacksonMappingProvider(); @Override public JsonProvider jsonProvider () { return jsonProvider; } @Override public MappingProvider mappingProvider () { return mappingProvider; } @Override public Set