Package net.minidev.json.actions

Class PathsRetainer

java.lang.Object

net.minidev.json.actions.PathsRetainer

public class PathsRetainer
extends Object

Retains branches of nodes of a JSONObject matching the list of user-specified paths.

A path to copy must be specified in the n-gram format - a list of keys from the root down separated by dots: K0[[[[.K1].K2].K3]...]
A key to the right of a dot is a direct child of a key to the left of a dot. Keys with a dot in their name are not supported.

Example:

to retain the field k1.k2 in the JSONObject {k1:{k2:v1}, k3:{k4:v2}} instantiate the retainer like so: new JSONObjectCleaner("k1.k2") The resulting object would be {k1:{k2:v1}}

See unit tests in JSONObjectRetainerTest for more examples

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field	Description
protected PathDelimiter	pathDelimiter
protected List<String>	pathsToRetain

Constructor Summary

Constructors

Constructor	Description
PathsRetainer(String... pathsToRetain)
PathsRetainer(List<String> pathsToRetain)
PathsRetainer(net.minidev.json.JSONArray pathsToRetain)

Method Summary

Modifier and Type	Method	Description
net.minidev.json.JSONObject	retain(net.minidev.json.JSONObject object)
PathsRetainer	with(PathDelimiter pathDelimiter)

Methods inherited from class java.lang.Object

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

Field Detail

pathsToRetain

protected List<String> pathsToRetain

pathDelimiter

protected PathDelimiter pathDelimiter

Constructor Detail

PathsRetainer

public PathsRetainer(net.minidev.json.JSONArray pathsToRetain)

PathsRetainer

public PathsRetainer(List<String> pathsToRetain)

PathsRetainer

public PathsRetainer(String... pathsToRetain)

Method Detail

with

public PathsRetainer with(PathDelimiter pathDelimiter)

retain

public net.minidev.json.JSONObject retain(net.minidev.json.JSONObject object)