JsonPath (json-path 0.9.1 API)

java.lang.Object
- com.jayway.jsonpath.JsonPath

```
public class JsonPath
extends Object
```
JsonPath is to JSON what XPATH is to XML, a simple way to extract parts of a given document. JsonPath is available in many programming languages such as Javascript, Python and PHP.
JsonPath allows you to compile a json path string to use it many times or to compile and apply in one single on demand operation.
Given the Json document:
String json = "{ "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 } ], "bicycle": { "color": "red", "price": 19.95 } } }";
A JsonPath can be compiled and used as shown:
JsonPath path = JsonPath.compile("$.store.book[1]"); List<Object> books = path.read(json);
Or:
List<Object> authors = JsonPath.read(json, "$.store.book[*].author")
If the json path returns a single value (is definite):
String author = JsonPath.read(json, "$.store.book[1].author")

Author:

Kalle Stenflo

Method Summary

Methods
Modifier and Type	Method and Description
`static JsonPath`	`compile(String jsonPath, Filter... filters)` Compiles a JsonPath
`JsonPath`	`copy()`
`String`	`getPath()` Returns the string representation of this JsonPath
`boolean`	`isPathDefinite()` Checks if a path points to a single item or if it potentially returns multiple items a path is considered not definite if it contains a scan fragment ".." or an array position fragment that is not based on a single index definite path examples are: $store.book $store.book[1].title not definite path examples are: $..book $.store.book[1,2] $.store.book[?(@.category = 'fiction')]
`static boolean`	`isPathDefinite(String path)` Checks if a path points to a single item or if it potentially returns multiple items a path is considered not definite if it contains a scan fragment ".." or an array position fragment that is not based on a single index definite path examples are: $store.book $store.book[1].title not definite path examples are: $..book $.store.book[1,2] $.store.book[?(@.category = 'fiction')]
`static ReadContext`	`parse(File json)` Parses the given JSON input using the default `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(File json, Configuration configuration)` Parses the given JSON input using the provided `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(InputStream json)` Parses the given JSON input using the default `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(InputStream json, Configuration configuration)` Parses the given JSON input using the provided `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(Object json)` Parses the given JSON input using the default `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(Object json, Configuration configuration)` Parses the given JSON input using the provided `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(String json)` Parses the given JSON input using the default `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(String json, Configuration configuration)` Parses the given JSON input using the provided `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(URL json)` Parses the given JSON input using the default `Configuration` and returns a `ReadContext` for path evaluation
`static ReadContext`	`parse(URL json, Configuration configuration)` Parses the given JSON input using the provided `Configuration` and returns a `ReadContext` for path evaluation
`<T> T`	`read(File jsonFile)` Applies this JsonPath to the provided json file
`<T> T`	`read(File jsonFile, Configuration configuration)` Applies this JsonPath to the provided json file
`static <T> T`	`read(File jsonFile, String jsonPath, Filter... filters)` Creates a new JsonPath and applies it to the provided Json object
`<T> T`	`read(InputStream jsonInputStream)` Applies this JsonPath to the provided json input stream
`<T> T`	`read(InputStream jsonInputStream, Configuration configuration)` Applies this JsonPath to the provided json input stream
`static <T> T`	`read(InputStream jsonInputStream, String jsonPath, Filter... filters)` Creates a new JsonPath and applies it to the provided Json object
`<T> T`	`read(Object jsonObject)` Applies this JsonPath to the provided json document.
`<T> T`	`read(Object jsonObject, Configuration configuration)` Applies this JsonPath to the provided json document.
`static <T> T`	`read(Object json, String jsonPath, Filter... filters)` Creates a new JsonPath and applies it to the provided Json object
`<T> T`	`read(String json)` Applies this JsonPath to the provided json string
`<T> T`	`read(String json, Configuration configuration)` Applies this JsonPath to the provided json string
`static <T> T`	`read(String json, String jsonPath, Filter... filters)` Creates a new JsonPath and applies it to the provided Json string
`<T> T`	`read(URL jsonURL)` Applies this JsonPath to the provided json URL
`<T> T`	`read(URL jsonURL, Configuration configuration)` Applies this JsonPath to the provided json URL
`static <T> T`	`read(URL jsonURL, String jsonPath, Filter... filters)` Creates a new JsonPath and applies it to the provided Json object
`static ParseContext`	`using(Configuration configuration)` Creates a `ParseContext` that can be used to parse a given JSON input.
`static ParseContext`	`using(JsonProvider provider)` Creates a `ParseContext` that will parse a given JSON input.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copy
```
public JsonPath copy()
```
  - getPath
