This is an automated email from the ASF dual-hosted git repository.
woonsan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-scxml.git
The following commit(s) were added to refs/heads/master by this push:
new 1794ff2 Fixing javadocs
1794ff2 is described below
commit 1794ff22a628a082bf33d9f0805095bedab759e2
Author: Woonsan Ko <woon...@apache.org>
AuthorDate: Fri Feb 1 11:02:50 2019 -0500
Fixing javadocs
---
.../org/apache/commons/scxml2/SCInstanceObjectInputStream.java | 8 ++++----
.../java/org/apache/commons/scxml2/SCXMLExecutionContext.java | 3 ++-
src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java | 8 ++++++--
src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java | 2 +-
src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java | 2 +-
.../java/org/apache/commons/scxml2/env/javascript/JSContext.java | 1 -
.../org/apache/commons/scxml2/env/javascript/JSEvaluator.java | 3 ++-
src/main/java/org/apache/commons/scxml2/io/ContentParser.java | 8 ++++----
src/main/java/org/apache/commons/scxml2/model/Invoke.java | 1 +
src/main/java/org/apache/commons/scxml2/model/ParsedValue.java | 1 -
src/main/java/org/apache/commons/scxml2/model/Var.java | 1 -
11 files changed, 21 insertions(+), 17 deletions(-)
diff --git
a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
index 3c0659c..72ce5d8 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
@@ -37,8 +37,8 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
* Callback method invoked from {@link
SCInstanceObjectInputStream#resolveClass(ObjectStreamClass)}
* @param osc an instance of class ObjectStreamClass
* @return a Class object corresponding to osc
- * @throws IOException
- * @throws ClassNotFoundException
+ * @throws IOException if an I/O error occurs while reading the
instance of class ObjectStreamClass
+ * @throws ClassNotFoundException if the class is not found while
reading the the instance of class ObjectStreamClass
*/
Class resolveClass(ObjectStreamClass osc) throws IOException,
ClassNotFoundException;
}
@@ -51,7 +51,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
/**
* Default constructor
* @param in Inputstream to use
- * @throws IOException
+ * @throws IOException if an I/O error occurs while reading the stream
*/
public SCInstanceObjectInputStream(final InputStream in) throws
IOException {
super(in);
@@ -77,9 +77,9 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
* }
* }
* </code></pre>
- * </p>
* @see
org.apache.commons.scxml2.env.groovy.GroovyContext#readObject(ObjectInputStream)
* @param classResolver custom class resolver
+ * @return the old classResolver replaced by the new {@code classResolver}
*/
public ClassResolver setClassResolver(ClassResolver classResolver) {
ClassResolver old = this.classResolver;
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index 6f827f1..171ebf8 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -196,7 +196,8 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Initialize will cancel all current active Invokers, clear the internal
event queue and (re)initialize the state machine
- * @throws ModelException
+ * @param data input model map to initialize the data model with
+ * @throws ModelException if the state machine hasn't been setup for the
internal SCXML instance
*/
public void initialize(final Map<String, Object> data) throws
ModelException {
if (!invokeIds.isEmpty()) {
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
index 4f669dd..411b12b 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
@@ -111,6 +111,9 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* Constructor using a parent SCXMLExecutor
*
* @param parentSCXMLExecutor the parent SCXMLExecutor
+ * @param invokeId SCXML invoke id
+ * @param scxml {@link SCXML} instance
+ * @throws ModelException if the internal {@link SCInstance} is already
initialized
*/
public SCXMLExecutor(final SCXMLExecutor parentSCXMLExecutor, final String
invokeId, final SCXML scxml) throws ModelException {
this.parentSCXMLIOProcessor = new
ParentSCXMLIOProcessor(parentSCXMLExecutor, invokeId);
@@ -138,7 +141,8 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * @return the (optionally) <final><donedata/></final> produced data after
the current statemachine completed its execution.
+ * @return the (optionally) <final><donedata/></final>
produced data after the current statemachine
+ * completed its execution.
*/
public Object getFinalDoneData() {
return
getGlobalContext().getSystemContext().getPlatformVariables().get(SCXMLSystemContext.FINAL_DONE_DATA_KEY);
@@ -423,7 +427,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Clear all state, optionally initialize/override global context data,
and begin executing the state machine
- * @data optional data to initialize/override data defined (only) in the
global context of the state machine
+ * @param data optional data to initialize/override data defined (only) in
the global context of the state machine
* @throws ModelException if the state machine instance failed to
initialize
*/
public void go(final Map<String, Object> data) throws ModelException {
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
index 15c254d..10f4702 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
@@ -86,7 +86,7 @@ public interface SCXMLSemantics {
* @param data A data map to initialize/override <data> elements in
the root (global) <datamodel> with
* ids matching the keys in the map (other data map entries
will be ignored)
* @param exctx The execution context to initialize
- * @throws ModelException
+ * @throws ModelException if the state machine hasn't been setup for the
internal SCXML instance
*/
void initialize(final SCXMLExecutionContext exctx, final Map<String,
Object> data) throws ModelException;
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
index e865d9f..0d39dd0 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
@@ -52,7 +52,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
public static final String STATUS_KEY = "status";
/** The Commons SCXML internal {@link #getPlatformVariables() platform
variable key} holding the (optionally)
- * <final><donedata/></final> produced data after the current SCXML
completed its execution.
+ * <final><donedata/></final> produced data after the
current SCXML completed its execution.
* **/
public static final String FINAL_DONE_DATA_KEY = "finalDoneData";
diff --git
a/src/main/java/org/apache/commons/scxml2/env/javascript/JSContext.java
b/src/main/java/org/apache/commons/scxml2/env/javascript/JSContext.java
index f1b063c..eecb9bc 100644
--- a/src/main/java/org/apache/commons/scxml2/env/javascript/JSContext.java
+++ b/src/main/java/org/apache/commons/scxml2/env/javascript/JSContext.java
@@ -26,7 +26,6 @@ import org.apache.commons.scxml2.env.SimpleContext;
* SCXML Context for use by the JSEvaluator. It is simply a 'no functionality'
* extension of SimpleContext that has been implemented to reduce the impact
* if the JSEvaluator requires additional functionality at a later stage.
- * <p>
*/
public class JSContext extends SimpleContext {
diff --git
a/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
index b5b32fa..265e473 100644
--- a/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
@@ -141,6 +141,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* as needed for the <code>init_global.js</code> script in the global
context.
* This variable is bound to the ENGINE_SCOPE to ensure it cannot be
'shadowed' by an overriding variable assignment.
* </p>
+ * <p>
* The provided SCXML Context variables are bound via the GLOBAL_SCOPE
using a {@link JSBindings} wrapper for each
* invocation.
* </p>
@@ -296,7 +297,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* @param ctx SCXML context
* @param id context id of the data
* @param data data to inject
- * @throws SCXMLExpressionException
+ * @throws SCXMLExpressionException if a malformed expression is
encountered
*/
public void injectData(final Context ctx, final String id, final Object
data) throws SCXMLExpressionException {
ctx.setLocal(id, data);
diff --git a/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
b/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
index 800d082..099cb7f 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
@@ -157,7 +157,7 @@ public class ContentParser {
}
/**
- * Parse and map JSON string to 'raw' Java Objects: object ->
LinkedHashMap, array -> ArrayList
+ * Parse and map JSON string to 'raw' Java Objects: object ->
LinkedHashMap, array -> ArrayList
* @param jsonString JSON string to parse
* @return 'raw' mapped Java Object for JSON string
* @throws IOException In case of parsing exceptions
@@ -170,7 +170,7 @@ public class ContentParser {
* Transforms a jsonObject to a json String
* @param jsonObject object to transform
* @return json string
- * @throws IOException
+ * @throws IOException if IO error occurs while serializing it to JSON
*/
public String toJson(final Object jsonObject) throws IOException {
return jsonObjectMapper.writeValueAsString(jsonObject);
@@ -180,7 +180,7 @@ public class ContentParser {
* Parse an XML String and return the document element
* @param xmlString XML String to parse
* @return document element
- * @throws IOException
+ * @throws IOException if IO error occurs while parsing XML
*/
public Node parseXml(final String xmlString) throws IOException {
Document doc;
@@ -196,7 +196,7 @@ public class ContentParser {
* Transforms a XML Node to XML
* @param node node to transform
* @return XML string
- * @throws IOException
+ * @throws IOException if IO error occurs while serializing node to XML
*/
public String toXml(final Node node) throws IOException {
try {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
index fd8cef2..3d88577 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
@@ -346,6 +346,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Set the parent EnterableState.
* @param parent The parent state to set
+ * @param invokeIndex the invoke index in the parent (TransitionalState)
defined invokers
*/
public void setParentEnterableState(final EnterableState parent, final int
invokeIndex) {
if (parent == null) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
b/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
index 3db7fc0..ba502b5 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
@@ -32,7 +32,6 @@ import java.io.Serializable;
* For a <invoke> <content> body the special {@link NodeTextValue}
implementation is used,
* which stored the (only supported) embedded <scxml> document as plain
XML text for the <invoke>
* execution to parse (again) at runtime.
- * </p>
*/
public interface ParsedValue extends Serializable {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Var.java
b/src/main/java/org/apache/commons/scxml2/model/Var.java
index ee6ff71..d70b8e9 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Var.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Var.java
@@ -37,7 +37,6 @@ import org.apache.commons.scxml2.io.SCXMLWriter;
* can be useful) before adding it to the object model</li>
* </ul>
* before write the SCXML model with {@link SCXMLWriter}. The writing will
fail otherwise!
- * </p>
*/
public class Var extends Action {
