This is an automated email from the ASF dual-hosted git repository.
ggregory 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 0647cd18 Javadoc: Empty Javadoc line before the 1st tag.
0647cd18 is described below
commit 0647cd18bce6412d0633034cc5fdec63f422a578
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Dec 31 18:05:40 2025 -0500
Javadoc: Empty Javadoc line before the 1st tag.
---
.../org/apache/commons/scxml2/ActionExecutionContext.java | 1 +
src/main/java/org/apache/commons/scxml2/Evaluator.java | 2 ++
.../java/org/apache/commons/scxml2/EvaluatorFactory.java | 1 +
.../java/org/apache/commons/scxml2/EvaluatorProvider.java | 1 +
src/main/java/org/apache/commons/scxml2/EventDispatcher.java | 1 +
.../org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java | 1 +
src/main/java/org/apache/commons/scxml2/SCInstance.java | 8 ++++++++
.../apache/commons/scxml2/SCInstanceObjectInputStream.java | 3 +++
.../org/apache/commons/scxml2/SCXMLExecutionContext.java | 9 +++++++++
src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java | 11 +++++++++++
src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java | 5 +++++
.../java/org/apache/commons/scxml2/SCXMLSystemContext.java | 3 +++
.../java/org/apache/commons/scxml2/StateConfiguration.java | 2 ++
src/main/java/org/apache/commons/scxml2/TriggerEvent.java | 3 +++
.../org/apache/commons/scxml2/env/AbstractBaseEvaluator.java | 1 +
.../org/apache/commons/scxml2/env/EffectiveContextMap.java | 2 ++
src/main/java/org/apache/commons/scxml2/env/URLResolver.java | 1 +
.../apache/commons/scxml2/env/groovy/GroovySCXMLScript.java | 1 +
.../org/apache/commons/scxml2/env/javascript/JSBindings.java | 3 +++
.../org/apache/commons/scxml2/env/javascript/JSContext.java | 2 ++
.../apache/commons/scxml2/env/javascript/JSEvaluator.java | 6 ++++++
.../java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java | 2 ++
.../java/org/apache/commons/scxml2/env/jexl/JexlContext.java | 1 +
.../org/apache/commons/scxml2/env/jexl/JexlEvaluator.java | 2 ++
src/main/java/org/apache/commons/scxml2/invoke/Invoker.java | 1 +
.../java/org/apache/commons/scxml2/io/ContentParser.java | 12 ++++++++++++
src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java | 2 ++
src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java | 6 ++++++
src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java | 1 +
.../apache/commons/scxml2/model/ActionExecutionError.java | 1 +
.../org/apache/commons/scxml2/model/ContentContainer.java | 1 +
.../org/apache/commons/scxml2/model/CustomActionWrapper.java | 3 +++
.../java/org/apache/commons/scxml2/model/EnterableState.java | 2 ++
src/main/java/org/apache/commons/scxml2/model/Final.java | 2 ++
src/main/java/org/apache/commons/scxml2/model/Invoke.java | 6 ++++++
src/main/java/org/apache/commons/scxml2/model/OnEntry.java | 1 +
src/main/java/org/apache/commons/scxml2/model/OnExit.java | 1 +
src/main/java/org/apache/commons/scxml2/model/Parallel.java | 2 ++
.../java/org/apache/commons/scxml2/model/PayloadBuilder.java | 3 +++
src/main/java/org/apache/commons/scxml2/model/SCXML.java | 4 ++++
.../org/apache/commons/scxml2/model/SimpleTransition.java | 6 ++++++
src/main/java/org/apache/commons/scxml2/model/State.java | 2 ++
.../java/org/apache/commons/scxml2/model/Transition.java | 1 +
.../org/apache/commons/scxml2/model/TransitionTarget.java | 4 ++++
.../java/org/apache/commons/scxml2/model/TransitionType.java | 1 +
.../org/apache/commons/scxml2/model/TransitionalState.java | 1 +
.../apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java | 10 ++++++++++
.../commons/scxml2/test/StandaloneJexlExpressions.java | 1 +
48 files changed, 146 insertions(+)
diff --git
a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
index 18389cf4..b9d9dbcc 100644
--- a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
@@ -33,6 +33,7 @@ public class ActionExecutionContext {
/**
* Constructs a new instance.
+ *
* @param exctx The SCXML execution context this action execution context
belongs to
*/
public ActionExecutionContext(final SCXMLExecutionContext exctx) {
diff --git a/src/main/java/org/apache/commons/scxml2/Evaluator.java
b/src/main/java/org/apache/commons/scxml2/Evaluator.java
index 29f8a837..97247b5b 100644
--- a/src/main/java/org/apache/commons/scxml2/Evaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/Evaluator.java
@@ -86,6 +86,7 @@ public interface Evaluator {
/**
* Gets the datamodel type supported by this Evaluator
+ *
* @return The supported datamodel type
*/
String getSupportedDatamodel();
@@ -100,6 +101,7 @@ public interface Evaluator {
/**
* If this Evaluator only supports a global context.
+ *
* @return true if this Evaluator only support a global context
*/
boolean requiresGlobalContext();
diff --git a/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
b/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
index 6adba816..eee2d413 100644
--- a/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
+++ b/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
@@ -65,6 +65,7 @@ public class EvaluatorFactory {
/**
* Returns a dedicated Evaluator instance for a specific SCXML document
its documentmodel.
* <p>If no SCXML document is provided a default Evaluator will be
returned.</p>
+ *
* @param document The document to return a dedicated Evaluator for. May
be null to retrieve the default Evaluator.
* @return a new and not sharable Evaluator instance for the provided
document, or a default Evaluator otherwise
* @throws ModelException If the SCXML document datamodel is not supported.
diff --git a/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
b/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
index 97115271..a984947f 100644
--- a/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
+++ b/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
@@ -34,6 +34,7 @@ public interface EvaluatorProvider {
* As the returned Evaluator <em>might</em> be optimized and dedicated for
the SCXML document instance, the
* Evaluator may not be shareable and reusable for other SCXML documents.
* </p>
+ *
* @param document the SCXML document
* @return a new and not sharable Evaluator instance
*/
diff --git a/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
b/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
index cc2a4824..ec894fc6 100644
--- a/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
+++ b/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
@@ -41,6 +41,7 @@ public interface EventDispatcher {
* To support easy setup and configuration of an invoked child
statemachine (see {@link Invoker})
* the EventDispatcher provides this newInstnace method to allow creating
a new instance without sharing its
* internal state.
+ *
* @return a new EventDispatcher instance for usage in an invoked child
statemachine.
*/
EventDispatcher newInstance();
diff --git
a/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java
b/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java
index 1938866c..d75e0f66 100644
--- a/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java
+++ b/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java
@@ -21,6 +21,7 @@ package org.apache.commons.scxml2;
* {@link #DEFAULT_EVENT_PROCESSOR} key <strong>and</strong> maintains a
{@link #getLocation() location} field
* <pre>
* <em>whose value holds an address that external entities can use to
communicate with this SCXML session using the SCXML Event I/O
Processor.</em></pre>
+ *
* @see <a href="https://www.w3.org/TR/scxml/#SCXMLEventProcessor";>SCXML
specification C.1.1 _ioprocessors Value</a>
*/
public class ExternalSCXMLIOProcessor implements SCXMLIOProcessor {
diff --git a/src/main/java/org/apache/commons/scxml2/SCInstance.java
b/src/main/java/org/apache/commons/scxml2/SCInstance.java
index fdde87ad..c53c19c3 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstance.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstance.java
@@ -132,6 +132,7 @@ public class SCInstance implements Serializable {
/**
* Constructs a new instance.
+ *
* @param internalIOProcessor The I/O Processor for the internal event
queue
* @param evaluator The evaluator
* @param errorReporter The error reporter
@@ -356,6 +357,7 @@ public class SCInstance implements Serializable {
/**
* (re)Initializes the state machine instance, clearing all variable
contexts, histories and current status,
* and clones the SCXML root datamodel into the root context.
+ *
* @throws ModelException if the state machine hasn't been setup for this
instance
*/
protected void initialize() throws ModelException {
@@ -457,6 +459,7 @@ public class SCInstance implements Serializable {
/**
* Sets or re-attach the error reporter
+ *
* @param errorReporter The error reporter for this state machine instance.
* @throws ModelException if an attempt is made to set a null value for
the error reporter
*/
@@ -473,6 +476,7 @@ public class SCInstance implements Serializable {
* If not re-attaching and this state machine instance has been
initialized before,
* it will be initialized again, destroying all existing state!
* </p>
+ *
* @param evaluator The evaluator for this state machine instance
* @param reAttach Flag whether or not re-attaching it
* @throws ModelException if {@code evaluator} is null
@@ -492,6 +496,7 @@ public class SCInstance implements Serializable {
/**
* Sets the I/O Processor for the internal event queue
+ *
* @param internalIOProcessor the I/O Processor
*/
protected void setInternalIOProcessor(final SCXMLIOProcessor
internalIOProcessor) {
@@ -511,6 +516,7 @@ public class SCInstance implements Serializable {
/**
* Sets or replace the root context.
+ *
* @param context The new root context.
*/
protected void setRootContext(final Context context) {
@@ -536,6 +542,7 @@ public class SCInstance implements Serializable {
* If this state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
* </p>
+ *
* @param stateMachine The state machine for this instance
* @throws ModelException if an attempt is made to set a null value for
the state machine
*/
@@ -549,6 +556,7 @@ public class SCInstance implements Serializable {
/**
* Starts the state machine, {@link #isRunning()} hereafter will return
true
+ *
* @throws IllegalStateException Exception thrown if trying to start the
state machine when in a Final state
*/
public void start() throws IllegalStateException {
diff --git
a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
index 6548ea17..44d1257b 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
@@ -35,6 +35,7 @@ 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 if an I/O error occurs while reading the
instance of class ObjectStreamClass
@@ -50,6 +51,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
/**
* Default constructor
+ *
* @param in Inputstream to use
* @throws IOException if an I/O error occurs while reading the stream
*/
@@ -85,6 +87,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
* }
* }
* </code></pre>
+ *
* @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}
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index 2d9fcc30..b8c2ad08 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -162,6 +162,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Add an event to the internal event queue
+ *
* @param event The event
*/
@Override
@@ -174,6 +175,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
* <p>
* Note: an already attached instance will get overwritten (and thus lost).
* </p>
+ *
* @param instance An previously detached SCInstance
*/
protected void attachInstance(final SCInstance instance) {
@@ -218,6 +220,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
* <p>
* {@link #attachInstance(SCInstance)} can be used to re-attach a
previously detached instance
* </p>
+ *
* @return the detached instance
*/
protected SCInstance detachInstance() {
@@ -326,6 +329,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Initialize will cancel all current active Invokers, clear the internal
event queue and (re)initialize the state machine
+ *
* @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
*/
@@ -432,6 +436,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Remove a previously active Invoker, which must already have been
canceled
+ *
* @param invoke The Invoke for the Invoker to remove
*/
public void removeInvoker(final Invoke invoke) {
@@ -442,6 +447,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Sets if the SCXML configuration should be checked before execution
(default = true)
+ *
* @param checkLegalConfiguration flag to set
*/
public void setCheckLegalConfiguration(final boolean
checkLegalConfiguration) {
@@ -469,6 +475,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
* If the state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
* </p>
+ *
* @param evaluator The evaluator to set
* @throws ModelException if attempting to set a null value or the state
machine instance failed to re-initialize
*/
@@ -494,6 +501,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
* If the state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
* </p>
+ *
* @param stateMachine The state machine to set
* @throws ModelException if attempting to set a null value or the state
machine instance failed to re-initialize
*/
@@ -527,6 +535,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Trivial utility method needed for SCXML IRP test 216 which (IMO
incorrectly uses http://www.w3.org/TR/scxml
* (no trailing /) while the SCXML spec explicitly states
http://www.w3.org/TR/scxml/ should be used (supported)
+ *
* @param uri
* @return
*/
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
index f82a0609..dd121455 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
@@ -129,6 +129,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* <p>
* No processing of the vent will be done, until the next triggerEvent
methods is invoked.
* </p>
+ *
* @param evt an external event
*/
@Override
@@ -153,6 +154,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* <p>
* Note: an already attached instance will get overwritten (and thus lost).
* </p>
+ *
* @param instance An previously detached SCInstance
*/
public void attachInstance(final SCInstance instance) {
@@ -169,6 +171,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* for {@link #addEvent(TriggerEvent)} which might still be used
(concurrently) by running Invokers, or
* {@link #hasPendingEvents()} to check for possible pending events.
* </p>
+ *
* @return the detached instance
*/
public SCInstance detachInstance() {
@@ -221,6 +224,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* The global context is the top level context within the state machine
itself and should be regarded and treated
* "read-only" from external usage.
* </p>
+ *
* @return Context The global context.
*/
public Context getGlobalContext() {
@@ -302,6 +306,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Clear all state, optionally initialize/override global context data,
and begin executing 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
*/
@@ -382,6 +387,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Same as {@link #go}
+ *
* @throws ModelException if the state machine instance failed to
initialize
*/
public void reset() throws ModelException {
@@ -408,6 +414,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Sets if the SCXML configuration should be checked before execution
(default = true)
+ *
* @param checkLegalConfiguration flag to set
*/
public void setCheckLegalConfiguration(final boolean
checkLegalConfiguration) {
@@ -420,6 +427,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* This will first (re)initialize the current state machine: clearing all
variable contexts, histories and current
* status, and clones the SCXML root datamodel into the root context.
* </p>
+ *
* @param atomicStateIds The set of atomic state ids for the state machine
* @throws ModelException when the state machine hasn't been properly
configured yet, when an unknown or illegal
* stateId is specified, or when the specified active configuration does
not represent a legal configuration.
@@ -467,6 +475,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* <p>
* Also the external event queue will be cleared.
* </p>
+ *
* @param evaluator The evaluator to set
* @throws ModelException if attempting to set a null value or the state
machine instance failed to re-initialize
*/
@@ -506,6 +515,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* <p>
* Also the external event queue will be cleared.
* </p>
+ *
* @param stateMachine The state machine to set
* @throws ModelException if attempting to set a null value or the state
machine instance failed to re-initialize
*/
@@ -531,6 +541,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Trigger all pending and incoming events, until there are no more
pending events
+ *
* @throws ModelException in case there is a fatal SCXML object model
problem.
*/
public void triggerEvents() 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 004072d4..32b99773 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
@@ -87,6 +87,7 @@ public interface SCXMLSemantics {
* <p>
* <em>NOTE: the current implementation does not yet provide final
donedata handling.</em>
* </p>
+ *
* @param exctx The execution context for this step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
@@ -110,6 +111,7 @@ public interface SCXMLSemantics {
* If the state machine no longer is running after all this, first the
{@link #finalStep(SCXMLExecutionContext)}
* should be called for cleanup before returning.
* </p>
+ *
* @param exctx The execution context for this step
* @throws ModelException if the state machine instance failed to
initialize or a SCXML model error occurred during
* the execution.
@@ -119,6 +121,7 @@ public interface SCXMLSemantics {
/**
* Initialize the SCXML state machine, optionally initializing
(overriding) root <datamodel><data> elements
* with external values provided through a data map.
+ *
* @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
@@ -139,6 +142,7 @@ public interface SCXMLSemantics {
* This method is also first invoked when manually initializing the status
of a state machine through
* {@link SCXMLExecutor#setConfiguration(java.util.Set)}.
* </p>
+ *
* @param states a set of states
* @param errRep ErrorReporter to report detailed error info if needed
* @return true if a given state configuration is legal, false otherwise
@@ -166,6 +170,7 @@ public interface SCXMLSemantics {
* If the state machine no longer is running after all this, first the
{@link #finalStep(SCXMLExecutionContext)}
* should be called for cleanup before returning.
* </p>
+ *
* @param exctx The execution context for this step
* @param event The event to process
* @throws ModelException if a SCXML model error occurred during the
execution.
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
index 7d01c258..1594e28f 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
@@ -39,6 +39,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
/**
* The protected system variables names as defined in the SCXML
specification
+ *
* @see <a
href="https://www.w3.org/TR/scxml/#SystemVariables";>http://www.w3.org/TR/scxml/#SystemVariables</a>
*/
public static final String EVENT_KEY = "_event";
@@ -70,6 +71,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
/**
* The auto-generated next sessionId prefixed ID
+ *
* @see #generateSessionId()
*/
private long nextSessionSequenceId;
@@ -153,6 +155,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
/**
* Initialize or replace systemContext
+ *
* @param systemContext the system context to set
* @throws NullPointerException if systemContext == null
*/
diff --git a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
index c77b735f..41b3d0e8 100644
--- a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
+++ b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
@@ -55,6 +55,7 @@ public class StateConfiguration implements Serializable {
/**
* Enter an active state
* If the state is atomic also record it add it to the current states
+ *
* @param state state to enter
*/
public void enterState(final EnterableState state) {
@@ -69,6 +70,7 @@ public class StateConfiguration implements Serializable {
/**
* Exit an active state
* If the state is atomic also remove it from current states
+ *
* @param state state to exit
*/
public void exitState(final EnterableState state) {
diff --git a/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
b/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
index a6b53d06..d74c95a5 100644
--- a/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
+++ b/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
@@ -67,6 +67,7 @@ public class TriggerEvent implements Serializable {
* Indicates that an error internal to the execution of the document has
occurred, such as one arising from
* expression evaluation.
* </p>
+ *
* @see <a href="https://www.w3.org/TR/scxml/#errorsAndEvents";>
* http://www.w3.org/TR/scxml/#errorsAndEvents</a>
*/
@@ -77,6 +78,7 @@ public class TriggerEvent implements Serializable {
* <p>
* Indicates that an error has occurred while trying to communicate with
an external entity.
* </p>
+ *
* @see <a href="https://www.w3.org/TR/scxml/#errorsAndEvents";>
* http://www.w3.org/TR/scxml/#errorsAndEvents</a>
*/
@@ -87,6 +89,7 @@ public class TriggerEvent implements Serializable {
* <p>
* Indicates that a platform- or application-specific error has occurred.
* </p>
+ *
* @see <a href="https://www.w3.org/TR/scxml/#errorsAndEvents";>
* http://www.w3.org/TR/scxml/#errorsAndEvents</a>
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/env/AbstractBaseEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/AbstractBaseEvaluator.java
index bf3d521d..f5ebab07 100644
--- a/src/main/java/org/apache/commons/scxml2/env/AbstractBaseEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/AbstractBaseEvaluator.java
@@ -79,6 +79,7 @@ public abstract class AbstractBaseEvaluator implements
Evaluator, Serializable {
/**
* Returns cloned value of data of unknown type, to be overridden as
desired by specialized Evaluators
+ *
* @param data data object of unknown type (not of type String, Number,
Boolean, Node, NodeList, List or Map)
* @return toString() value of data of unknown type
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/env/EffectiveContextMap.java
b/src/main/java/org/apache/commons/scxml2/env/EffectiveContextMap.java
index 9acc5b10..228d62cb 100644
--- a/src/main/java/org/apache/commons/scxml2/env/EffectiveContextMap.java
+++ b/src/main/java/org/apache/commons/scxml2/env/EffectiveContextMap.java
@@ -38,6 +38,7 @@ public final class EffectiveContextMap extends
AbstractMap<String, Object> imple
/**
* Constructs a new instance.
+ *
* @param ctx context of the current leave state node
*/
public EffectiveContextMap(final Context ctx) {
@@ -80,6 +81,7 @@ public final class EffectiveContextMap extends
AbstractMap<String, Object> imple
/**
* Parent Context first merging of all Context vars, to ensure same named
'local' vars shadows parent var
+ *
* @param leaf current leaf Context
* @param map Map to merge vars into
*/
diff --git a/src/main/java/org/apache/commons/scxml2/env/URLResolver.java
b/src/main/java/org/apache/commons/scxml2/env/URLResolver.java
index a3cc3dbe..8add0735 100644
--- a/src/main/java/org/apache/commons/scxml2/env/URLResolver.java
+++ b/src/main/java/org/apache/commons/scxml2/env/URLResolver.java
@@ -66,6 +66,7 @@ public class URLResolver implements PathResolver,
Serializable {
/**
* Uses URL(URL, String) constructor to combine URL's.
+ *
* @see org.apache.commons.scxml2.PathResolver#resolvePath(String)
*/
@Override
diff --git
a/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
b/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
index 0238ea9d..3ff701e4 100644
--- a/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
+++ b/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
@@ -66,6 +66,7 @@ public abstract class GroovySCXMLScript extends Script {
/**
* Implements the In() predicate for SCXML documents ( see
Builtin#isMember )
+ *
* @param state The State ID to compare with
* @return Whether this State belongs to this Set
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
b/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
index 8888d13b..fb43ac9b 100644
--- a/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
+++ b/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
@@ -103,6 +103,7 @@ public class JSBindings implements Bindings {
* <li>Delegates to {@link Context#set(String,Object)} if the Context
contains the key (name), else</li>
* <li>Delegates to {@link Context#setLocal(String, Object)}</li>
* </ol>
+ *
* @param name The variable name
* @param value The variable value
*/
@@ -120,6 +121,7 @@ public class JSBindings implements Bindings {
/**
* Sets all entries in the provided map via {@link #put(String, Object)}
+ *
* @param toMerge the map of variables to merge
*/
@Override
@@ -131,6 +133,7 @@ public class JSBindings implements Bindings {
/**
* Removes the named variable from the contained SCXML context.
+ *
* @param name the variable name
*/
@Override
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 7686bfb1..34ec2c17 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
@@ -40,6 +40,7 @@ public class JSContext extends SimpleContext {
/**
* Child constructor - Just invokes the identical SimpleContext
constructor.
+ *
* @param parent Parent context for this context.
*/
public JSContext(final Context parent) {
@@ -48,6 +49,7 @@ public class JSContext extends SimpleContext {
/**
* Constructor with initial vars - Just invokes the identical
SimpleContext constructor.
+ *
* @param parent The parent context
* @param initialVars The initial set of variables.
*/
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 c96dfe7c..c9c9f63f 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
@@ -96,6 +96,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* in order to make sure all the new global variables set by the
JavaScript engine after evaluation are
* available from {@link JSContext} instance as well.
* <p>Note: the internal {@code "_scxmlSystemContext} variable is always
skipped.</p>
+ *
* @param global The Javascript Bindings holding the Javascript Global
context variables
* @param jsContext The SCXML context to copy/merge the variables into
*/
@@ -115,6 +116,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* After evaluation all the resulting Javascript Global context (in {@link
ScriptContext#ENGINE_SCOPE} are first
* copied/merged back into the SCXML context, before the evaluation result
(if any) is returned.
* </p>
+ *
* @param context SCXML context.
* @param expression Expression to evaluate.
* @return Result of expression evaluation or {@code null}.
@@ -184,6 +186,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
/**
* Gets the singleton ScriptEngine, initializing it on first access
+ *
* @return The ScriptEngine
*/
protected ScriptEngine getEngine() {
@@ -221,6 +224,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* after script execution all ENGINE_SCOPE variables (except the {@code
"_scxmlSystemContext"} variable) must be
* copied/merged into the SCXML context to synchronize the SCXML context.
* </p>
+ *
* @param jsContext The current SCXML context
* @return The SCXML instance shared ScriptContext
* @throws ScriptException Thrown if the initialization of the Global
Javascript engine itself failed
@@ -271,6 +275,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
/**
* When directly injecting data in the local context, wrap Java array and
List objects with a native Javascript
* Array
+ *
* @param ctx SCXML context
* @param id context id of the data
* @param data data to inject
@@ -296,6 +301,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
/**
* Javascript engine semantics, using a retained global state, requires
global SCXML context execution
+ *
* @return true
*/
@Override
diff --git a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
index de78c320..a2f02dd7 100644
--- a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
+++ b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
@@ -29,6 +29,7 @@ public final class JexlBuiltin {
/**
* Creates a new instance, wraps the context.
+ *
* @param ctxt the context in use
*/
public JexlBuiltin(final JexlContext ctxt) {
@@ -37,6 +38,7 @@ public final class JexlBuiltin {
/**
* Provides the SCXML standard In() predicate for SCXML documents.
+ *
* @param state The State ID to compare with
* @return true if this state is currently active
*/
diff --git a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlContext.java
b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlContext.java
index 3ca118d4..2130e6cb 100644
--- a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlContext.java
+++ b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlContext.java
@@ -47,6 +47,7 @@ public class JexlContext extends SimpleContext
/**
* Constructor with initial vars.
+ *
* @param parent The parent context
* @param initialVars The initial set of variables.
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
index 1851907c..e6024e34 100644
--- a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
@@ -81,6 +81,7 @@ public class JexlEvaluator extends AbstractBaseEvaluator {
* Create the internal JexlEngine member during the initialization.
* This method can be overriden to specify more detailed options
* into the JexlEngine.
+ *
* @return new JexlEngine instance
*/
protected JexlEngine createJexlEngine() {
@@ -184,6 +185,7 @@ public class JexlEvaluator extends AbstractBaseEvaluator {
* <p>
* <em>NOTE: The internal JexlEngine instance can be null when this is
deserialized.</em>
* </p>
+ *
* @return the current JexlEngine
*/
private JexlEngine getJexlEngine() {
diff --git a/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
b/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
index 282eb85b..d5c4b74e 100644
--- a/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
+++ b/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
@@ -137,6 +137,7 @@ public interface Invoker {
/**
* Sets the parent SCXMLExecutor through which this Invoker is initiated
+ *
* @param scxmlExecutor the parent SCXMLExecutor
*/
void setParentSCXMLExecutor(SCXMLExecutor scxmlExecutor);
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 ece4b041..b04d9cdb 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
@@ -53,6 +53,7 @@ public class ContentParser {
/**
* Check if content starts with JSON object '{' or array '[' marker
+ *
* @param content text to check
* @return true if content start with '{' or '[' character
*/
@@ -63,6 +64,7 @@ public class ContentParser {
/**
* Check if content indicates its an XML document
+ *
* @param content content to check
* @return true if content indicates its an XML document
*/
@@ -72,6 +74,7 @@ public class ContentParser {
/**
* Check if a character is whitespace (space, tab, newline, cr) or not
+ *
* @param c character to check
* @return true if character is whitespace
*/
@@ -82,6 +85,7 @@ public class ContentParser {
/**
* Space normalize content string, trimming pre/post-fixed whitespace and
collapsing embedded whitespaces to
* single space.
+ *
* @param content content to space-normalize
* @return space-normalized content
*/
@@ -114,6 +118,7 @@ public class ContentParser {
/**
* Trim pre/post-fixed whitespace from content string
+ *
* @param content content to trim
* @return trimmed content
*/
@@ -151,6 +156,7 @@ public class ContentParser {
/**
* Constructor with a custom configured Jackson ObjectMapper
+ *
* @param jsonObjectMapper custom configured Jackson ObjectMapper
*/
public ContentParser(final ObjectMapper jsonObjectMapper) {
@@ -164,6 +170,7 @@ public class ContentParser {
* <li>if the content can be interpreted as XML, it will be parsed into
a XML DOM element</li>
* <li>otherwise the content will be treated (cleaned) as a
space-normalized string literal</li>
* </ul>
+ *
* @param content the content to parse
* @return the parsed content object
* @throws IOException In case of parsing exceptions
@@ -184,6 +191,7 @@ public class ContentParser {
/**
* 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
@@ -194,6 +202,7 @@ public class ContentParser {
/**
* Load a resource (URL) as an UTF-8 encoded content string to be parsed
into a ParsedValue content object through {@link #parseContent(String)}
+ *
* @param resourceURL Resource URL to load content from
* @return the parsed content object
* @throws IOException In case of loading or parsing exceptions
@@ -207,6 +216,7 @@ public class ContentParser {
/**
* Parse an XML String and return the document element
+ *
* @param xmlString XML String to parse
* @return document element
* @throws IOException if IO error occurs while parsing XML
@@ -223,6 +233,7 @@ public class ContentParser {
/**
* Transforms a jsonObject to a json String
+ *
* @param jsonObject object to transform
* @return json string
* @throws IOException if IO error occurs while serializing it to JSON
@@ -233,6 +244,7 @@ public class ContentParser {
/**
* Transforms a XML Node to XML
+ *
* @param node node to transform
* @return XML string
* @throws IOException if IO error occurs while serializing node to XML
diff --git a/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
b/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
index 82e868d1..89aabf7d 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
@@ -145,6 +145,7 @@ final class ModelUpdater {
/**
* Initialize all {@link org.apache.commons.scxml2.model.DocumentOrder}
instances (EnterableState or Transition)
* by iterating them in document order setting their document order value.
+ *
* @param states The list of children states of a parent TransitionalState
or the SCXML document itself
* @param nextOrder The next to be used order value
* @return the next to be used order value
@@ -166,6 +167,7 @@ final class ModelUpdater {
/**
* Initialize all {@link org.apache.commons.scxml2.model.Observable}
instances in the SCXML document
* by iterating them in document order and seeding them with a unique
obeservable id.
+ *
* @param states The list of children states of a parent TransitionalState
or the SCXML document itself
* @param nextObservableId The next observable id sequence value to be used
* @return the next to be used observable id sequence value
diff --git a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
index 997915e1..3eddede3 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -410,6 +410,7 @@ public final class SCXMLReader {
/**
* Returns true if it is set to read models silently without any model
error warning logs.
+ *
* @return true if it is set to read models silently without any model
error warning logs
* @see #silent
*/
@@ -419,6 +420,7 @@ public final class SCXMLReader {
/**
* Returns true if it is set to check model strictly with throwing
exceptions on any model error.
+ *
* @return true if it is set to check model strictly with throwing
exceptions on any model error
* @see #strict
*/
@@ -428,6 +430,7 @@ public final class SCXMLReader {
/**
* Turn on/off silent mode (whether to read models silently without
any model error warning logs)
+ *
* @param silent silent mode (whether to read models silently without
any model error warning logs)
* @see #silent
*/
@@ -437,6 +440,7 @@ public final class SCXMLReader {
/**
* Turn on/off strict model (whether to check model strictly with
throwing exception on any model error)
+ *
* @param strict strict model (whether to check model strictly with
throwing exception on any model error)
* @see #strict
*/
@@ -1664,6 +1668,7 @@ public final class SCXMLReader {
/**
* 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
*
@@ -2866,6 +2871,7 @@ public final class SCXMLReader {
/**
* Advances the XMLStreamReader until after the end of the current
element: all children will be skipped as well
+ *
* @param reader the reader
* @throws XMLStreamException
*/
diff --git a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
index 5121c980..de8c710e 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
@@ -1309,6 +1309,7 @@ public class SCXMLWriter {
/**
* Writes out the TransitionTarget id attribute unless it was
auto-generated
+ *
* @param writer The {@link XMLStreamWriter} in use for the serialization.
* @param tt The {@link TransitionTarget} for which to write the id
attribute.
* @throws XMLStreamException
diff --git
a/src/main/java/org/apache/commons/scxml2/model/ActionExecutionError.java
b/src/main/java/org/apache/commons/scxml2/model/ActionExecutionError.java
index 3d75fde9..48f75111 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ActionExecutionError.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ActionExecutionError.java
@@ -28,6 +28,7 @@ import org.apache.commons.scxml2.TriggerEvent;
* <li>if not yet {@link #isEventRaised()} raise the internal error event
{@link TriggerEvent#ERROR_EXECUTION}</li>
* <li>if a non-null error message is provided with the exception, report
an error message with {@link ErrorReporter}</li>
* </ul>
+ *
* @see <a
href="https://www.w3.org/TR/2015/REC-scxml-20150901/#EvaluationofExecutableContent";>SCXML
spec 4.9 Evaluation of Executable Content</a>
*/
public final class ActionExecutionError extends RuntimeException {
diff --git
a/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
b/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
index 95c49893..f9865bd7 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
@@ -32,6 +32,7 @@ public interface ContentContainer {
/**
* Sets the content
+ *
* @param content the content to set
*/
void setContent(Content content);
diff --git
a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
index 02adb952..14e8ba3a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
@@ -110,6 +110,7 @@ public class CustomActionWrapper extends Action {
/**
* Sets the attributes defined on the custom action element
+ *
* @param attributes the attributes to set
*/
public void setAttributes(final Map<String, String> attributes) {
@@ -118,6 +119,7 @@ public class CustomActionWrapper extends Action {
/**
* Sets the custom action XML element local name
+ *
* @param localName custom action XML element local name
*/
public void setLocalName(final String localName) {
@@ -131,6 +133,7 @@ public class CustomActionWrapper extends Action {
/**
* Sets the custom action XML element prefix
+ *
* @param prefix custom action XML element prefix
*/
public void setPrefix(final String prefix) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
b/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
index cd15116b..37d3cdcb 100644
--- a/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
@@ -98,12 +98,14 @@ public abstract class EnterableState extends
TransitionTarget implements Documen
* <p>
* An atomic state is a state of type Final or of type State without
children,
* </p>
+ *
* @return true if this is an atomic state.
*/
public abstract boolean isAtomicState();
/**
* Sets the document order of this state
+ *
* @param order the document order
* @see DocumentOrder
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Final.java
b/src/main/java/org/apache/commons/scxml2/model/Final.java
index e83adae2..a5d02d13 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Final.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Final.java
@@ -62,6 +62,7 @@ public class Final extends EnterableState {
/**
* {@inheritDoc}
+ *
* @return always true (a state of type Final is always atomic)
*/
@Override
@@ -117,6 +118,7 @@ public class Final extends EnterableState {
/**
* Sets the parent State.
+ *
* @param parent The parent state to set
*/
public final void setParent(final State parent) {
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 7adef7d5..d17b6734 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
@@ -119,6 +119,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Enforce identity equality only
+ *
* @param other other object to compare with
* @return this == other
*/
@@ -348,6 +349,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Enforce returning identity based hascode
+ *
* @return {@link System#identityHashCode(Object)
System.identityHashCode(this)}
*/
@Override
@@ -364,6 +366,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Sets the flag indicating whether to forward events to the invoked
process.
+ *
* @param autoForward the flag
*/
public final void setAutoForward(final Boolean autoForward) {
@@ -400,6 +403,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Sets the idlocation expression
+ *
* @param idlocation The idlocation expression
*/
public void setIdlocation(final String idlocation) {
@@ -417,6 +421,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Sets the parent EnterableState.
+ *
* @param parent The parent state to set
* @param invokeIndex the invoke index in the parent (TransitionalState)
defined invokers
*/
@@ -458,6 +463,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Sets the type expression
+ *
* @param typeexpr The type expression to set
*/
public void setTypeexpr(final String typeexpr) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/OnEntry.java
b/src/main/java/org/apache/commons/scxml2/model/OnEntry.java
index 5b281597..c8831afb 100644
--- a/src/main/java/org/apache/commons/scxml2/model/OnEntry.java
+++ b/src/main/java/org/apache/commons/scxml2/model/OnEntry.java
@@ -67,6 +67,7 @@ public class OnEntry extends Executable {
/**
* Sets the indicator whether to raise the non-standard "entry.state.id"
internal event after executing this OnEntry.
+ *
* @param raiseEvent The indicator, when null no event will be raised
*/
public final void setRaiseEvent(final Boolean raiseEvent) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/OnExit.java
b/src/main/java/org/apache/commons/scxml2/model/OnExit.java
index 95f51145..8320af89 100644
--- a/src/main/java/org/apache/commons/scxml2/model/OnExit.java
+++ b/src/main/java/org/apache/commons/scxml2/model/OnExit.java
@@ -67,6 +67,7 @@ public class OnExit extends Executable {
/**
* Sets the indicator whether to raise the non-standard "exit.state.id"
internal event after executing this OnExit.
+ *
* @param raiseEvent The indicator, when null no event will be raised
*/
public final void setRaiseEvent(final Boolean raiseEvent) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Parallel.java
b/src/main/java/org/apache/commons/scxml2/model/Parallel.java
index 48ec0957..8546a3aa 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Parallel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Parallel.java
@@ -39,6 +39,7 @@ public class Parallel extends TransitionalState {
/**
* Add a TransitionalState (State or Parallel) child
+ *
* @param ts the child to add
*/
public final void addChild(final TransitionalState ts) {
@@ -46,6 +47,7 @@ public class Parallel extends TransitionalState {
}
/**
* {@inheritDoc}
+ *
* @return always false (a state of type Parallel is never atomic)
*/
@Override
diff --git a/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
b/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
index 393ae227..d5a19260 100644
--- a/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
+++ b/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
@@ -46,6 +46,7 @@ public class PayloadBuilder {
* Adds data to the payload data map based on the namelist which names are
location expressions
* (typically data ids or for example XPath variables). The names and the
values they 'point' at
* are added to the payload data map.
+ *
* @param parentState the enterable state in which the namelist holder is
defined
* @param ctx the Context to look up the data
* @param evaluator the evaluator to evaluate/lookup the data
@@ -75,6 +76,7 @@ public class PayloadBuilder {
/**
* Adds data to the payload data map based on the {@link Param}s of this
{@link ParamsContainer}
+ *
* @param ctx The Context to look up the data
* @param evaluator the evaluator to evaluate/lookup the data
* @param paramsList the list of params
@@ -114,6 +116,7 @@ public class PayloadBuilder {
* the other side, attribute values (notably: {@link Node} value only for
now) is cloned first before being added
* to the payload data map. This includes 'nested' values within a {@link
NodeList}, {@link List} or {@link Map}.
* </p>
+ *
* @param attrName the name of the attribute to add
* @param attrValue the value of the attribute to add
* @param payload the payload data map to be updated
diff --git a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
index 2ccb15e6..23163489 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
@@ -122,6 +122,7 @@ public class SCXML implements Serializable, Observable {
/**
* The next auto-generated transition target unique id value
+ *
* @see #generateTransitionTargetId()
*/
private long ttNextId;
@@ -155,6 +156,7 @@ public class SCXML implements Serializable, Observable {
/**
* Simple unique TransitionTarget id value generation
+ *
* @return a unique TransitionTarget id for this SCXML instance
*/
public final String generateTransitionTargetId() {
@@ -182,6 +184,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the datamodel name as specified as attribute on this document
+ *
* @return The datamodel name of this document
*/
public String getDatamodelName() {
@@ -314,6 +317,7 @@ public class SCXML implements Serializable, Observable {
/**
* Sets the datamodel name as specified as attribute on this document
+ *
* @param datamodelName The datamodel name
*/
public void setDatamodelName(final String datamodelName) {
diff --git
a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
index c4aa8b0e..ed731ff7 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
@@ -38,12 +38,14 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* The Transition type: internal or external (default)
+ *
* @see #isTypeInternal()
*/
private TransitionType type;
/**
* The transition domain for this transition.
+ *
* @see #getTransitionDomain()
*/
private TransitionalState transitionDomain;
@@ -55,6 +57,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Derived effective Transition type.
+ *
* @see #isTypeInternal()
*/
private Boolean typeInternal;
@@ -206,6 +209,7 @@ public class SimpleTransition extends Executable implements
Observable {
* <p>
* Otherwise it is treated (for determining its exit states) as if it is
of type {@link TransitionType#external}
* </p>
+ *
* @see <a
href="https://www.w3.org/TR/2015/REC-scxml-20150901/#SelectingTransitions";>
*
https://www.w3.org/TR/2015/REC-scxml-20150901/#SelectingTransitions</a>
* @return true if the effective Transition type is {@link
TransitionType#internal}
@@ -239,6 +243,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Sets the observableId for this Observable, which must be unique within
the SCXML state machine
+ *
* @param observableId the observableId
*/
public final void setObservableId(final Integer observableId) {
@@ -259,6 +264,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Sets the Transition type
+ *
* @param type the Transition type
*/
public final void setType(final TransitionType type) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/State.java
b/src/main/java/org/apache/commons/scxml2/model/State.java
index c3fef187..f2351b73 100644
--- a/src/main/java/org/apache/commons/scxml2/model/State.java
+++ b/src/main/java/org/apache/commons/scxml2/model/State.java
@@ -46,6 +46,7 @@ public class State extends TransitionalState {
/**
* Adds an EnterableState (State, Final or Parallel) child
+ *
* @param es the child to add
*/
@Override
@@ -73,6 +74,7 @@ public class State extends TransitionalState {
/**
* {@inheritDoc}
+ *
* @return true if this State has no children
*/
@Override
diff --git a/src/main/java/org/apache/commons/scxml2/model/Transition.java
b/src/main/java/org/apache/commons/scxml2/model/Transition.java
index 9ab7fbcd..5c490d5c 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Transition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Transition.java
@@ -162,6 +162,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
/**
* Sets the document order of this transition
+ *
* @param order the document order
* @see DocumentOrder
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
index e6764979..57330a4a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
@@ -54,6 +54,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Enforce identity equality only
+ *
* @param other other object to compare with
* @return this == other
*/
@@ -64,6 +65,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Gets the ancestor of this TransitionTarget at specified level
+ *
* @param level the level of the ancestor to return, zero being top
* @return the ancestor at specified level
*/
@@ -107,6 +109,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Enforce returning identity based hascode
+ *
* @return {@link System#identityHashCode(Object)
System.identityHashCode(this)}
*/
@Override
@@ -138,6 +141,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Sets the observableId for this Observable, which must be unique within
the SCXML state machine
+ *
* @param observableId the observableId
*/
public final void setObservableId(final Integer observableId) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/TransitionType.java
b/src/main/java/org/apache/commons/scxml2/model/TransitionType.java
index 3a0b410e..782b066b 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionType.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionType.java
@@ -22,6 +22,7 @@ package org.apache.commons.scxml2.model;
* The Transition type determines whether the source state is exited in
transitions
* whose target state is a descendant of the source state.
* </p>
+ *
* @see <a href="https://www.w3.org/TR/2015/REC-scxml-20150901/#transition";>
* https://www.w3.org/TR/2015/REC-scxml-20150901/#transition</a>
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
index 0fe2faa3..9eaf738b 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
@@ -106,6 +106,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the ancestor of this TransitionalState at specified level
+ *
* @param level the level of the ancestor to return, zero being top
* @return the ancestor at specified level
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
b/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
index 31d93242..feac5300 100644
--- a/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
+++ b/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
@@ -188,6 +188,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* <p>
* This method corresponds to the Algorithm for SCXML processing
computeEntrySet() procedure.
* </p>
+ *
* @param exctx The execution context for this step
* @param step The step containing the list of transitions to be taken
*/
@@ -224,6 +225,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* <p>
* This method corresponds to the Algorithm for SCXML processing
computeExitSet() procedure.
* </p>
+ *
* @param transition The transition to compute the states to exit from
* @param exitSet The set for adding the states to exit to
* @param activeStates The current active states of the state machine
({@link StateConfiguration#getActiveStates()}).
@@ -250,6 +252,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* <p>
* This method corresponds to the Algorithm for SCXML processing
computeExitSet() procedure.
* </p>
+ *
* @param step The step containing the list of transitions to be taken
* @param stateConfiguration The current configuration of the state
machine ({@link SCInstance#getStateConfiguration()}).
*/
@@ -469,6 +472,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* <p>
* This final step will exit all remaining active states and cancel any
active invokers.
* </p>
+ *
* @param exctx The execution context for this step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
@@ -527,6 +531,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* If the state machine no longer is running after all this, first the
{@link #finalStep(SCXMLExecutionContext)}
* will be called for cleanup before returning.
* </p>
+ *
* @param exctx The execution context for this step
* @throws ModelException if the state machine instance failed to
initialize or a SCXML model error occurred during
* the execution.
@@ -684,6 +689,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* sub-flow, which are the first <em>3</em> steps of the described
<em>4</em>, so everything up to the blocking
* wait for an external event.
* </p>
+ *
* @param exctx The execution context for this step
* @param statesToInvoke the set of activated states which invokes need to
be invoked at the end of the current
* macro step
@@ -778,6 +784,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* <p>
* This micro step is corresponding to the Algorithm for SCXML processing
microstep() procedure.
* </p>
+ *
* @param exctx The execution context for this step
* @param step The current micro step
* @param statesToInvoke the set of activated states which invokes need to
be invoked at the end of the current
@@ -816,6 +823,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* If the state machine no longer is running after all this, first the
{@link #finalStep(SCXMLExecutionContext)}
* will be called for cleanup before returning.
* </p>
+ *
* @param exctx The execution context for this step
* @param event The event to process
* @throws ModelException if a SCXML model error occurred during the
execution.
@@ -929,6 +937,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* history configurations will be persisted during the actual {@link
#exitStates(SCXMLExecutionContext, Step, Set)}
* processing.
* </p>
+ *
* @param step The step containing the list of states to exit, and the map
to record the new history configurations
* @param atomicStates The current set of active atomic states in the
state machine
* @param activeStates The current set of all active states in the state
machine
@@ -1079,6 +1088,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics
{
* For the event a EventVariable is instantiated and the provided event
its type is mapped to the one of the
* SCXML specification predefined types.
* </p>
+ *
* @param scInstance the state machine instance holding the system context
* @param event The event being stored
* @param internal Flag indicating the event was received internally or
externally
diff --git
a/src/main/java/org/apache/commons/scxml2/test/StandaloneJexlExpressions.java
b/src/main/java/org/apache/commons/scxml2/test/StandaloneJexlExpressions.java
index 5cb68c01..9d9ebc22 100644
---
a/src/main/java/org/apache/commons/scxml2/test/StandaloneJexlExpressions.java
+++
b/src/main/java/org/apache/commons/scxml2/test/StandaloneJexlExpressions.java
@@ -44,6 +44,7 @@ public final class StandaloneJexlExpressions {
/**
* Launcher.
+ *
* @param args The arguments, one expected, the URI or file name of the
* SCXML document
*/