```
public String getPath()
```
    Returns the string representation of this JsonPath
    
    Returns:
    path as String
  - isPathDefinite
```
public static boolean isPathDefinite(String path)
```
    Checks if a path points to a single item or if it potentially returns multiple items
    a path is considered not definite if it contains a scan fragment ".." or an array position fragment that is not based on a single index
    
    definite path examples are:
    $store.book $store.book[1].title
    not definite path examples are:
    $..book $.store.book[1,2] $.store.book[?(@.category = 'fiction')]
    
    Returns:
    true if path is definite (points to single item)
  - isPathDefinite
```
public boolean isPathDefinite()
```
    Checks if a path points to a single item or if it potentially returns multiple items
    a path is considered not definite if it contains a scan fragment ".." or an array position fragment that is not based on a single index
    
    definite path examples are:
    $store.book $store.book[1].title
    not definite path examples are:
    $..book $.store.book[1,2] $.store.book[?(@.category = 'fiction')]
    
    Returns:
    true if path is definite (points to single item)
  - read
```
public <T> T read(Object jsonObject)
```
    Applies this JsonPath to the provided json document. Note that the document must be identified as either a List or Map by the JsonProvider
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonObject - a container Object
    
    Returns:
    list of objects matched by the given path
  - read
```
public <T> T read(Object jsonObject,
         Configuration configuration)
```
    Applies this JsonPath to the provided json document. Note that the document must be identified as either a List or Map by the JsonProvider
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonObject - a container Object
    configuration - configuration to use
    
    Returns:
    list of objects matched by the given path
  - read
```
public <T> T read(String json)
```
    Applies this JsonPath to the provided json string
    
    Type Parameters:
    T - expected return type
    Parameters:
    json - a json string
    
    Returns:
    list of objects matched by the given path
  - read
```
public <T> T read(String json,
         Configuration configuration)
```
    Applies this JsonPath to the provided json string
    
    Type Parameters:
    T - expected return type
    Parameters:
    json - a json string
    configuration - configuration to use
    
    Returns:
    list of objects matched by the given path
  - read
```
public <T> T read(URL jsonURL)
       throws IOException
```
    Applies this JsonPath to the provided json URL
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonURL - url to read from
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public <T> T read(URL jsonURL,
         Configuration configuration)
       throws IOException
```
    Applies this JsonPath to the provided json URL
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonURL - url to read from
    configuration - configuration to use
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public <T> T read(File jsonFile)
       throws IOException
```
    Applies this JsonPath to the provided json file
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonFile - file to read from
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public <T> T read(File jsonFile,
         Configuration configuration)
       throws IOException
```
    Applies this JsonPath to the provided json file
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonFile - file to read from
    configuration - configuration to use
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public <T> T read(InputStream jsonInputStream)
       throws IOException
```
    Applies this JsonPath to the provided json input stream
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonInputStream - input stream to read from
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public <T> T read(InputStream jsonInputStream,
         Configuration configuration)
       throws IOException
```
    Applies this JsonPath to the provided json input stream
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonInputStream - input stream to read from
    configuration - configuration to use
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - compile
```
public static JsonPath compile(String jsonPath,
               Filter... filters)
```
    Compiles a JsonPath
    
    Parameters:
    jsonPath - to compile
    filters - filters to be applied to the filter place holders [?] in the path
    
    Returns:
    compiled JsonPath
  - read
```
public static <T> T read(Object json,
         String jsonPath,
         Filter... filters)
