picrate 0.5.0-java → 0.6.0-java

data/src/main/java/processing/data/TableRow.java

@@ -14,6 +14,7 @@ import java.io.PrintWriter;
 public interface TableRow {
 
   /**
+     * @return 
    * @webref tablerow:method
    * @brief Get an String value from the specified column
    * @param column ID number of the column to reference
@@ -24,10 +25,12 @@ public interface TableRow {
 
   /**
    * @param columnName title of the column to reference
+     * @return 
    */
   public String getString(String columnName);
 
   /**
+     * @return 
    * @webref tablerow:method
    * @brief Get an integer value from the specified column
    * @param column ID number of the column to reference
@@ -38,10 +41,12 @@ public interface TableRow {
 
   /**
    * @param columnName title of the column to reference
+     * @return 
    */
   public int getInt(String columnName);
 
   /**
+     * @return 
    * @brief Get a long value from the specified column
    * @param column ID number of the column to reference
    * @see TableRow#getFloat(int)
@@ -52,10 +57,12 @@ public interface TableRow {
 
   /**
    * @param columnName title of the column to reference
+     * @return 
    */
   public long getLong(String columnName);
 
   /**
+     * @return 
    * @webref tablerow:method
    * @brief Get a float value from the specified column
    * @param column ID number of the column to reference
@@ -66,10 +73,12 @@ public interface TableRow {
 
   /**
    * @param columnName title of the column to reference
+     * @return 
    */
   public float getFloat(String columnName);
   
   /**
+     * @return 
    * @brief Get a double value from the specified column
    * @param column ID number of the column to reference
    * @see TableRow#getInt(int)
@@ -79,6 +88,7 @@ public interface TableRow {
   
   /**
    * @param columnName title of the column to reference
+     * @return 
    */
   public double getDouble(String columnName);
 
@@ -93,6 +103,7 @@ public interface TableRow {
   public void setString(int column, String value);
   /**
    * @param columnName title of the target column
+     * @param value
    */
   public void setString(String columnName, String value);
 
@@ -108,6 +119,7 @@ public interface TableRow {
 
   /**
    * @param columnName title of the target column
+     * @param value
    */
   public void setInt(String columnName, int value);
   
@@ -122,6 +134,7 @@ public interface TableRow {
   
   /**
    * @param columnName title of the target column
+     * @param value
    */
   public void setLong(String columnName, long value);
 
@@ -137,6 +150,7 @@ public interface TableRow {
   
   /**
    * @param columnName title of the target column
+     * @param value
    */
   public void setFloat(String columnName, float value);
 
@@ -151,6 +165,7 @@ public interface TableRow {
   
   /**
    * @param columnName title of the target column
+     * @param value
    */
   public void setDouble(String columnName, double value);
 
@@ -170,6 +185,7 @@ public interface TableRow {
   
   /**
    * @param column ID number of the target column
+     * @return 
    */
   public int getColumnType(int column);
   
@@ -193,6 +209,14 @@ public interface TableRow {
    */
   public String[] getColumnTitles();
 
-  public void write(PrintWriter writer);
-  public void print();
+    /**
+     *
+     * @param writer
+     */
+    public void write(PrintWriter writer);
+
+    /**
+     *
+     */
+    public void print();
 }

data/src/main/java/processing/data/XML.java

@@ -84,10 +84,14 @@ public class XML implements Serializable {
 
 
   /**
-   * Advanced users only; use loadXML() in PApplet. This is not a supported
-   * function and is subject to change. It is available simply for users that
-   * would like to handle the exceptions in a particular way.
+   * Advanced users only; use loadXML() in PApplet.This is not a supported
+ function and is subject to change.It is available simply for users that
+ would like to handle the exceptions in a particular way.
    *
+     * @param file
+     * @throws java.io.IOException
+     * @throws javax.xml.parsers.ParserConfigurationException
+     * @throws org.xml.sax.SAXException
    * @nowebref
    */
   public XML(File file) throws IOException, ParserConfigurationException, SAXException {
@@ -98,6 +102,11 @@ public class XML implements Serializable {
   /**
    * Advanced users only; use loadXML() in PApplet.
    *
+     * @param file
+     * @param options
+     * @throws java.io.IOException
+     * @throws javax.xml.parsers.ParserConfigurationException
+     * @throws org.xml.sax.SAXException
    * @nowebref
    */
   public XML(File file, String options) throws IOException, ParserConfigurationException, SAXException {
@@ -105,6 +114,10 @@ public class XML implements Serializable {
   }
 
   /**
+     * @param input
+     * @throws java.io.IOException
+     * @throws javax.xml.parsers.ParserConfigurationException
+     * @throws org.xml.sax.SAXException
    * @nowebref
    */
   public XML(InputStream input) throws IOException, ParserConfigurationException, SAXException {
@@ -116,6 +129,11 @@ public class XML implements Serializable {
    * Unlike the loadXML() method in PApplet, this version works with files
    * that are not in UTF-8 format.
    *
+     * @param input
+     * @param options
+     * @throws java.io.IOException
+     * @throws javax.xml.parsers.ParserConfigurationException
+     * @throws org.xml.sax.SAXException
    * @nowebref
    */
   public XML(InputStream input, String options) throws IOException, ParserConfigurationException, SAXException {
@@ -139,6 +157,10 @@ public class XML implements Serializable {
   /**
    * Advanced users only; use loadXML() in PApplet.
    *
+     * @param reader
+     * @throws java.io.IOException
+     * @throws javax.xml.parsers.ParserConfigurationException
+     * @throws org.xml.sax.SAXException
    * @nowebref
    */
   public XML(Reader reader) throws IOException, ParserConfigurationException, SAXException {
@@ -147,14 +169,17 @@ public class XML implements Serializable {
 
 
   /**
-   * Advanced users only; use loadXML() in PApplet.Added extra code to handle 
 (Unicode NLF), which is sometimes
+   * Advanced users only; use loadXML() in PApplet.Added extra code to handle 
 (Unicode NLF), which is sometimes
+ inserted by web browsers (Safari?) and not distinguishable from a "real"
+ LF (or CRLF) in some text editors (i.e.TextEdit on OS X).Only doing
+ this for XML (and not all Reader objects) because LFs are essential.https://github.com/processing/processing/issues/2100
    *
-   * Added extra code to handle \u2028 (Unicode NLF), which is sometimes
-   * inserted by web browsers (Safari?) and not distinguishable from a "real"
-   * LF (or CRLF) in some text editors (i.e. TextEdit on OS X). Only doing
-   * this for XML (and not all Reader objects) because LFs are essential.
-   * https://github.com/processing/processing/issues/2100
    *
+     * @param reader
+     * @param options
+     * @throws java.io.IOException
+     * @throws javax.xml.parsers.ParserConfigurationException
+     * @throws org.xml.sax.SAXException
    * @nowebref
    */
   public XML(final Reader reader, String options) throws IOException, ParserConfigurationException, SAXException {
@@ -226,6 +251,8 @@ public class XML implements Serializable {
   }
 
   /**
+     * @param parent
+     * @param node
    * @nowebref
    */
   protected XML(XML parent, Node node) {
@@ -261,6 +288,12 @@ public class XML implements Serializable {
   }
 
   /**
+     * @param data
+     * @param options
+     * @return 
+     * @throws java.io.IOException 
+     * @throws javax.xml.parsers.ParserConfigurationException 
+     * @throws org.xml.sax.SAXException 
    * @nowebref
    */
   static public XML parse(String data, String options) throws IOException, ParserConfigurationException, SAXException {
@@ -272,13 +305,24 @@ public class XML implements Serializable {
 //    return write(PApplet.createWriter(output));
 //  }
 
+    /**
+     *
+     * @param file
+     * @return
+     */
+
 
   public boolean save(File file) {
     return save(file, null);
   }
 
-
-  public boolean save(File file, String options) {
+    /**
+     *
+     * @param file
+     * @param options
+     * @return
+     */
+    public boolean save(File file, String options) {
     PrintWriter writer = PApplet.createWriter(file);
     boolean result = write(writer);
     writer.flush();
@@ -289,6 +333,12 @@ public class XML implements Serializable {
 
   // Sends this object and its kids to a Writer with an indent of 2 spaces,
   // including the declaration at the top so that the output will be valid XML.
+
+    /**
+     *
+     * @param output
+     * @return
+     */
   public boolean write(PrintWriter output) {
     output.print(format(2));
     output.flush();
@@ -297,9 +347,10 @@ public class XML implements Serializable {
 
 
   /**
-   * Returns the parent element. This method returns null for the root
-   * element.
+   * Returns the parent element.This method returns null for the root
+ element.
    *
+     * @return 
    * @webref xml:method
    * @brief Gets a copy of the element's parent
    */
@@ -309,6 +360,7 @@ public class XML implements Serializable {
 
   /**
    * Internal function; not included in reference.
+     * @return 
    */
   protected Object getNative() {
     return node;
@@ -329,6 +381,7 @@ public class XML implements Serializable {
   }
 
   /**
+     * @param newName
    * @webref xml:method
    * @brief Sets the element's name
    */
@@ -340,9 +393,9 @@ public class XML implements Serializable {
 
 
   /**
-   * Returns the name of the element (without namespace prefix).
+   * Returns the name of the element (without namespace prefix).Internal function; not included in reference.
    *
-   * Internal function; not included in reference.
+     * @return
    */
   public String getLocalName() {
     return node.getLocalName();
@@ -382,6 +435,7 @@ public class XML implements Serializable {
   /**
    * Returns a boolean of whether or not there are children.
    *
+     * @return 
    * @webref xml:method
    * @brief Checks whether or not an element has any children
    */
@@ -392,9 +446,10 @@ public class XML implements Serializable {
 
 
   /**
-   * Put the names of all children into an array. Same as looping through
-   * each child and calling getName() on each XMLElement.
+   * Put the names of all children into an array.Same as looping through
+ each child and calling getName() on each XMLElement.
    *
+     * @return 
    * @webref xml:method
    * @brief Returns the names of all children as an array
    */
@@ -420,6 +475,7 @@ public class XML implements Serializable {
   /**
    * Returns an array containing all the child elements.
    *
+     * @return 
    * @webref xml:method
    * @brief Returns an array containing all child elements
    */
@@ -440,6 +496,8 @@ public class XML implements Serializable {
   /**
    * Quick accessor for an element at a particular index.
    *
+     * @param index
+     * @return 
    * @webref xml:method
    * @brief Returns the child element with the specified index value or path
    */
@@ -541,8 +599,13 @@ public class XML implements Serializable {
     return (XML[]) PApplet.subset(matches, 0, matchCount);
   }
 
-
-  protected XML[] getChildrenRecursive(String[] items, int offset) {
+    /**
+     *
+     * @param items
+     * @param offset
+     * @return
+     */
+    protected XML[] getChildrenRecursive(String[] items, int offset) {
     if (offset == items.length-1) {
       return getChildren(items[offset]);
     }
@@ -557,6 +620,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param tag
+     * @return 
    * @webref xml:method
    * @brief Appends a new child to the element
    */
@@ -566,15 +631,21 @@ public class XML implements Serializable {
     return appendChild(newChild);
   }
 
-
-  public XML addChild(XML child) {
+    /**
+     *
+     * @param child
+     * @return
+     */
+    public XML addChild(XML child) {
     Document document = node.getOwnerDocument();
     Node newChild = document.importNode((Node) child.getNative(), true);
     return appendChild(newChild);
   }
 
 
-  /** Internal handler to add the node structure. */
+  /** Internal handler to add the node structure.
+     * @param newNode
+     * @return  */
   protected XML appendChild(Node newNode) {
     node.appendChild(newNode);
     XML newbie = new XML(this, newNode);
@@ -586,6 +657,7 @@ public class XML implements Serializable {
 
 
   /**
+     * @param kid
    * @webref xml:method
    * @brief Removes the specified child
    */
@@ -594,8 +666,10 @@ public class XML implements Serializable {
     children = null;  // TODO not efficient
   }
 
-
-  public void trim() {
+    /**
+     *
+     */
+    public void trim() {
     try {
       XPathFactory xpathFactory = XPathFactory.newInstance();
       XPathExpression xpathExp =
@@ -666,6 +740,7 @@ public class XML implements Serializable {
   /**
    * Returns the number of attributes.
    *
+     * @return 
    * @webref xml:method
    * @brief Counts the specified element's number of attributes
    */
@@ -677,6 +752,7 @@ public class XML implements Serializable {
   /**
    * Get a list of the names for all of the attributes for this node.
    *
+     * @return 
    * @webref xml:method
    * @brief Returns a list of names of all attributes as an array
    */
@@ -692,6 +768,8 @@ public class XML implements Serializable {
   /**
    * Returns whether an attribute exists.
    *
+     * @param name
+     * @return 
    * @webref xml:method
    * @brief Checks whether or not an element has the specified attribute
    */
@@ -725,6 +803,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param name
+     * @return 
    * @webref xml:method
    * @brief Gets the content of an attribute as a String
    */
@@ -732,8 +812,13 @@ public class XML implements Serializable {
     return getString(name, null);
   }
 
-
-  public String getString(String name, String defaultValue) {
+    /**
+     *
+     * @param name
+     * @param defaultValue
+     * @return
+     */
+    public String getString(String name, String defaultValue) {
     NamedNodeMap attrs = node.getAttributes();
     if (attrs != null) {
       Node attr = attrs.getNamedItem(name);
@@ -746,6 +831,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param name
+     * @param value
    * @webref xml:method
    * @brief Sets the content of an attribute as a String
    */
@@ -755,6 +842,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param name
+     * @return 
    * @webref xml:method
    * @brief Gets the content of an attribute as an int
    */
@@ -764,6 +853,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param name
+     * @param value
    * @webref xml:method
    * @brief Sets the content of an attribute as an int
    */
@@ -786,6 +877,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param name
+     * @param value
    * @webref xml:method
    * @brief Sets the content of an element as an int
    */
@@ -810,6 +903,8 @@ public class XML implements Serializable {
   /**
    * Returns the value of an attribute, or zero if not present.
    *
+     * @param name
+     * @return 
    * @webref xml:method
    * @brief Gets the content of an attribute as a float
    */
@@ -832,6 +927,8 @@ public class XML implements Serializable {
 
 
   /**
+     * @param name
+     * @param value
    * @webref xml:method
    * @brief Sets the content of an attribute as a float
    */
@@ -839,8 +936,12 @@ public class XML implements Serializable {
     setString(name, String.valueOf(value));
   }
 
-
-  public double getDouble(String name) {
+    /**
+     *
+     * @param name
+     * @return
+     */
+    public double getDouble(String name) {
     return getDouble(name, 0);
   }
 
@@ -857,8 +958,12 @@ public class XML implements Serializable {
     return (value == null) ? defaultValue : Double.parseDouble(value);
   }
 
-
-  public void setDouble(String name, double value) {
+    /**
+     *
+     * @param name
+     * @param value
+     */
+    public void setDouble(String name, double value) {
     setString(name, String.valueOf(value));
   }
 
@@ -879,8 +984,12 @@ public class XML implements Serializable {
     return node.getTextContent();
   }
 
-
-  public String getContent(String defaultValue) {
+    /**
+     *
+     * @param defaultValue
+     * @return
+     */
+    public String getContent(String defaultValue) {
     String s = node.getTextContent();
     return (s != null) ? s : defaultValue;
   }
@@ -900,6 +1009,7 @@ public class XML implements Serializable {
 
   /**
    * @param defaultValue the default value of the attribute
+     * @return 
    */
   public int getIntContent(int defaultValue) {
     return PApplet.parseInt(node.getTextContent(), defaultValue);
@@ -920,18 +1030,26 @@ public class XML implements Serializable {
 
   /**
    * @param defaultValue the default value of the attribute
+     * @return 
    */
   public float getFloatContent(float defaultValue) {
     return PApplet.parseFloat(node.getTextContent(), defaultValue);
   }
 
-
-  public long getLongContent() {
+    /**
+     *
+     * @return
+     */
+    public long getLongContent() {
     return getLongContent(0);
   }
 
-
-  public long getLongContent(long defaultValue) {
+    /**
+     *
+     * @param defaultValue
+     * @return
+     */
+    public long getLongContent(long defaultValue) {
     String c = node.getTextContent();
     if (c != null) {
       try {
@@ -941,13 +1059,20 @@ public class XML implements Serializable {
     return defaultValue;
   }
 
-
-  public double getDoubleContent() {
+    /**
+     *
+     * @return
+     */
+    public double getDoubleContent() {
     return getDoubleContent(0);
   }
 
-
-  public double getDoubleContent(double defaultValue) {
+    /**
+     *
+     * @param defaultValue
+     * @return
+     */
+    public double getDoubleContent(double defaultValue) {
     String c = node.getTextContent();
     if (c != null) {
       try {
@@ -959,6 +1084,7 @@ public class XML implements Serializable {
 
 
   /**
+     * @param text
    * @webref xml:method
    * @brief Sets the content of an element
    */
@@ -966,23 +1092,35 @@ public class XML implements Serializable {
     node.setTextContent(text);
   }
 
-
-  public void setIntContent(int value) {
+    /**
+     *
+     * @param value
+     */
+    public void setIntContent(int value) {
     setContent(String.valueOf(value));
   }
 
-
-  public void setFloatContent(float value) {
+    /**
+     *
+     * @param value
+     */
+    public void setFloatContent(float value) {
     setContent(String.valueOf(value));
   }
 
-
-  public void setLongContent(long value) {
+    /**
+     *
+     * @param value
+     */
+    public void setLongContent(long value) {
     setContent(String.valueOf(value));
   }
 
-
-  public void setDoubleContent(double value) {
+    /**
+     *
+     * @param value
+     */
+    public void setDoubleContent(double value) {
     setContent(String.valueOf(value));
   }
 
@@ -1125,8 +1263,10 @@ public class XML implements Serializable {
     return null;
   }
 
-
-  public void print() {
+    /**
+     *
+     */
+    public void print() {
     PApplet.println(format(2));
   }