picrate 0.5.0-java → 0.6.0-java

data/src/main/java/processing/data/JSONArray.java

@@ -114,6 +114,7 @@ public class JSONArray {
 
 
   /**
+     * @param reader
    * @nowebref
    */
   public JSONArray(Reader reader) {
@@ -162,6 +163,7 @@ public class JSONArray {
 
 
   /**
+     * @param list
    * @nowebref
    */
   public JSONArray(IntList list) {
@@ -173,6 +175,7 @@ public class JSONArray {
 
 
   /**
+     * @param list
    * @nowebref
    */
   public JSONArray(FloatList list) {
@@ -184,6 +187,7 @@ public class JSONArray {
 
 
   /**
+     * @param list
    * @nowebref
    */
   public JSONArray(StringList list) {
@@ -228,6 +232,7 @@ public class JSONArray {
   // TODO not decided whether we keep this one, but used heavily by JSONObject
   /**
    * Construct a JSONArray from an array
+     * @param array
    * @throws RuntimeException If not an array.
    */
   protected JSONArray(Object array) {
@@ -386,9 +391,10 @@ public class JSONArray {
 
 
   /**
-   * Get a value from an index as a float. JSON uses 'double' values
-   * internally, so this is simply getDouble() cast to a float.
+   * Get a value from an index as a float.JSON uses 'double' values
+ internally, so this is simply getDouble() cast to a float.
    *
+     * @return 
    * @webref jsonarray:method
    * @brief Gets the float value associated with an index
    * @param index must be between 0 and length() - 1
@@ -400,8 +406,13 @@ public class JSONArray {
     return (float) getDouble(index);
   }
 
-
-  public float getFloat(int index, float defaultValue) {
+    /**
+     *
+     * @param index
+     * @param defaultValue
+     * @return
+     */
+    public float getFloat(int index, float defaultValue) {
     try {
       return getFloat(index);
     } catch (Exception e) {
@@ -516,8 +527,13 @@ public class JSONArray {
     throw new RuntimeException("JSONArray[" + index + "] is not a JSONArray.");
   }
 
-
-  public JSONArray getJSONArray(int index, JSONArray defaultValue) {
+    /**
+     *
+     * @param index
+     * @param defaultValue
+     * @return
+     */
+    public JSONArray getJSONArray(int index, JSONArray defaultValue) {
     try {
       return getJSONArray(index);
     } catch (Exception e) {
@@ -547,8 +563,13 @@ public class JSONArray {
     throw new RuntimeException("JSONArray[" + index + "] is not a JSONObject.");
   }
 
-
-  public JSONObject getJSONObject(int index, JSONObject defaultValue) {
+    /**
+     *
+     * @param index
+     * @param defaultValue
+     * @return
+     */
+    public JSONObject getJSONObject(int index, JSONObject defaultValue) {
     try {
       return getJSONObject(index);
     } catch (Exception e) {
@@ -560,6 +581,7 @@ public class JSONArray {
   /**
    * Get this entire array as a String array.
    *
+     * @return 
    * @webref jsonarray:method
    * @brief Gets the entire array as an array of Strings
    * @see JSONArray#getIntArray()
@@ -574,8 +596,9 @@ public class JSONArray {
 
 
   /**
-   * Get this entire array as an int array. Everything must be an int.
+   * Get this entire array as an int array.Everything must be an int.
    *
+     * @return 
    * @webref jsonarray:method
    * @brief Gets the entire array as array of ints
    * @see JSONArray#getStringArray()
@@ -589,7 +612,8 @@ public class JSONArray {
   }
 
 
-  /** Get this entire array as a long array. Everything must be an long. */
+  /** *  Get this entire array as a long array.Everything must be an long.
+     * @return  */
   public long[] getLongArray() {
     long[] outgoing = new long[size()];
     for (int i = 0; i < size(); i++) {
@@ -599,7 +623,8 @@ public class JSONArray {
   }
 
 
-  /** Get this entire array as a float array. Everything must be an float. */
+  /** *  Get this entire array as a float array.Everything must be an float.
+     * @return  */
   public float[] getFloatArray() {
     float[] outgoing = new float[size()];
     for (int i = 0; i < size(); i++) {
@@ -609,7 +634,8 @@ public class JSONArray {
   }
 
 
-  /** Get this entire array as a double array. Everything must be an double. */
+  /** *  Get this entire array as a double array.Everything must be an double.
+     * @return  */
   public double[] getDoubleArray() {
     double[] outgoing = new double[size()];
     for (int i = 0; i < size(); i++) {
@@ -619,7 +645,8 @@ public class JSONArray {
   }
 
 
-  /** Get this entire array as a boolean array. Everything must be a boolean. */
+  /** *  Get this entire array as a boolean array.Everything must be a boolean.
+     * @return  */
   public boolean[] getBooleanArray() {
     boolean[] outgoing = new boolean[size()];
     for (int i = 0; i < size(); i++) {
@@ -802,6 +829,7 @@ public class JSONArray {
 
   /**
    * @param value a JSONArray value
+     * @return 
    */
   public JSONArray append(JSONArray value) {
     myArrayList.add(value);
@@ -811,6 +839,7 @@ public class JSONArray {
 
   /**
    * @param value a JSONObject value
+     * @return 
    */
   public JSONArray append(JSONObject value) {
     myArrayList.add(value);
@@ -974,6 +1003,7 @@ public class JSONArray {
 //  }
 
   /**
+     * @return 
    * @webref jsonarray:method
    * @brief Sets the JSONArray value associated with an index value
    * @param index the index value to target
@@ -988,6 +1018,7 @@ public class JSONArray {
   }
 
   /**
+     * @return 
    * @webref jsonarray:method
    * @brief Sets the JSONObject value associated with an index value
    * @param index the index value to target
@@ -1098,6 +1129,13 @@ public class JSONArray {
 //    return write(PApplet.createWriter(output), null);
 //  }
 
+    /**
+     *
+     * @param file
+     * @param options
+     * @return
+     */
+
 
   public boolean save(File file, String options) {
     PrintWriter writer = PApplet.createWriter(file);
@@ -1106,13 +1144,22 @@ public class JSONArray {
     return success;
   }
 
-
-  public boolean write(PrintWriter output) {
+    /**
+     *
+     * @param output
+     * @return
+     */
+    public boolean write(PrintWriter output) {
     return write(output, null);
   }
 
-
-  public boolean write(PrintWriter output, String options) {
+    /**
+     *
+     * @param output
+     * @param options
+     * @return
+     */
+    public boolean write(PrintWriter output, String options) {
     int indentFactor = 2;
     if (options != null) {
       String[] opts = PApplet.split(options, ',');
@@ -1136,9 +1183,10 @@ public class JSONArray {
 
 
   /**
-   * Return the JSON data formatted with two spaces for indents.
-   * Chosen to do this since it's the most common case (e.g. with println()).
-   * Same as format(2). Use the format() function for more options.
+   * Return the JSON data formatted with two spaces for indents.Chosen to do this since it's the most common case (e.g.
+   * with println()).
+ Same as format(2). Use the format() function for more options.
+     * @return 
    */
   @Override
   public String toString() {
@@ -1186,6 +1234,7 @@ public class JSONArray {
    * <p>
    * Warning: This method assumes that the data structure is acyclic.
    *
+     * @param writer
    * @param indentFactor
    *            The number of spaces to add to each level of indentation.
    *            Use -1 to specify no indentation and no newlines.

data/src/main/java/processing/data/JSONObject.java

@@ -220,6 +220,7 @@ public class JSONObject {
 
 
   /**
+     * @param reader
    * @nowebref
    */
   public JSONObject(Reader reader) {
@@ -306,6 +307,7 @@ public class JSONObject {
 
 
   /**
+     * @param dict
    * @nowebref
    */
   public JSONObject(IntDict dict) {
@@ -317,6 +319,7 @@ public class JSONObject {
 
 
   /**
+     * @param dict
    * @nowebref
    */
   public JSONObject(FloatDict dict) {
@@ -328,6 +331,7 @@ public class JSONObject {
 
 
   /**
+     * @param dict
    * @nowebref
    */
   public JSONObject(StringDict dict) {
@@ -389,11 +393,11 @@ public class JSONObject {
 
 
   /**
-   * Construct a JSONObject from a source JSON text string.
-   * This is the most commonly used JSONObject constructor.
+   * Construct a JSONObject from a source JSON text string.This is the most commonly used JSONObject constructor.
    * @param source    A string beginning
    *  with <code>{</code>&nbsp;<small>(left brace)</small> and ending
    *  with <code>}</code>&nbsp;<small>(right brace)</small>.
+     * @return 
    * @exception RuntimeException If there is a syntax error in the source
    *  string or a duplicated key.
    */
@@ -678,6 +682,7 @@ public class JSONObject {
 
 
   /**
+     * @return 
    * @webref jsonobject:method
    * @brief Gets the float value associated with a key
    * @param key a key string
@@ -689,8 +694,13 @@ public class JSONObject {
     return (float) getDouble(key);
   }
 
-
-  public float getFloat(String key, float defaultValue) {
+    /**
+     *
+     * @param key
+     * @param defaultValue
+     * @return
+     */
+    public float getFloat(String key, float defaultValue) {
     try {
       return getFloat(key);
     } catch (Exception e) {
@@ -1156,6 +1166,7 @@ public class JSONObject {
 
 
   /**
+     * @return 
    * @webref jsonobject:method
    * @brief Put a key/String pair in the JSONObject
    * @param key a key string
@@ -1202,6 +1213,7 @@ public class JSONObject {
   }
 
   /**
+     * @return 
    * @webref jsonobject:method
    * @brief Put a key/float pair in the JSONObject
    * @param key a key string
@@ -1250,6 +1262,7 @@ public class JSONObject {
   }
 
   /**
+     * @return 
    * @webref jsonobject:method
    * @brief Sets the JSONObject value associated with a key
    * @param key a key string
@@ -1263,6 +1276,7 @@ public class JSONObject {
   }
 
   /**
+     * @return 
    * @webref jsonobject:method
    * @brief Sets the JSONArray value associated with a key
    * @param key a key string
@@ -1399,7 +1413,14 @@ public class JSONObject {
     }
   }
 
-  static public Writer quote(String string, Writer w) throws IOException {
+    /**
+     *
+     * @param string
+     * @param w
+     * @return
+     * @throws IOException
+     */
+    static public Writer quote(String string, Writer w) throws IOException {
     if (string == null || string.length() == 0) {
       w.write("\"\"");
       return w;
@@ -1570,6 +1591,13 @@ public class JSONObject {
 //    return save(PApplet.createWriter(output));
 //  }
 
+    /**
+     *
+     * @param file
+     * @param options
+     * @return
+     */
+
 
   public boolean save(File file, String options) {
     PrintWriter writer = PApplet.createWriter(file);
@@ -1578,13 +1606,22 @@ public class JSONObject {
     return success;
   }
 
-
-  public boolean write(PrintWriter output) {
+    /**
+     *
+     * @param output
+     * @return
+     */
+    public boolean write(PrintWriter output) {
     return write(output, null);
   }
 
-
-  public boolean write(PrintWriter output, String options) {
+    /**
+     *
+     * @param output
+     * @param options
+     * @return
+     */
+    public boolean write(PrintWriter output, String options) {
     int indentFactor = 2;
     if (options != null) {
       String[] opts = PApplet.split(options, ',');
@@ -1608,9 +1645,10 @@ public class JSONObject {
 
 
   /**
-   * Return the JSON data formatted with two spaces for indents.
-   * Chosen to do this since it's the most common case (e.g. with println()).
-   * Same as format(2). Use the format() function for more options.
+   * Return the JSON data formatted with two spaces for indents.Chosen to do this since it's the most common case (e.g.
+   * with println()).
+ Same as format(2). Use the format() function for more options.
+     * @return 
    */
   @Override
   public String toString() {
@@ -1812,6 +1850,9 @@ public class JSONObject {
    * <p>
    * Warning: This method assumes that the data structure is acyclical.
    *
+     * @param writer
+     * @param indentFactor
+     * @param indent
    * @return The writer.
    * @throws RuntimeException
    */

data/src/main/java/processing/data/Sort.java

@@ -7,18 +7,27 @@ package processing.data;
  */
 public abstract class Sort implements Runnable {
 
-  public Sort() { }
+    /**
+     *
+     */
+    public Sort() { }
 
-
-  public void run() {
+    /**
+     *
+     */
+    public void run() {
     int c = size();
     if (c > 1) {
       sort(0, c - 1);
     }
   }
 
-
-  protected void sort(int i, int j) {
+    /**
+     *
+     * @param i
+     * @param j
+     */
+    protected void sort(int i, int j) {
     int pivotIndex = (i+j)/2;
     swap(pivotIndex, j);
     int k = partition(i-1, j);
@@ -27,8 +36,13 @@ public abstract class Sort implements Runnable {
     if ((j-k) > 1) sort(k+1, j);
   }
 
-
-  protected int partition(int left, int right) {
+    /**
+     *
+     * @param left
+     * @param right
+     * @return
+     */
+    protected int partition(int left, int right) {
     int pivot = right;
     do {
       while (compare(++left, pivot) < 0) { }
@@ -39,8 +53,24 @@ public abstract class Sort implements Runnable {
     return left;
   }
 
+    /**
+     *
+     * @return
+     */
+    abstract public int size();
+
+    /**
+     *
+     * @param a
+     * @param b
+     * @return
+     */
+    abstract public float compare(int a, int b);
 
-  abstract public int size();
-  abstract public float compare(int a, int b);
-  abstract public void swap(int a, int b);
+    /**
+     *
+     * @param a
+     * @param b
+     */
+    abstract public void swap(int a, int b);
 }