Package com.jayway.jsonpath
Interface ReadContext
-
- All Known Subinterfaces:
DocumentContext
- All Known Implementing Classes:
JsonContext
public interface ReadContext
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Configuration
configuration()
Returns the configuration used for reading<T> T
json()
Returns the JSON model that this context is operating onjava.lang.String
jsonString()
Returns the JSON model that this context is operating on as a JSON stringReadContext
limit(int maxResults)
Stops evaluation when maxResults limit has been reached<T> T
read(JsonPath path)
Reads the given path from this context<T> T
read(JsonPath path, TypeRef<T> typeRef)
Reads the given path from this context Sample code to create a TypeRefTypeRef ref = new TypeRef
- >() {};
<T> T
read(JsonPath path, java.lang.Class<T> type)
Reads the given path from this context<T> T
read(java.lang.String path, Predicate... filters)
Reads the given path from this context<T> T
read(java.lang.String path, TypeRef<T> typeRef)
Reads the given path from this context Sample code to create a TypeRefTypeRef ref = new TypeRef
- >() {};
<T> T
read(java.lang.String path, java.lang.Class<T> type, Predicate... filters)
Reads the given path from this contextReadContext
withListeners(EvaluationListener... listener)
Adds listener to the evaluation of this path
-
-
-
Method Detail
-
configuration
Configuration configuration()
Returns the configuration used for reading- Returns:
- an immutable configuration
-
json
<T> T json()
Returns the JSON model that this context is operating on- Returns:
- json model
-
jsonString
java.lang.String jsonString()
Returns the JSON model that this context is operating on as a JSON string- Returns:
- json model as string
-
read
<T> T read(java.lang.String path, Predicate... filters)
Reads the given path from this context- Type Parameters:
T
-- Parameters:
path
- path to readfilters
- filters- Returns:
- result
-
read
<T> T read(java.lang.String path, java.lang.Class<T> type, Predicate... filters)
Reads the given path from this context- Type Parameters:
T
-- Parameters:
path
- path to readtype
- expected return type (will try to map)filters
- filters- Returns:
- result
-
read
<T> T read(JsonPath path)
Reads the given path from this context- Type Parameters:
T
-- Parameters:
path
- path to apply- Returns:
- result
-
read
<T> T read(JsonPath path, java.lang.Class<T> type)
Reads the given path from this context- Type Parameters:
T
-- Parameters:
path
- path to applytype
- expected return type (will try to map)- Returns:
- result
-
read
<T> T read(JsonPath path, TypeRef<T> typeRef)
Reads the given path from this context Sample code to create a TypeRefTypeRef ref = new TypeRef
- >() {};
- Type Parameters:
T
-- Parameters:
path
- path to applytypeRef
- expected return type (will try to map)- Returns:
- result
-
read
<T> T read(java.lang.String path, TypeRef<T> typeRef)
Reads the given path from this context Sample code to create a TypeRefTypeRef ref = new TypeRef
- >() {};
- Type Parameters:
T
-- Parameters:
path
- path to applytypeRef
- expected return type (will try to map)- Returns:
- result
-
limit
ReadContext limit(int maxResults)
Stops evaluation when maxResults limit has been reached- Parameters:
maxResults
-- Returns:
- the read context
-
withListeners
ReadContext withListeners(EvaluationListener... listener)
Adds listener to the evaluation of this path- Parameters:
listener
- listeners to add- Returns:
- the read context
-
-