add missing jsdoc

Author: UrielCh

json-smart-action/pom.xml

@@ -250,6 +250,16 @@
                     </java>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-install-plugin</artifactId>
+                <version>3.1.4</version>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <version>3.1.4</version>
+            </plugin>
         </plugins>
     </build>
     <dependencies>

json-smart-action/src/main/java/net/minidev/json/actions/ElementRemover.java

@@ -31,16 +31,19 @@
 public class ElementRemover {
   private Map<String, Object> elementsToRemove;
 
+  /** Creates an element remover with the specified elements to remove */
   public ElementRemover(Map<String, Object> elementsToRemove) {
     this.elementsToRemove =
         elementsToRemove == null ? Collections.<String, Object>emptyMap() : elementsToRemove;
   }
 
+  /** Creates an element remover with the specified JSON object elements to remove */
   public ElementRemover(JSONObject elementsToRemove) {
     this.elementsToRemove =
         elementsToRemove == null ? Collections.<String, Object>emptyMap() : elementsToRemove;
   }
 
+  /** Removes the specified elements from the given JSON object */
   public JSONObject remove(JSONObject objectToClean) {
     JSONTraverseAction strategy = new RemoveElementsJsonAction(this.elementsToRemove);
     JSONTraverser traversal = new JSONTraverser(strategy);

json-smart-action/src/main/java/net/minidev/json/actions/PathLocator.java

@@ -23,8 +23,6 @@
  * 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.
  *
- * <p>
- *
  * @author [email protected]
  */
 public class PathLocator {

json-smart-action/src/main/java/net/minidev/json/actions/navigate/CopyPathsAction.java

@@ -26,8 +26,11 @@
  * @since 15 March 2016.
  */
 public class CopyPathsAction implements JSONNavigateAction {
+  /** The destination tree for copied paths */
   protected JSONObject destTree;
+  /** The current destination branch */
   protected JSONObject destBranch;
+  /** Stack for tracking destination nodes */
   protected Stack<Object> destNodeStack;
 
   @Override

json-smart-action/src/main/java/net/minidev/json/actions/navigate/JSONNavigator.java

@@ -5,15 +5,19 @@
 import net.minidev.json.JSONObject;
 
 /**
+ * A navigator that operates on JSON objects and arrays for path-based navigation.
+ * 
  * @author [email protected]
  * @since 15 June 2016.
  */
 public class JSONNavigator extends TreeNavigator<JSONObject, JSONArray> {
 
+  /** Creates a navigator with the specified action and paths */
   public JSONNavigator(JSONNavigateAction action, List<String> pathsToNavigate) {
     super(action, pathsToNavigate);
   }
 
+  /** Creates a navigator with the specified action and paths */
   public JSONNavigator(JSONNavigateAction action, String... pathsToNavigate) {
     super(action, pathsToNavigate);
   }

json-smart-action/src/main/java/net/minidev/json/actions/navigate/NavigateAction.java

@@ -10,6 +10,8 @@
  *
  * <p>See package-info for more details
  *
+ * @param <M> the map type that extends Map&lt;String, Object&gt;
+ * @param <L> the list type that extends List&lt;Object&gt;
  * @author [email protected]
  * @since 15 June 2016
  */

json-smart-action/src/main/java/net/minidev/json/actions/navigate/TreeNavigator.java

@@ -23,14 +23,20 @@
  * <p>To navigate the branch k1.k2 of the object {"k1":{"k2":"v1"}, "k3":{"k4":"v2"}} instantiate
  * the navigator like so: new JSONNavigator("k1.k2")
  *
+ * @param <M> the map type that extends Map&lt;String, Object&gt;
+ * @param <L> the list type that extends List&lt;Object&gt;
  * @author [email protected]
  * @since 15 June 2016.
  */
 public class TreeNavigator<M extends Map<String, Object>, L extends List<Object>> {
+  /** The list of paths to navigate */
   protected List<String> pathsToNavigate;
+  /** The navigation action to execute */
   protected NavigateAction<M, L> action;
+  /** The path prefix to use */
   protected String pathPrefix = "";
 
+  /** Creates a tree navigator with the specified action and paths */
   public TreeNavigator(NavigateAction<M, L> action, List<String> pathsToNavigate) {
     if (action == null) {
       throw new IllegalArgumentException("NavigateAction cannot be null");
@@ -39,15 +45,18 @@ public TreeNavigator(NavigateAction<M, L> action, List<String> pathsToNavigate)
     this.pathsToNavigate = pathsToNavigate;
   }
 
+  /** Sets a path prefix for this navigator */
   public TreeNavigator<M, L> with(String pathPrefix) {
     this.pathPrefix = pathPrefix;
     return this;
   }
 
+  /** Creates a tree navigator with the specified action and paths */
   public TreeNavigator(NavigateAction<M, L> action, String... pathsToNavigate) {
     this(action, Arrays.asList(pathsToNavigate));
   }
 
+  /** Navigates the specified object using the configured paths */
   public void nav(M object) throws Exception {
     if (action.start(object, pathsToNavigate)) {
       for (String path : pathsToNavigate) {

json-smart-action/src/main/java/net/minidev/json/actions/path/DotDelimiter.java

@@ -8,8 +8,10 @@
  * @since 31 May2016
  */
 public class DotDelimiter extends PathDelimiter {
+  /** The dot delimiter character */
   protected static final char DELIM_CHAR = '.';
 
+  /** Creates a new dot delimiter */
   public DotDelimiter() {
     super(DELIM_CHAR);
   }

json-smart-action/src/main/java/net/minidev/json/actions/path/PathDelimiter.java

@@ -7,32 +7,41 @@
  * @since 31 May 2016
  */
 public abstract class PathDelimiter {
+  /** The delimiter character */
   protected char delimChar;
+  /** The delimiter as a string */
   protected String delimStr;
+  /** Whether to accept delimiter characters in keys */
   protected boolean acceptDelimInKey;
 
+  /** Creates a path delimiter with the specified character */
   public PathDelimiter(char delim) {
     this.delimChar = delim;
     this.delimStr = String.valueOf(delim);
   }
 
+  /** Configures whether to accept delimiter characters in node names */
   public PathDelimiter withAcceptDelimiterInNodeName(boolean acceptDelimInKey) {
     this.acceptDelimInKey = acceptDelimInKey;
     return this;
   }
 
+  /** Checks if the given key is acceptable based on delimiter rules */
   public boolean accept(String key) {
     if (!acceptDelimInKey && key.contains(delimStr)) return false;
     return true;
   }
 
+  /** Returns the delimiter as a string */
   public String str() {
     return delimStr;
   }
 
+  /** Returns the delimiter character */
   public char chr() {
     return delimChar;
   }
 
+  /** Returns the regex pattern for this delimiter */
   public abstract String regex();
 }

json-smart-action/src/main/java/net/minidev/json/actions/traverse/KeysPrintAction.java

@@ -5,6 +5,8 @@
 import net.minidev.json.JSONObject;
 
 /**
+ * A traverse action that prints keys during JSON traversal.
+ * 
  * @author [email protected]
  * @since 5/24/16.
  */