Javadoc

Author: garydgregory

src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java

@@ -897,7 +897,7 @@ public static SCXML read(final URL scxmlURL, final Configuration configuration)
     }
 
     /**
-     * Read the contents of this <assign> element.
+     * Reads the contents of this <assign> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -960,7 +960,7 @@ private static String readAV(final XMLStreamReader reader, final String attrLoca
     }
 
     /**
-     * Read the following body contents into a String.
+     * Reads the following body contents into a String.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @return The body content read into a String.
@@ -1018,7 +1018,7 @@ private static Boolean readBooleanAV(final XMLStreamReader reader, final String
     }
 
     /**
-     * Read the contents of this <cancel> element.
+     * Reads the contents of this <cancel> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1051,7 +1051,7 @@ private static void readCancel(final XMLStreamReader reader, final Configuration
     }
 
     /**
-     * Read the contents of this <content> element.
+     * Reads the contents of this <content> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1074,7 +1074,7 @@ private static void readContent(final XMLStreamReader reader, final Configuratio
     }
 
     /**
-     * Read the contents of this custom action.
+     * Reads the contents of this custom action.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1169,7 +1169,7 @@ private static void readCustomAction(final XMLStreamReader reader, final Configu
     }
 
     /**
-     * Read the contents of this <data> element.
+     * Reads the contents of this <data> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1200,7 +1200,7 @@ private static void readData(final XMLStreamReader reader, final Configuration c
     }
 
     /**
-     * Read the contents of this <datamodel> element.
+     * Reads the contents of this <datamodel> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1245,7 +1245,7 @@ private static void readDatamodel(final XMLStreamReader reader, final Configurat
      * Private utility functions for reading the SCXML document.
      */
     /**
-     * Read the SCXML document through the {@link XMLStreamReader}.
+     * Reads the SCXML document through the {@link XMLStreamReader}.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1284,7 +1284,7 @@ private static SCXML readDocument(final XMLStreamReader reader, final Configurat
     }
 
     /**
-     * Read the contents of this <donedata> element.
+     * Reads the contents of this <donedata> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1331,7 +1331,7 @@ private static void readDoneData(final XMLStreamReader reader, final Configurati
     }
 
     /**
-     * Read the current element into a DOM {@link Element}.
+     * Reads the current element into a DOM {@link Element}.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @return The parsed content as a DOM {@link Element}.
@@ -1414,7 +1414,7 @@ private static Element readElement(final XMLStreamReader reader)
     }
 
     /**
-     * Read the contents of this <else> element.
+     * Reads the contents of this <else> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param executable The parent {@link Executable} for this action.
@@ -1431,7 +1431,7 @@ private static void readElse(final XMLStreamReader reader, final Executable exec
     }
 
     /**
-     * Read the contents of this <elseif> element.
+     * Reads the contents of this <elseif> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param executable The parent {@link Executable} for this action.
@@ -1449,7 +1449,7 @@ private static void readElseIf(final XMLStreamReader reader, final Executable ex
     }
 
     /**
-     * Read this set of executable content elements.
+     * Reads this set of executable content elements.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1557,7 +1557,7 @@ private static void readExecutableContext(final XMLStreamReader reader, final Co
     }
 
     /**
-     * Read the contents of this <final> element.
+     * Reads the contents of this <final> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1614,7 +1614,7 @@ private static void readFinal(final XMLStreamReader reader, final Configuration
     }
 
     /**
-     * Read the contents of this <finalize> element.
+     * Reads the contents of this <finalize> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1635,7 +1635,7 @@ private static void readFinalize(final XMLStreamReader reader, final Configurati
     }
 
     /**
-     * Read the contents of this <foreach> element.
+     * Reads the contents of this <foreach> element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1663,7 +1663,7 @@ private static void readForeach(final XMLStreamReader reader, final Configuratio
     }
 
     /**
-     * Read the contents of the initial <script> element.
+     * Reads the contents of the initial <script> element.
      * @see <a href="https://www.w3.org/TR/2015/REC-scxml-20150901/#scxml">
      *     https://www.w3.org/TR/2015/REC-scxml-20150901/#scxml<a> section 3.2.2
      *
@@ -1682,7 +1682,7 @@ private static void readGlobalScript(final XMLStreamReader reader, final Configu
     }
 
     /**
-     * Read the contents of this &lt;history&gt; element.
+     * Reads the contents of this &lt;history&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1723,7 +1723,7 @@ private static void readHistory(final XMLStreamReader reader, final Configuratio
     }
 
     /**
-     * Read the contents of this &lt;if&gt; element.
+     * Reads the contents of this &lt;if&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1767,7 +1767,7 @@ private static void readInExternalTargets(final SCXML parent, final EnterableSta
     }
 
     /**
-     * Read the contents of this &lt;initial&gt; element.
+     * Reads the contents of this &lt;initial&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1841,7 +1841,7 @@ private static SCXML readInternal(final Configuration configuration, final URL s
     }
 
     /**
-     * Read the contents of this &lt;invoke&gt; element.
+     * Reads the contents of this &lt;invoke&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1898,7 +1898,7 @@ private static void readInvoke(final XMLStreamReader reader, final Configuration
     }
 
     /**
-     * Read the contents of this &lt;log&gt; element.
+     * Reads the contents of this &lt;log&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param executable The parent {@link Executable} for this action.
@@ -1921,7 +1921,7 @@ private static void readLog(final XMLStreamReader reader, final Executable execu
     }
 
     /**
-     * Read the current active namespace declarations.
+     * Reads the current active namespace declarations.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @return the map of active namespace declarations, null if none defined
@@ -1938,7 +1938,7 @@ private static Map<String, String> readNamespaces(final XMLStreamReader reader)
     }
 
     /**
-     * Read the contents of this &lt;onentry&gt; element.
+     * Reads the contents of this &lt;onentry&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1958,7 +1958,7 @@ private static void readOnEntry(final XMLStreamReader reader, final Configuratio
     }
 
     /**
-     * Read the contents of this &lt;onexit&gt; element.
+     * Reads the contents of this &lt;onexit&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -1993,7 +1993,7 @@ else if (id.startsWith(SCXML.GENERATED_TT_ID_PREFIX)) {
     }
 
     /**
-     * Read the contents of this &lt;parallel&gt; element.
+     * Reads the contents of this &lt;parallel&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2085,7 +2085,7 @@ private static void readParallel(final XMLStreamReader reader, final Configurati
     }
 
     /**
-     * Read the contents of this &lt;param&gt; element.
+     * Reads the contents of this &lt;param&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2120,7 +2120,7 @@ else if (location == null) {
     }
 
     /**
-     * Read and parse the body of a {@link ParsedValueContainer} element.
+     * Reads and parse the body of a {@link ParsedValueContainer} element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2188,7 +2188,7 @@ else if (children.getLength() == 1 && (cdata || child.getNodeType() == Node.TEXT
     }
 
     /**
-     * Read the contents of this &lt;raise&gt; element.
+     * Reads the contents of this &lt;raise&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2240,7 +2240,7 @@ private static String readRequiredAV(final XMLStreamReader reader, final String
     }
 
     /**
-     * Read the contents of this &lt;script&gt; element.
+     * Reads the contents of this &lt;script&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2271,7 +2271,7 @@ private static Script readScript(final XMLStreamReader reader, final Configurati
     }
 
     /**
-     * Read the contents of this &lt;script&gt; element.
+     * Reads the contents of this &lt;script&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2293,7 +2293,7 @@ private static void readScript(final XMLStreamReader reader, final Configuration
     }
 
     /**
-     * Read the contents of this &lt;scxml&gt; element.
+     * Reads the contents of this &lt;scxml&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2370,7 +2370,7 @@ private static void readSCXML(final XMLStreamReader reader, final Configuration
     }
 
     /**
-     * Read the contents of this &lt;send&gt; element.
+     * Reads the contents of this &lt;send&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2485,7 +2485,7 @@ private static void readSend(final XMLStreamReader reader, final Configuration c
     }
 
     /**
-     * Read the contents of this simple &lt;transition&gt; element.
+     * Reads the contents of this simple &lt;transition&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2516,7 +2516,7 @@ private static SimpleTransition readSimpleTransition(final XMLStreamReader reade
     }
 
     /**
-     * Read the contents of this &lt;state&gt; element.
+     * Reads the contents of this &lt;state&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.
@@ -2618,7 +2618,7 @@ private static void readState(final XMLStreamReader reader, final Configuration
     }
 
     /**
-     * Read the contents of this &lt;transition&gt; element.
+     * Reads the contents of this &lt;transition&gt; element.
      *
      * @param reader The {@link XMLStreamReader} providing the SCXML document to parse.
      * @param configuration The {@link Configuration} to use while parsing.