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 ef58837 Normalize setter Javadoc
ef58837 is described below
commit ef58837127708cfdccdcb7f0d0fb98866fadd94b
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:15:43 2023 -0400
Normalize setter Javadoc
---
.../java/org/apache/commons/scxml2/SCInstance.java | 10 +++++-----
.../commons/scxml2/SCInstanceObjectInputStream.java | 2 +-
.../apache/commons/scxml2/SCXMLExecutionContext.java | 10 +++++-----
.../org/apache/commons/scxml2/SCXMLExecutor.java | 12 ++++++------
.../commons/scxml2/env/AbstractStateMachine.java | 2 +-
.../org/apache/commons/scxml2/env/SimpleContext.java | 2 +-
.../commons/scxml2/env/javascript/JSBindings.java | 2 +-
.../org/apache/commons/scxml2/invoke/Invoker.java | 2 +-
.../java/org/apache/commons/scxml2/model/Action.java | 2 +-
.../java/org/apache/commons/scxml2/model/Assign.java | 8 ++++----
.../java/org/apache/commons/scxml2/model/Cancel.java | 4 ++--
.../org/apache/commons/scxml2/model/Content.java | 4 ++--
.../commons/scxml2/model/CustomActionWrapper.java | 6 +++---
.../java/org/apache/commons/scxml2/model/Data.java | 8 ++++----
.../java/org/apache/commons/scxml2/model/ElseIf.java | 2 +-
.../org/apache/commons/scxml2/model/Executable.java | 2 +-
.../java/org/apache/commons/scxml2/model/Final.java | 2 +-
.../org/apache/commons/scxml2/model/Finalize.java | 2 +-
.../org/apache/commons/scxml2/model/History.java | 4 ++--
.../java/org/apache/commons/scxml2/model/If.java | 2 +-
.../org/apache/commons/scxml2/model/Initial.java | 4 ++--
.../java/org/apache/commons/scxml2/model/Invoke.java | 18 +++++++++---------
.../java/org/apache/commons/scxml2/model/Log.java | 4 ++--
.../org/apache/commons/scxml2/model/OnEntry.java | 4 ++--
.../java/org/apache/commons/scxml2/model/OnExit.java | 4 ++--
.../java/org/apache/commons/scxml2/model/Param.java | 6 +++---
.../java/org/apache/commons/scxml2/model/Raise.java | 2 +-
.../java/org/apache/commons/scxml2/model/SCXML.java | 18 +++++++++---------
.../java/org/apache/commons/scxml2/model/Send.java | 20 ++++++++++----------
.../commons/scxml2/model/SimpleTransition.java | 4 ++--
.../java/org/apache/commons/scxml2/model/State.java | 4 ++--
.../org/apache/commons/scxml2/model/Transition.java | 4 ++--
.../commons/scxml2/model/TransitionTarget.java | 4 ++--
.../commons/scxml2/model/TransitionalState.java | 6 +++---
.../java/org/apache/commons/scxml2/model/Var.java | 4 ++--
.../org/apache/commons/scxml2/TriggerEventTest.java | 2 +-
.../scxml2/env/AbstractSCXMLListenerTest.java | 2 +-
.../org/apache/commons/scxml2/env/StopWatchTest.java | 2 +-
.../apache/commons/scxml2/io/SCXMLReaderTest.java | 2 +-
.../commons/scxml2/model/CustomActionTest.java | 2 +-
.../java/org/apache/commons/scxml2/model/Hello.java | 2 +-
41 files changed, 103 insertions(+), 103 deletions(-)
diff --git a/src/main/java/org/apache/commons/scxml2/SCInstance.java
b/src/main/java/org/apache/commons/scxml2/SCInstance.java
index af06ea8..a3f8064 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstance.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstance.java
@@ -221,7 +221,7 @@ public class SCInstance implements Serializable {
}
/**
- * Set or re-attach the evaluator
+ * Sets or re-attach the evaluator
* <p>
* If not re-attaching and this state machine instance has been
initialized before,
* it will be initialized again, destroying all existing state!
@@ -251,7 +251,7 @@ public class SCInstance implements Serializable {
}
/**
- * Set or re-attach the error reporter
+ * 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
*/
@@ -429,7 +429,7 @@ public class SCInstance implements Serializable {
}
/**
- * Set or replace the root context.
+ * Sets or replace the root context.
* @param context The new root context.
*/
protected void setRootContext(final Context context) {
@@ -520,7 +520,7 @@ public class SCInstance implements Serializable {
}
/**
- * Set the context for an EnterableState
+ * Sets the context for an EnterableState
*
* <p>Note: used for testing purposes only</p>
*
@@ -547,7 +547,7 @@ public class SCInstance implements Serializable {
}
/**
- * Set the last configuration for this history.
+ * Sets the last configuration for this history.
*
* @param history The history.
* @param lc The lastConfiguration to set.
diff --git
a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
index 9f5695d..98adec9 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
@@ -58,7 +58,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
}
/**
- * Set custom class resolver callback, or null when no longer needed.
+ * Sets custom class resolver callback, or null when no longer needed.
* <p>
* Typically usage:
* <pre><code>
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index 0138d20..cce5565 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -180,7 +180,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * Set if the SCXML configuration should be checked before execution
(default = true)
+ * Sets if the SCXML configuration should be checked before execution
(default = true)
* @param checkLegalConfiguration flag to set
*/
public void setCheckLegalConfiguration(final boolean
checkLegalConfiguration) {
@@ -252,7 +252,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * Set or replace the state machine to be executed
+ * Sets or replace the state machine to be executed
* <p>
* If the state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
@@ -282,7 +282,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * Set or replace the evaluator
+ * Sets or replace the evaluator
* <p>
* If the state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
@@ -305,7 +305,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * Set or replace the error reporter
+ * Sets or replace the error reporter
*
* @param errorReporter The error reporter to set, if null a
SimpleErrorReporter instance will be used instead
*/
@@ -327,7 +327,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * Set or replace the event dispatch
+ * Sets or replace the event dispatch
*
* @param eventdispatcher The event dispatcher to set, if null a
SimpleDispatcher instance will be used instead
*/
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
index 46e46db..43d3834 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
@@ -184,7 +184,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * Set or replace the expression evaluator
+ * Sets or replace the expression evaluator
* <p>
* If the state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
@@ -233,7 +233,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * Set the root context for the state machine execution.
+ * Sets the root context for the state machine execution.
* <b>NOTE:</b> Should only be used before the executor is set in motion.
*
* @param rootContext The Context that ties to the host environment.
@@ -267,7 +267,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * Set or replace the state machine to be executed
+ * Sets or replace the state machine to be executed
* <p>
* If the state machine instance has been initialized before, it will be
initialized again, destroying all existing
* state!
@@ -293,7 +293,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * Set or replace the error reporter
+ * Sets or replace the error reporter
*
* @param errorReporter The error reporter to set, if null a
SimpleErrorReporter instance will be used instead
*/
@@ -311,7 +311,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * Set or replace the event dispatch
+ * Sets or replace the event dispatch
*
* @param eventdispatcher The event dispatcher to set, if null a
SimpleDispatcher instance will be used instead
*/
@@ -320,7 +320,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * Set if the SCXML configuration should be checked before execution
(default = true)
+ * Sets if the SCXML configuration should be checked before execution
(default = true)
* @param checkLegalConfiguration flag to set
*/
public void setCheckLegalConfiguration(final boolean
checkLegalConfiguration) {
diff --git
a/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
b/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
index fa1c322..3831b72 100644
--- a/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
+++ b/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
@@ -222,7 +222,7 @@ public abstract class AbstractStateMachine {
}
/**
- * Set the log for this class.
+ * Sets the log for this class.
*
* @param log The log to set.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
b/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
index 2c61319..5d0811c 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
@@ -187,7 +187,7 @@ public class SimpleContext implements Context, Serializable
{
}
/**
- * Set the variables map.
+ * Sets the variables map.
*
* @param vars The new Map of variables.
*/
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 0322365..6e52001 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
@@ -45,7 +45,7 @@ public class JSBindings implements Bindings {
}
/**
- * Set or update the SCXML context delegate
+ * Sets or update the SCXML context delegate
*
* @param jsContext the SCXML context to use for script variables.
* @throws IllegalArgumentException Thrown if <code>jsContext</code> is
<code>null</code>.
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 446a093..c8dd791 100644
--- a/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
+++ b/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
@@ -72,7 +72,7 @@ public interface Invoker {
String getInvokeId();
/**
- * Set the invoke ID provided by the parent state machine executor
+ * Sets the invoke ID provided by the parent state machine executor
* Implementations must use this ID for constructing the event name for
* the special "done" event (and optionally, for other event names
* as well).
diff --git a/src/main/java/org/apache/commons/scxml2/model/Action.java
b/src/main/java/org/apache/commons/scxml2/model/Action.java
index 4ede8b7..f8e11bb 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Action.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Action.java
@@ -49,7 +49,7 @@ public abstract class Action implements Serializable {
}
/**
- * Set the Executable parent.
+ * Sets the Executable parent.
*
* @param parent The parent to set.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Assign.java
b/src/main/java/org/apache/commons/scxml2/model/Assign.java
index 05ef6f1..7956c28 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Assign.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Assign.java
@@ -69,7 +69,7 @@ public class Assign extends Action implements
ParsedValueContainer {
}
/**
- * Set the expr that will evaluate to the new value.
+ * Sets the expr that will evaluate to the new value.
*
* @param expr The expr to set.
*/
@@ -87,7 +87,7 @@ public class Assign extends Action implements
ParsedValueContainer {
}
/**
- * Set the location for a previously defined XML data tree.
+ * Sets the location for a previously defined XML data tree.
*
* @param location The location.
*/
@@ -105,7 +105,7 @@ public class Assign extends Action implements
ParsedValueContainer {
}
/**
- * Set the source where the new XML instance for this location exists.
+ * Sets the source where the new XML instance for this location exists.
*
* @param src The source.
*/
@@ -124,7 +124,7 @@ public class Assign extends Action implements
ParsedValueContainer {
}
/**
- * Set the assign value
+ * Sets the assign value
*
* @param assignValue The assign value
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Cancel.java
b/src/main/java/org/apache/commons/scxml2/model/Cancel.java
index f9b7b4f..2b6a409 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Cancel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Cancel.java
@@ -58,7 +58,7 @@ public class Cancel extends Action {
}
/**
- * Set the ID of the send message that should be cancelled.
+ * Sets the ID of the send message that should be cancelled.
*
* @param sendid The sendid to set.
*/
@@ -76,7 +76,7 @@ public class Cancel extends Action {
}
/**
- * Set the expression that evaluates to the ID of the send message that
should be cancelled.
+ * Sets the expression that evaluates to the ID of the send message that
should be cancelled.
*
* @param sendidexpr the expression that evaluates to the ID of the send
message that should be cancelled.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Content.java
b/src/main/java/org/apache/commons/scxml2/model/Content.java
index 6d8fd33..0df5cc1 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Content.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Content.java
@@ -47,7 +47,7 @@ public class Content implements ParsedValueContainer {
}
/**
- * Set the expression for this content.
+ * Sets the expression for this content.
*
* @param expr The expression for this content.
*/
@@ -66,7 +66,7 @@ public class Content implements ParsedValueContainer {
}
/**
- * Set the content element body
+ * Sets the content element body
*
* @param contentBody The content element body
*/
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 ceedfab..efca8e7 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
@@ -69,7 +69,7 @@ public class CustomActionWrapper extends Action {
}
/**
- * Set the custom action XML element prefix
+ * Sets the custom action XML element prefix
* @param prefix custom action XML element prefix
*/
public void setPrefix(final String prefix) {
@@ -84,7 +84,7 @@ public class CustomActionWrapper extends Action {
}
/**
- * Set the custom action XML element local name
+ * Sets the custom action XML element local name
* @param localName custom action XML element local name
*/
public void setLocalName(final String localName) {
@@ -110,7 +110,7 @@ public class CustomActionWrapper extends Action {
}
/**
- * Set the attributes defined on the custom action element
+ * Sets the attributes defined on the custom action element
* @param attributes the attributes to set
*/
public void setAttributes(final Map<String, String> attributes) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Data.java
b/src/main/java/org/apache/commons/scxml2/model/Data.java
index 01c589d..5f2f20b 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Data.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Data.java
@@ -58,7 +58,7 @@ public class Data implements ParsedValueContainer {
}
/**
- * Set the id.
+ * Sets the id.
*
* @param id The identifier.
*/
@@ -76,7 +76,7 @@ public class Data implements ParsedValueContainer {
}
/**
- * Set the URL for external data.
+ * Sets the URL for external data.
*
* @param src The source URL.
*/
@@ -94,7 +94,7 @@ public class Data implements ParsedValueContainer {
}
/**
- * Set the expression that evaluates to the value of this data instance.
+ * Sets the expression that evaluates to the value of this data instance.
*
* @param expr The expression.
*/
@@ -113,7 +113,7 @@ public class Data implements ParsedValueContainer {
}
/**
- * Set the data value
+ * Sets the data value
*
* @param dataValue The data value
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
b/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
index ea8f77c..554beeb 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
@@ -51,7 +51,7 @@ public class ElseIf extends Action {
}
/**
- * Set the conditional expression.
+ * Sets the conditional expression.
*
* @param cond The cond to set.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Executable.java
b/src/main/java/org/apache/commons/scxml2/model/Executable.java
index 33d3c6f..671bb37 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Executable.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Executable.java
@@ -75,7 +75,7 @@ public abstract class Executable implements Serializable {
}
/**
- * Set the EnterableState parent.
+ * Sets the EnterableState parent.
*
* @param parent The parent to set.
*/
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 5fcf1a6..b3632c7 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Final.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Final.java
@@ -57,7 +57,7 @@ public class Final extends EnterableState {
}
/**
- * Set the parent State.
+ * 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/Finalize.java
b/src/main/java/org/apache/commons/scxml2/model/Finalize.java
index 8c2972d..3d03ba4 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Finalize.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Finalize.java
@@ -42,7 +42,7 @@ public class Finalize extends Executable {
}
/**
- * Set the TransitionalState parent.
+ * Sets the TransitionalState parent.
*
* @param parent The parent to set.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/History.java
b/src/main/java/org/apache/commons/scxml2/model/History.java
index 67b5e90..8b074ea 100644
--- a/src/main/java/org/apache/commons/scxml2/model/History.java
+++ b/src/main/java/org/apache/commons/scxml2/model/History.java
@@ -55,7 +55,7 @@ public class History extends TransitionTarget {
}
/**
- * Set the transition.
+ * Sets the transition.
*
* @param transition The transition to set.
*/
@@ -96,7 +96,7 @@ public class History extends TransitionTarget {
}
/**
- * Set the TransitionalState parent.
+ * Sets the TransitionalState parent.
*
* @param parent The parent to set.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/If.java
b/src/main/java/org/apache/commons/scxml2/model/If.java
index 0dae2f9..490db90 100644
--- a/src/main/java/org/apache/commons/scxml2/model/If.java
+++ b/src/main/java/org/apache/commons/scxml2/model/If.java
@@ -99,7 +99,7 @@ public class If extends Action implements ActionsContainer {
}
/**
- * Set the conditional expression.
+ * Sets the conditional expression.
*
* @param cond The cond to set.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Initial.java
b/src/main/java/org/apache/commons/scxml2/model/Initial.java
index 7a6d3b1..6474e07 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Initial.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Initial.java
@@ -63,7 +63,7 @@ public class Initial implements Serializable {
/**
- * Set the parent TransitionTarget.
+ * Sets the parent TransitionTarget.
*
* @param parent The parent state to set
*/
@@ -84,7 +84,7 @@ public class Initial implements Serializable {
}
/**
- * Set the initial transition.
+ * Sets the initial transition.
*
* @param transition The transition to set.
*/
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 0390270..29dac50 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
@@ -127,7 +127,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the identifier for this invoke.
+ * Sets the identifier for this invoke.
*
* @param id The id to set.
*/
@@ -143,7 +143,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the idlocation expression
+ * Sets the idlocation expression
* @param idlocation The idlocation expression
*/
public void setIdlocation(final String idlocation) {
@@ -160,7 +160,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the type for this <invoke> element.
+ * Sets the type for this <invoke> element.
*
* @param type The type to set.
*/
@@ -193,7 +193,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the URL for the external service.
+ * Sets the URL for the external service.
*
* @param src The source URL.
*/
@@ -212,7 +212,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the expression that evaluates to the source URL for the
+ * Sets the expression that evaluates to the source URL for the
* external service.
*
* @param srcexpr The source expression.
@@ -237,7 +237,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the flag indicating whether to forward events to the invoked
process.
+ * Sets the flag indicating whether to forward events to the invoked
process.
* @param autoForward the flag
*/
public final void setAutoForward(final Boolean autoForward) {
@@ -254,7 +254,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the Finalize for this Invoke.
+ * Sets the Finalize for this Invoke.
*
* @param finalize The Finalize for this Invoke.
*/
@@ -282,7 +282,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the namelist.
+ * Sets the namelist.
*
* @param namelist The namelist to set.
*/
@@ -347,7 +347,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * Set the parent EnterableState.
+ * Sets the parent EnterableState.
* @param parent The parent state to set
* @param invokeIndex the invoke index in the parent (TransitionalState)
defined invokers
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Log.java
b/src/main/java/org/apache/commons/scxml2/model/Log.java
index bd56e53..377485a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Log.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Log.java
@@ -59,7 +59,7 @@ public class Log extends Action {
}
/**
- * Set the log expression.
+ * Sets the log expression.
*
* @param expr The expr to set.
*/
@@ -77,7 +77,7 @@ public class Log extends Action {
}
/**
- * Set the log label.
+ * Sets the log label.
*
* @param label The label to set.
*/
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 f75a84b..71437ec 100644
--- a/src/main/java/org/apache/commons/scxml2/model/OnEntry.java
+++ b/src/main/java/org/apache/commons/scxml2/model/OnEntry.java
@@ -41,7 +41,7 @@ public class OnEntry extends Executable {
}
/**
- * Set the EnterableState parent.
+ * Sets the EnterableState parent.
*
* @param parent The parent to set.
*/
@@ -66,7 +66,7 @@ public class OnEntry extends Executable {
}
/**
- * Set the indicator whether to raise the non-standard "entry.state.id"
internal event after executing this OnEntry.
+ * 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 66207e0..e93da66 100644
--- a/src/main/java/org/apache/commons/scxml2/model/OnExit.java
+++ b/src/main/java/org/apache/commons/scxml2/model/OnExit.java
@@ -41,7 +41,7 @@ public class OnExit extends Executable {
}
/**
- * Set the EnterableState parent.
+ * Sets the EnterableState parent.
*
* @param parent The parent to set.
*/
@@ -66,7 +66,7 @@ public class OnExit extends Executable {
}
/**
- * Set the indicator whether to raise the non-standard "exit.state.id"
internal event after executing this OnExit.
+ * 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/Param.java
b/src/main/java/org/apache/commons/scxml2/model/Param.java
index bac8b49..717a6c8 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Param.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Param.java
@@ -62,7 +62,7 @@ public class Param implements Serializable {
}
/**
- * Set the name for this param.
+ * Sets the name for this param.
*
* @param name The param name.
*/
@@ -80,7 +80,7 @@ public class Param implements Serializable {
}
/**
- * Set the location for a previously defined XML data tree.
+ * Sets the location for a previously defined XML data tree.
*
* @param location The location.
*/
@@ -98,7 +98,7 @@ public class Param implements Serializable {
}
/**
- * Set the expression for this param value.
+ * Sets the expression for this param value.
*
* @param expr The expression for this param value.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Raise.java
b/src/main/java/org/apache/commons/scxml2/model/Raise.java
index 2d8e482..d611a8e 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Raise.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Raise.java
@@ -55,7 +55,7 @@ public class Raise extends Action {
}
/**
- * Set the event.
+ * Sets the event.
*
* @param event The event to set.
*/
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 bafc229..45874ac 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
@@ -168,7 +168,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the {@link PathResolver}.
+ * Sets the {@link PathResolver}.
*
* @param pathResolver The pathResolver to set.
*/
@@ -188,7 +188,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the initial Transition.
+ * Sets the initial Transition.
* <p>Note: the initial transition can/may not have executable content!</p>
*
* @param initialTransition The initial transition to set.
@@ -209,7 +209,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the data model at document root.
+ * Sets the data model at document root.
*
* @param datamodel The Datamodel to set.
*/
@@ -290,7 +290,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the SCXML document version.
+ * Sets the SCXML document version.
*
* @param version The version to set.
*/
@@ -310,7 +310,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the namespace definitions specified on the SCXML element.
+ * Sets the namespace definitions specified on the SCXML element.
*
* @param namespaces The namespace definitions specified on the
* SCXML element.
@@ -330,7 +330,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the initial transition target.
+ * Sets the initial transition target.
*
* @param initial The initial transition target
* @see #setInitialTransition(SimpleTransition)
@@ -349,7 +349,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the name for this state machine.
+ * Sets the name for this state machine.
*
* @param name The name for this state machine.
*/
@@ -367,7 +367,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the profile in use for this state machine.
+ * Sets the profile in use for this state machine.
*
* @param profile The profile to be used.
*/
@@ -385,7 +385,7 @@ public class SCXML implements Serializable, Observable {
}
/**
- * Set the exmode to be used for this state machine.
+ * Sets the exmode to be used for this state machine.
*
* @param exmode The exmode to be used.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/model/Send.java
b/src/main/java/org/apache/commons/scxml2/model/Send.java
index 5b0f60f..4149ff4 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Send.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Send.java
@@ -152,7 +152,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the idlocation expression
+ * Sets the idlocation expression
*
* @param idlocation The idlocation expression
*/
@@ -170,7 +170,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the delay.
+ * Sets the delay.
*
* @param delay The delay to set.
*/
@@ -186,7 +186,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the delay expression
+ * Sets the delay expression
*
* @param delayexpr The delay expression to set
*/
@@ -204,7 +204,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the hints for this <send> element.
+ * Sets the hints for this <send> element.
*
* @param hints The hints to set.
*/
@@ -222,7 +222,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the identifier for this <send> element.
+ * Sets the identifier for this <send> element.
*
* @param id The id to set.
*/
@@ -240,7 +240,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the target for this <send> element.
+ * Sets the target for this <send> element.
*
* @param target The target to set.
*/
@@ -256,7 +256,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the target expression
+ * Sets the target expression
*
* @param targetexpr The target expression to set
*/
@@ -274,7 +274,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the type for this <send> element.
+ * Sets the type for this <send> element.
*
* @param type The type to set.
*/
@@ -308,7 +308,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the event to send.
+ * Sets the event to send.
*
* @return String Returns the event.
*/
@@ -372,7 +372,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * Set the namelist.
+ * Sets the namelist.
*
* @param namelist The namelist to set.
*/
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 d6d1d88..df929f2 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
@@ -110,7 +110,7 @@ public class SimpleTransition extends Executable implements
Observable {
}
/**
- * Set the TransitionalState (State or Parallel) parent
+ * Sets the TransitionalState (State or Parallel) parent
* <p>
* For transitions of Initial or History elements their TransitionalState
parent must be set.
* </p>
@@ -257,7 +257,7 @@ public class SimpleTransition extends Executable implements
Observable {
}
/**
- * Set the transition target by specifying its ID.
+ * Sets the transition target by specifying its ID.
*
* @param next The the transition target ID
*/
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 4731aa5..ab1d11a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/State.java
+++ b/src/main/java/org/apache/commons/scxml2/model/State.java
@@ -54,7 +54,7 @@ public class State extends TransitionalState {
}
/**
- * Set the initial state.
+ * Sets the initial state.
*
* @param target
* The target to set.
@@ -75,7 +75,7 @@ public class State extends TransitionalState {
}
/**
- * Set the initial state by its ID string.
+ * Sets the initial state by its ID string.
*
* @param target
* The initial target's ID to set.
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 0f007da..73a0876 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Transition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Transition.java
@@ -94,7 +94,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
}
/**
- * Set the guard condition.
+ * Sets the guard condition.
*
* @param cond The cond to set.
*/
@@ -113,7 +113,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
}
/**
- * Set the event that will trigger this transition (pending
+ * Sets the event that will trigger this transition (pending
* evaluation of the guard condition in favor).
*
* @param event The event to set.
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 be0d7af..db0f0b5 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
@@ -78,7 +78,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
}
/**
- * Set the identifier for this transition target.
+ * Sets the identifier for this transition target.
*
* @param id The id to set.
*/
@@ -113,7 +113,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
}
/**
- * Set the parent EnterableState.
+ * Sets the parent EnterableState.
* <p>
* The parent of a TransitionTarget must be of type EnterableState as a
History (as only non-EnterableState)
* TransitionTarget cannot have children.
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 21fe8e1..951e23a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
@@ -87,7 +87,7 @@ public abstract class TransitionalState extends
EnterableState {
}
/**
- * Set the TransitionalState parent
+ * Sets the TransitionalState parent
*
* @param parent The parent to set.
*/
@@ -157,7 +157,7 @@ public abstract class TransitionalState extends
EnterableState {
}
/**
- * Set the data model for this transition target.
+ * Sets the data model for this transition target.
*
* @param datamodel The Datamodel to set.
*/
@@ -210,7 +210,7 @@ public abstract class TransitionalState extends
EnterableState {
}
/**
- * Set the Invoke child.
+ * Sets the Invoke child.
*
* @param invoke
* The invoke to set.
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 ca961d4..42239a7 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Var.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Var.java
@@ -69,7 +69,7 @@ public class Var extends Action {
}
/**
- * Set the expression that evaluates to the initial value
+ * Sets the expression that evaluates to the initial value
* of the variable.
*
* @param expr The expr to set.
@@ -88,7 +88,7 @@ public class Var extends Action {
}
/**
- * Set the name of the (new) variable.
+ * Sets the name of the (new) variable.
*
* @param name The name to set.
*/
diff --git a/src/test/java/org/apache/commons/scxml2/TriggerEventTest.java
b/src/test/java/org/apache/commons/scxml2/TriggerEventTest.java
index 29bea82..002f24a 100644
--- a/src/test/java/org/apache/commons/scxml2/TriggerEventTest.java
+++ b/src/test/java/org/apache/commons/scxml2/TriggerEventTest.java
@@ -35,7 +35,7 @@ public class TriggerEventTest {
private TriggerEvent te1, te2, te3, te4, te5, te6, te7;
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@BeforeEach
public void setUp() {
diff --git
a/src/test/java/org/apache/commons/scxml2/env/AbstractSCXMLListenerTest.java
b/src/test/java/org/apache/commons/scxml2/env/AbstractSCXMLListenerTest.java
index 492fccc..e8fb324 100644
--- a/src/test/java/org/apache/commons/scxml2/env/AbstractSCXMLListenerTest.java
+++ b/src/test/java/org/apache/commons/scxml2/env/AbstractSCXMLListenerTest.java
@@ -40,7 +40,7 @@ public class AbstractSCXMLListenerTest {
private boolean heardOnTransition;
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@BeforeEach
public void setUp() {
diff --git a/src/test/java/org/apache/commons/scxml2/env/StopWatchTest.java
b/src/test/java/org/apache/commons/scxml2/env/StopWatchTest.java
index 241743d..ec4f50a 100644
--- a/src/test/java/org/apache/commons/scxml2/env/StopWatchTest.java
+++ b/src/test/java/org/apache/commons/scxml2/env/StopWatchTest.java
@@ -26,7 +26,7 @@ public class StopWatchTest {
private StopWatch stopWatch;
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@BeforeEach
public void setUp() throws Exception {
diff --git a/src/test/java/org/apache/commons/scxml2/io/SCXMLReaderTest.java
b/src/test/java/org/apache/commons/scxml2/io/SCXMLReaderTest.java
index 166858d..56ff5af 100644
--- a/src/test/java/org/apache/commons/scxml2/io/SCXMLReaderTest.java
+++ b/src/test/java/org/apache/commons/scxml2/io/SCXMLReaderTest.java
@@ -77,7 +77,7 @@ public class SCXMLReaderTest {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@BeforeEach
public void before() {
diff --git
a/src/test/java/org/apache/commons/scxml2/model/CustomActionTest.java
b/src/test/java/org/apache/commons/scxml2/model/CustomActionTest.java
index a692a82..7fd5200 100644
--- a/src/test/java/org/apache/commons/scxml2/model/CustomActionTest.java
+++ b/src/test/java/org/apache/commons/scxml2/model/CustomActionTest.java
@@ -28,7 +28,7 @@ import org.junit.jupiter.api.Test;
public class CustomActionTest {
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@BeforeEach
public void setUp() {
diff --git a/src/test/java/org/apache/commons/scxml2/model/Hello.java
b/src/test/java/org/apache/commons/scxml2/model/Hello.java
index adf735d..4e8c4bb 100644
--- a/src/test/java/org/apache/commons/scxml2/model/Hello.java
+++ b/src/test/java/org/apache/commons/scxml2/model/Hello.java
@@ -44,7 +44,7 @@ public class Hello extends Action {
}
/**
- * Set the name.
+ * Sets the name.
*
* @param name The name to set.
*/
