Package net.minidev.json.actions

Class PathRemover

java.lang.Object

net.minidev.json.actions.PathRemover

public class PathRemover
extends Object

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

A path to remove 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.

Usage Example:

To remove the field k1.k2 from the JSONObject {k1:{k2:v2}, k3:{k4:v4}} use the remover like so:

 PathRemover pr = new PathRemover("k1.k2");
 JSONObject cleanObject = pr.remove(new JSONObject(...));
 

The resulting object 'cleanObject' would be {k1:{k3:{k4:v4}}}

See unit tests for more examples

Author:

adoneitan@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	pathsToRemove

Constructor Summary

Constructors

Constructor	Description
PathRemover(String... pathsToRemove)
PathRemover(List<String> pathsToRemove)
PathRemover(net.minidev.json.JSONArray pathsToRemove)

Method Summary

Modifier and Type	Method	Description
net.minidev.json.JSONObject	remove(net.minidev.json.JSONObject objectToClean)

Methods inherited from class java.lang.Object

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

Field Detail

pathsToRemove

protected List<String> pathsToRemove

Constructor Detail

PathRemover

public PathRemover(net.minidev.json.JSONArray pathsToRemove)

PathRemover

public PathRemover(List<String> pathsToRemove)

PathRemover

public PathRemover(String... pathsToRemove)

Method Detail

remove

public net.minidev.json.JSONObject remove(net.minidev.json.JSONObject objectToClean)