propane 3.8.0-java → 4.0.0-java

data/src/main/java/processing/data/FloatList.java

@@ -32,6 +32,7 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+     * @param length
    * @nowebref
    */
   public FloatList(int length) {
@@ -40,6 +41,7 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+   * @param list
    * @nowebref
    */
   public FloatList(float[] list) {
@@ -50,9 +52,9 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
-   * Construct an FloatList from an iterable pile of objects.
-   * For instance, a float array, an array of strings, who knows).
+   * Construct an FloatList from an iterable pile of objects.For instance, a float array, an array of strings, who knows).
    * Un-parseable or null values will be set to NaN.
+   * @param iter
    * @nowebref
    */
   public FloatList(Iterable<Object> iter) {
@@ -71,8 +73,8 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
-   * Construct an FloatList from a random pile of objects.
-   * Un-parseable or null values will be set to NaN.
+   * Construct an FloatList from a random pile of objects.Un-parseable or null values will be set to NaN.
+   * @param items
    */
   public FloatList(Object... items) {
     // nuts, no good way to pass missingValue to this fn (varargs must be last)
@@ -84,8 +86,8 @@ public class FloatList implements Iterable<Float> {
     for (Object o : items) {
       float value = missingValue;
       if (o != null) {
-        if (o instanceof Number) {
-          value = ((Number) o).floatValue();
+        if (o instanceof Number number) {
+          value = number.floatValue();
         } else {
           value = PApplet.parseFloat(o.toString().trim(), missingValue);
         }
@@ -111,6 +113,7 @@ public class FloatList implements Iterable<Float> {
   /**
    * Get the length of the list.
    *
+   * @return 
    * @webref floatlist:method
    * @brief Get the length of the list
    */
@@ -146,6 +149,8 @@ public class FloatList implements Iterable<Float> {
   /**
    * Get an entry at a particular index.
    *
+   * @param index
+   * @return 
    * @webref floatlist:method
    * @brief Get an entry at a particular index
    */
@@ -158,10 +163,12 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
-   * Set the entry at a particular index. If the index is past the length of
-   * the list, it'll expand the list to accommodate, and fill the intermediate
-   * entries with 0s.
+   * Set the entry at a particular index.If the index is past the length of
+ the list, it'll expand the list to accommodate, and fill the intermediate
+ entries with 0s.
    *
+   * @param index
+   * @param what
    * @webref floatlist:method
    * @brief Set the entry at a particular index
    */
@@ -177,7 +184,8 @@ public class FloatList implements Iterable<Float> {
   }
 
 
-  /** Just an alias for append(), but matches pop() */
+  /** Just an alias for append(), but matches pop()
+   * @param value */
   public void push(float value) {
     append(value);
   }
@@ -196,6 +204,8 @@ public class FloatList implements Iterable<Float> {
   /**
    * Remove an element from the specified index.
    *
+   * @param index
+   * @return 
    * @webref floatlist:method
    * @brief Remove an element from the specified index
    */
@@ -254,7 +264,10 @@ public class FloatList implements Iterable<Float> {
   }
 
 
-  /** Replace the first instance of a particular value */
+  /** Replace the first instance of a particular value
+   * @param value
+   * @param newValue
+   * @return  */
   public boolean replaceValue(float value, float newValue) {
     if (Float.isNaN(value)) {
       for (int i = 0; i < count; i++) {
@@ -274,7 +287,10 @@ public class FloatList implements Iterable<Float> {
   }
 
 
-  /** Replace all instances of a particular value */
+  /** Replace all instances of a particular value
+   * @param value
+   * @param newValue
+   * @return  */
   public boolean replaceValues(float value, float newValue) {
     boolean changed = false;
     if (Float.isNaN(value)) {
@@ -300,6 +316,7 @@ public class FloatList implements Iterable<Float> {
   /**
    * Add a new entry to the list.
    *
+   * @param value
    * @webref floatlist:method
    * @brief Add a new entry to the list
    */
@@ -325,7 +342,8 @@ public class FloatList implements Iterable<Float> {
   }
 
 
-  /** Add this value, but only if it's not already in the list. */
+  /** Add this value, but only if it's not already in the list.
+   * @param value */
   public void appendUnique(float value) {
     if (!hasValue(value)) {
       append(value);
@@ -445,7 +463,9 @@ public class FloatList implements Iterable<Float> {
 //    }
 
 
-  /** Return the first index of a particular value. */
+  /** Return the first index of a particular value.
+   * @param what
+   * @return  */
   public int index(float what) {
     /*
     if (indexCache != null) {
@@ -466,6 +486,8 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+     * @param value
+     * @return 
    * @webref floatlist:method
    * @brief Check if a number is a part of the list
    */
@@ -495,6 +517,8 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+   * @param index
+   * @param amount
    * @webref floatlist:method
    * @brief Add to a value
    */
@@ -508,6 +532,8 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+   * @param index
+   * @param amount
    * @webref floatlist:method
    * @brief Subtract from a value
    */
@@ -521,6 +547,8 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+   * @param index
+   * @param amount
    * @webref floatlist:method
    * @brief Multiply a value
    */
@@ -534,6 +562,8 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+   * @param index
+   * @param amount
    * @webref floatlist:method
    * @brief Divide a value
    */
@@ -557,6 +587,7 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+   * @return 
    * @webref floatlist:method
    * @brief Return the smallest value
    */
@@ -593,6 +624,7 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
+     * @return 
    * @webref floatlist:method
    * @brief Return the largest value
    */
@@ -765,6 +797,7 @@ public class FloatList implements Iterable<Float> {
   /**
    * Randomize the list order using the random() function from the specified
    * sketch, allowing shuffle() to use its current randomSeed() setting.
+   * @param sketch
    */
   public void shuffle(PApplet sketch) {
     int num = count;
@@ -786,9 +819,10 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
-   * Returns the actual array being used to store the data. For advanced users,
-   * this is the fastest way to access a large list. Suitable for iterating
-   * with a for() loop, but modifying the list will have terrible consequences.
+   * Returns the actual array being used to store the data.For advanced users,
+ this is the fastest way to access a large list. Suitable for iterating
+ with a for() loop, but modifying the list will have terrible consequences.
+     * @return 
    */
   public float[] values() {
     crop();
@@ -806,15 +840,18 @@ public class FloatList implements Iterable<Float> {
     return new Iterator<Float>() {
       int index = -1;
 
+      @Override
       public void remove() {
         FloatList.this.remove(index);
         index--;
       }
 
+      @Override
       public Float next() {
         return data[++index];
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < count;
       }
@@ -834,9 +871,10 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
-   * Copy values into the specified array. If the specified array is null or
-   * not the same size, a new array will be allocated.
+   * Copy values into the specified array.If the specified array is null or
+ not the same size, a new array will be allocated.
    * @param array
+   * @return 
    */
   public float[] array(float[] array) {
     if (array == null || array.length != count) {
@@ -848,10 +886,11 @@ public class FloatList implements Iterable<Float> {
 
 
   /**
-   * Returns a normalized version of this array. Called getPercent() for
-   * consistency with the Dict classes. It's a getter method because it needs
-   * to returns a new list (because IntList/Dict can't do percentages or
-   * normalization in place on int values).
+   * Returns a normalized version of this array.Called getPercent() for
+ consistency with the Dict classes. It's a getter method because it needs
+ to returns a new list (because IntList/Dict can't do percentages or
+ normalization in place on int values).
+   * @return 
    */
   public FloatList getPercent() {
     double sum = 0;
@@ -902,16 +941,18 @@ public class FloatList implements Iterable<Float> {
 
   /**
    * Save tab-delimited entries to a file (TSV format, UTF-8 encoding)
+     * @param file
    */
   public void save(File file) {
-    PrintWriter writer = PApplet.createWriter(file);
-    write(writer);
-    writer.close();
+      try (PrintWriter writer = PApplet.createWriter(file)) {
+          write(writer);
+      }
   }
 
 
   /**
    * Write entries to a PrintWriter, one per line
+   * @param writer
    */
   public void write(PrintWriter writer) {
     for (int i = 0; i < count; i++) {
@@ -923,6 +964,7 @@ public class FloatList implements Iterable<Float> {
 
   /**
    * Return this dictionary as a String in JSON format.
+   * @return 
    */
   public String toJSON() {
     return "[ " + join(", ") + " ]";

data/src/main/java/processing/data/IntDict.java

@@ -35,9 +35,11 @@ public class IntDict {
 
 
   /**
-   * Create a new lookup with a specific size. This is more efficient than not
-   * specifying a size. Use it when you know the rough size of the thing you're creating.
+   * Create a new lookup with a specific size.This is more efficient than not
+   * specifying a size. Use it when you know the rough size of the thing you're
+   * creating.
    *
+     * @param length
    * @nowebref
    */
   public IntDict(int length) {
@@ -51,6 +53,7 @@ public class IntDict {
    * Read a set of entries from a Reader that has each key/value pair on
    * a single line, separated by a tab.
    *
+   * @param reader
    * @nowebref
    */
   public IntDict(BufferedReader reader) {
@@ -58,18 +61,20 @@ public class IntDict {
     keys = new String[lines.length];
     values = new int[lines.length];
 
-    for (int i = 0; i < lines.length; i++) {
-      String[] pieces = PApplet.split(lines[i], '\t');
-      if (pieces.length == 2) {
-        keys[count] = pieces[0];
-        values[count] = PApplet.parseInt(pieces[1]);
-        indices.put(pieces[0], count);
-        count++;
+      for (String line : lines) {
+          String[] pieces = PApplet.split(line, '\t');
+          if (pieces.length == 2) {
+              keys[count] = pieces[0];
+              values[count] = PApplet.parseInt(pieces[1]);
+              indices.put(pieces[0], count);
+              count++;
+          }
       }
-    }
   }
 
   /**
+   * @param keys
+   * @param values
    * @nowebref
    */
   public IntDict(String[] keys, int[] values) {
@@ -93,6 +98,7 @@ public class IntDict {
    *   { "key2", 2 }
    * });
    * </pre>
+   * @param pairs
    */
   public IntDict(Object[][] pairs) {
     count = pairs.length;
@@ -109,6 +115,7 @@ public class IntDict {
   /**
    * Returns the number of key/value pairs
    *
+     * @return 
    * @webref intdict:method
    * @brief Returns the number of key/value pairs
    */
@@ -118,8 +125,8 @@ public class IntDict {
 
 
   /**
-   * Resize the internal data, this can only be used to shrink the list.
-   * Helpful for situations like sorting and then grabbing the top 50 entries.
+   * Resize the internal data, this can only be used to shrink the list.Helpful for situations like sorting and then grabbing the top 50 entries.
+   * @param length
    */
   public void resize(int length) {
     if (length > count) {
@@ -175,12 +182,7 @@ public class IntDict {
 
 
   public Iterable<Entry> entries() {
-    return new Iterable<Entry>() {
-
-      public Iterator<Entry> iterator() {
-        return entryIterator();
-      }
-    };
+    return () -> entryIterator();
   }
 
 
@@ -188,17 +190,20 @@ public class IntDict {
     return new Iterator<Entry>() {
       int index = -1;
 
+      @Override
       public void remove() {
         removeIndex(index);
         index--;
       }
 
+      @Override
       public Entry next() {
         ++index;
         Entry e = new Entry(keys[index], values[index]);
         return e;
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < size();
       }
@@ -223,13 +228,7 @@ public class IntDict {
 
 
   public Iterable<String> keys() {
-    return new Iterable<String>() {
-
-      @Override
-      public Iterator<String> iterator() {
-        return keyIterator();
-      }
-    };
+    return () -> keyIterator();
   }
 
 
@@ -238,15 +237,18 @@ public class IntDict {
     return new Iterator<String>() {
       int index = -1;
 
+      @Override
       public void remove() {
         removeIndex(index);
         index--;
       }
 
+      @Override
       public String next() {
         return key(++index);
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < size();
       }
@@ -255,8 +257,9 @@ public class IntDict {
 
 
   /**
-   * Return a copy of the internal keys array. This array can be modified.
+   * Return a copy of the internal keys array.This array can be modified.
    *
+   * @return 
    * @webref intdict:method
    * @brief Return a copy of the internal keys array
    */
@@ -281,17 +284,12 @@ public class IntDict {
 
 
   /**
+     * @return 
    * @webref intdict:method
    * @brief Return the internal array being used to store the values
    */
   public Iterable<Integer> values() {
-    return new Iterable<Integer>() {
-
-      @Override
-      public Iterator<Integer> iterator() {
-        return valueIterator();
-      }
-    };
+    return () -> valueIterator();
   }
 
 
@@ -299,15 +297,18 @@ public class IntDict {
     return new Iterator<Integer>() {
       int index = -1;
 
+      @Override
       public void remove() {
         removeIndex(index);
         index--;
       }
 
+      @Override
       public Integer next() {
         return value(++index);
       }
 
+      @Override
       public boolean hasNext() {
         return index+1 < size();
       }
@@ -318,6 +319,7 @@ public class IntDict {
   /**
    * Create a new array and copy each of the values into it.
    *
+   * @return 
    * @webref intdict:method
    * @brief Create a new array and copy each of the values into it
    */
@@ -329,10 +331,12 @@ public class IntDict {
 
   /**
    * Fill an already-allocated array with the values (more efficient than
-   * creating a new array each time). If 'array' is null, or not the same
-   * size as the number of values, a new array will be allocated and returned.
+   * creating a new array each time).If 'array' is null, or not the same
+ size as the number of values, a new array will be allocated and returned.
    *
    * @param array values to copy into the array
+   
+   * @return 
    */
   public int[] valueArray(int[] array) {
     if (array == null || array.length != size()) {
@@ -346,6 +350,8 @@ public class IntDict {
   /**
    * Return a value for the specified key.
    *
+   * @param key
+   * @return 
    * @webref intdict:method
    * @brief Return a value for the specified key
    */
@@ -368,6 +374,8 @@ public class IntDict {
   /**
    * Create a new key/value pair or change the value of one.
    *
+   * @param key
+   * @param amount
    * @webref intdict:method
    * @brief Create a new key/value pair or change the value of one
    */
@@ -391,6 +399,8 @@ public class IntDict {
 
 
   /**
+   * @param key
+   * @return 
    * @webref intdict:method
    * @brief Check if a key is a part of the data structure
    */
@@ -402,6 +412,7 @@ public class IntDict {
   /**
    * Increase the value associated with a specific key by 1.
    *
+     * @param key
    * @webref intdict:method
    * @brief Increase the value of a specific key value by 1
    */
@@ -411,9 +422,10 @@ public class IntDict {
 
 
   /**
-   * Merge another dictionary into this one. Calling this increment()
-   * since it doesn't make sense in practice for the other dictionary types,
-   * even though it's technically an add().
+   * Merge another dictionary into this one.Calling this increment()
+ since it doesn't make sense in practice for the other dictionary types,
+ even though it's technically an add().
+     * @param dict
    */
   public void increment(IntDict dict) {
     for (int i = 0; i < dict.count; i++) {
@@ -423,6 +435,8 @@ public class IntDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref intdict:method
    * @brief Add to a value
    */
@@ -437,6 +451,8 @@ public class IntDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref intdict:method
    * @brief Subtract from a value
    */
@@ -446,6 +462,8 @@ public class IntDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref intdict:method
    * @brief Multiply a value
    */
@@ -458,6 +476,8 @@ public class IntDict {
 
 
   /**
+   * @param key
+   * @param amount
    * @webref intdict:method
    * @brief Divide a value
    */
@@ -532,7 +552,8 @@ public class IntDict {
   }
 
 
-  /** return the key corresponding to the maximum value or null if no entries */
+  /** return the key corresponding to the maximum value or null if no entries
+   * @return  */
   public String maxKey() {
     //checkMinMax("maxKey");
     int index = maxIndex();
@@ -573,7 +594,7 @@ public class IntDict {
 
   public int index(String what) {
     Integer found = indices.get(what);
-    return (found == null) ? -1 : found.intValue();
+    return (found == null) ? -1 : found;
   }
 
 
@@ -582,13 +603,15 @@ public class IntDict {
       keys = PApplet.expand(keys);
       values = PApplet.expand(values);
     }
-    indices.put(what, Integer.valueOf(count));
+    indices.put(what, count);
     keys[count] = what;
     values[count] = much;
     count++;
   }
 
   /**
+   * @param key
+   * @return 
    * @webref intdict:method
    * @brief Remove a key/value pair
    */
@@ -747,7 +770,8 @@ public class IntDict {
   }
 
 
-  /** Returns a duplicate copy of this object. */
+  /** Returns a duplicate copy of this object.
+   * @return  */
   public IntDict copy() {
     IntDict outgoing = new IntDict(count);
     System.arraycopy(keys, 0, outgoing.keys, 0, count);
@@ -769,16 +793,18 @@ public class IntDict {
 
   /**
    * Save tab-delimited entries to a file (TSV format, UTF-8 encoding)
+   * @param file
    */
   public void save(File file) {
-    PrintWriter writer = PApplet.createWriter(file);
-    write(writer);
-    writer.close();
+      try (PrintWriter writer = PApplet.createWriter(file)) {
+          write(writer);
+      }
   }
 
 
   /**
    * Write tab-delimited entries to a PrintWriter
+     * @param writer
    */
   public void write(PrintWriter writer) {
     for (int i = 0; i < count; i++) {
@@ -790,6 +816,7 @@ public class IntDict {
 
   /**
    * Return this dictionary as a String in JSON format.
+   * @return 
    */
   public String toJSON() {
     StringList items = new StringList();