Package com.alibaba.fastjson

Class JSONPath

java.lang.Object

com.alibaba.fastjson.JSONPath

All Implemented Interfaces:

JSONAware

public class JSONPath
extends Object
implements JSONAware

Since:

1.2.0

Author:

wenshao[szujobs@hotmail.com]

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JSONPath.FilterSegment

Constructor Summary

Constructors

Constructor	Description
JSONPath(String path)
JSONPath(String path, boolean ignoreNullValue)
JSONPath(String path, SerializeConfig serializeConfig, ParserConfig parserConfig, boolean ignoreNullValue)

Method Summary

Modifier and Type	Method	Description
void	arrayAdd(Object rootObject, Object... values)
static void	arrayAdd(Object rootObject, String path, Object... values)
static JSONPath	compile(String path)
static JSONPath	compile(String path, boolean ignoreNullValue)
boolean	contains(Object rootObject)
static boolean	contains(Object rootObject, String path)
boolean	containsValue(Object rootObject, Object value)
static boolean	containsValue(Object rootObject, String path, Object value)
Object	eval(Object rootObject)
<T> T	eval(Object rootObject, Type clazz)
<T> T	eval(Object rootObject, Type clazz, ParserConfig parserConfig)
static Object	eval(Object rootObject, String path)
static Object	eval(Object rootObject, String path, boolean ignoreNullValue)
Object	extract(DefaultJSONParser parser)
static Object	extract(String json, String path)
static Object	extract(String json, String path, ParserConfig config, int features, Feature... optionFeatures)
String	getPath()
boolean	isRef()
Set<?>	keySet(Object rootObject)	Extract keySet or field names from rootObject on this JSONPath.
static Set<?>	keySet(Object rootObject, String path)	Compile jsonPath and use it to extract keySet or field names from rootObject.
void	patchAdd(Object rootObject, Object value, boolean replace)
static Map<String,Object>	paths(Object javaObject)
static Map<String,Object>	paths(Object javaObject, SerializeConfig config)
static Object	read(String json, String path)
static <T> T	read(String json, String path, Type clazz)
static <T> T	read(String json, String path, Type clazz, ParserConfig parserConfig)
boolean	remove(Object rootObject)
static boolean	remove(Object root, String path)
boolean	removeArrayItem(JSONPath path, Object currentObject, int index)
static Object	reserveToArray(Object object, String... paths)
static Object	reserveToObject(Object object, String... paths)
boolean	set(Object rootObject, Object value)
boolean	set(Object rootObject, Object value, boolean p)
static boolean	set(Object rootObject, String path, Object value)
boolean	setArrayItem(JSONPath path, Object currentObject, int index, Object value)
int	size(Object rootObject)
static int	size(Object rootObject, String path)
String	toJSONString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONPath

public JSONPath(String path)

JSONPath

public JSONPath(String path,
                boolean ignoreNullValue)

JSONPath

public JSONPath(String path,
                SerializeConfig serializeConfig,
                ParserConfig parserConfig,
                boolean ignoreNullValue)

Method Detail

isRef

public boolean isRef()

eval

public Object eval(Object rootObject)

eval

public <T> T eval(Object rootObject,
                  Type clazz,
                  ParserConfig parserConfig)

Parameters:

rootObject -

clazz -

parserConfig -

Returns:

Since:

1.2.76

eval

public <T> T eval(Object rootObject,
                  Type clazz)

Parameters:

rootObject -

clazz -

Returns:

Since:

1.2.76

extract

public Object extract(DefaultJSONParser parser)

contains

public boolean contains(Object rootObject)

containsValue

public boolean containsValue(Object rootObject,
                             Object value)

size

public int size(Object rootObject)

keySet

public Set<?> keySet(Object rootObject)

Extract keySet or field names from rootObject on this JSONPath.

Parameters:

rootObject - Can be a map or custom object. Array and Collection are not supported.

Returns:

Set of keys, or null if not supported.

patchAdd

public void patchAdd(Object rootObject,
                     Object value,
                     boolean replace)

arrayAdd

public void arrayAdd(Object rootObject,
                     Object... values)

remove

public boolean remove(Object rootObject)

set

public boolean set(Object rootObject,
                   Object value)

set

public boolean set(Object rootObject,
                   Object value,
                   boolean p)

eval

public static Object eval(Object rootObject,
                          String path)

eval

public static Object eval(Object rootObject,
                          String path,
                          boolean ignoreNullValue)

size

public static int size(Object rootObject,
                       String path)

keySet

public static Set<?> keySet(Object rootObject,
                            String path)

Compile jsonPath and use it to extract keySet or field names from rootObject.

Parameters:

rootObject - Can be a map or custom object. Array and Collection are not supported.

path - JSONPath string to be compiled.

Returns:

Set of keys, or null if not supported.

contains

public static boolean contains(Object rootObject,
                               String path)

containsValue

public static boolean containsValue(Object rootObject,
                                    String path,
                                    Object value)

arrayAdd

public static void arrayAdd(Object rootObject,
                            String path,
                            Object... values)

set

public static boolean set(Object rootObject,
                          String path,
                          Object value)

remove

public static boolean remove(Object root,
                             String path)

compile

public static JSONPath compile(String path)

compile

public static JSONPath compile(String path,
                               boolean ignoreNullValue)

read

public static Object read(String json,
                          String path)

Parameters:

json -

path -

Returns:

Since:

1.2.9

read

public static <T> T read(String json,
                         String path,
                         Type clazz,
                         ParserConfig parserConfig)

Parameters:

json -

path -

clazz -

parserConfig -

Returns:

Since:

1.2.76

read

public static <T> T read(String json,
                         String path,
                         Type clazz)

Parameters:

json -

path -

clazz -

Returns:

Since:

1.2.76

extract

public static Object extract(String json,
                             String path,
                             ParserConfig config,
                             int features,
                             Feature... optionFeatures)

Parameters:

json -

path -

Returns:

Since:

1.2.51

extract

public static Object extract(String json,
                             String path)

paths

public static Map<String,Object> paths(Object javaObject)

paths

public static Map<String,Object> paths(Object javaObject,
                                             SerializeConfig config)

getPath

public String getPath()

setArrayItem

public boolean setArrayItem(JSONPath path,
                            Object currentObject,
                            int index,
                            Object value)

removeArrayItem

public boolean removeArrayItem(JSONPath path,
                               Object currentObject,
                               int index)

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface JSONAware

Returns:

JSON text

reserveToArray

public static Object reserveToArray(Object object,
                                    String... paths)

reserveToObject

public static Object reserveToObject(Object object,
                                     String... paths)