```
    Creates a new JsonPath and applies it to the provided Json object
    
    Type Parameters:
    T - expected return type
    Parameters:
    json - a json object
    jsonPath - the json path
    filters - filters to be applied to the filter place holders [?] in the path
    
    Returns:
    list of objects matched by the given path
  - read
```
public static <T> T read(String json,
         String jsonPath,
         Filter... filters)
```
    Creates a new JsonPath and applies it to the provided Json string
    
    Type Parameters:
    T - expected return type
    Parameters:
    json - a json string
    jsonPath - the json path
    filters - filters to be applied to the filter place holders [?] in the path
    
    Returns:
    list of objects matched by the given path
  - read
```
public static <T> T read(URL jsonURL,
         String jsonPath,
         Filter... filters)
              throws IOException
```
    Creates a new JsonPath and applies it to the provided Json object
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonURL - url pointing to json doc
    jsonPath - the json path
    filters - filters to be applied to the filter place holders [?] in the path
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public static <T> T read(File jsonFile,
         String jsonPath,
         Filter... filters)
              throws IOException
```
    Creates a new JsonPath and applies it to the provided Json object
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonFile - json file
    jsonPath - the json path
    filters - filters to be applied to the filter place holders [?] in the path
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - read
```
public static <T> T read(InputStream jsonInputStream,
         String jsonPath,
         Filter... filters)
              throws IOException
```
    Creates a new JsonPath and applies it to the provided Json object
    
    Type Parameters:
    T - expected return type
    Parameters:
    jsonInputStream - json input stream
    jsonPath - the json path
    filters - filters to be applied to the filter place holders [?] in the path
    
    Returns:
    list of objects matched by the given path
    
    Throws:
    
    IOException
  - using
```
public static ParseContext using(Configuration configuration)
```
    Creates a ParseContext that can be used to parse a given JSON input.
    
    Parameters:
    configuration - configuration to use when parsing JSON
    
    Returns:
    a parsing context based on given configuration
  - using
```
public static ParseContext using(JsonProvider provider)
```
    Creates a ParseContext that will parse a given JSON input.
    
    Parameters:
    provider - provider to use when parsing JSON
    
    Returns:
    a parsing context based on given provider
  - parse
```
public static ReadContext parse(Object json)
```
    Parses the given JSON input using the default Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - input
    
    Returns:
    a read context
  - parse
```
public static ReadContext parse(String json)
```
    Parses the given JSON input using the default Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - string
    
    Returns:
    a read context
  - parse
```
public static ReadContext parse(InputStream json)
```
    Parses the given JSON input using the default Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - stream
    
    Returns:
    a read context
  - parse
```
public static ReadContext parse(File json)
                         throws IOException
```
    Parses the given JSON input using the default Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - file
    
    Returns:
    a read context
    
    Throws:
    
    IOException
  - parse
```
public static ReadContext parse(URL json)
                         throws IOException
```
    Parses the given JSON input using the default Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - url
    
    Returns:
    a read context
    
    Throws:
    
    IOException
  - parse
```
public static ReadContext parse(Object json,
                Configuration configuration)
```
    Parses the given JSON input using the provided Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - input
    
    Returns:
    a read context
  - parse
```
public static ReadContext parse(String json,
                Configuration configuration)
```
    Parses the given JSON input using the provided Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - input
    
    Returns:
    a read context
  - parse
```
public static ReadContext parse(InputStream json,
                Configuration configuration)
```
    Parses the given JSON input using the provided Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - input
    
    Returns:
    a read context
  - parse
```
public static ReadContext parse(File json,
                Configuration configuration)
                         throws IOException
```
    Parses the given JSON input using the provided Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - input
    
    Returns:
    a read context
    
    Throws:
    
    IOException
  - parse
```
public static ReadContext parse(URL json,
                Configuration configuration)
                         throws IOException
```
    Parses the given JSON input using the provided Configuration and returns a ReadContext for path evaluation
    
    Parameters:
    json - input
    
    Returns:
    a read context
    
    Throws:
    
    IOException

Class JsonPath

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copy

getPath

isPathDefinite

isPathDefinite

read

read

read

read

read

read

read

read

read

read

compile

read

read

read

read

read

using

using

parse

parse

parse

parse

parse

parse

parse

parse

parse

parse