Package net.minidev.json.actions

Class ElementRemover

  • public class ElementRemover
extends java.lang.Object
    Removes key:value elements from every node of a JSONObject matching the list of user-specified elements.

    An element to remove must be specified as a key:value pair

    Usage Example:

    To remove the element k2:v2 from the JSONObject {k0:{k2:v2, k3:v3}, k1:{k2:v2, k4:v4}} use the remover like so: 

     PathRemover pr = new PathRemover("k2.v2");
 JSONObject cleanObject = pr.remove(new JSONObject(...));
    The resulting object 'cleanObject' would be {k0:{k3:v3}, k1:{k4:v4}}

    See unit tests for more examples

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Map<java.lang.String,​java.lang.Object> elementsToRemove  

    • Constructor Summary

      Constructors 
      Constructor Description
      ElementRemover​(java.util.Map<java.lang.String,​java.lang.Object> elementsToRemove)
      Creates an element remover with the specified elements to remove
      ElementRemover​(JSONObject elementsToRemove)
      Creates an element remover with the specified JSON object elements to remove

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      JSONObject remove​(JSONObject objectToClean)
      Removes the specified elements from the given JSON object

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • elementsToRemove

        private java.util.Map<java.lang.String,​java.lang.Object> elementsToRemove

    • Constructor Detail

      • ElementRemover

        public ElementRemover​(java.util.Map<java.lang.String,​java.lang.Object> elementsToRemove)
        Creates an element remover with the specified elements to remove

      • ElementRemover

        public ElementRemover​(JSONObject elementsToRemove)
        Creates an element remover with the specified JSON object elements to remove

    • Method Detail

      • remove

        public JSONObject remove​(JSONObject objectToClean)
        Removes the specified elements from the given JSON object