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 153a33a6 Fix redundant Javadoc phrasing
153a33a6 is described below
commit 153a33a6d304a924b8197c1285a9e5afba555771
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Feb 12 11:40:23 2025 -0500
Fix redundant Javadoc phrasing
---
.../commons/scxml2/ActionExecutionContext.java | 16 +++++++--------
.../org/apache/commons/scxml2/PathResolver.java | 2 +-
.../java/org/apache/commons/scxml2/SCInstance.java | 10 ++++-----
.../commons/scxml2/SCXMLExecutionContext.java | 24 +++++++++++-----------
.../org/apache/commons/scxml2/SCXMLExecutor.java | 12 +++++------
.../apache/commons/scxml2/SCXMLSystemContext.java | 2 +-
.../apache/commons/scxml2/StateConfiguration.java | 2 +-
.../java/org/apache/commons/scxml2/Status.java | 4 ++--
.../commons/scxml2/env/AbstractStateMachine.java | 4 ++--
.../apache/commons/scxml2/env/SimpleContext.java | 2 +-
.../commons/scxml2/env/javascript/JSEvaluator.java | 2 +-
.../org/apache/commons/scxml2/io/ModelUpdater.java | 4 ++--
.../org/apache/commons/scxml2/model/Action.java | 2 +-
.../commons/scxml2/model/ActionsContainer.java | 2 +-
.../org/apache/commons/scxml2/model/Assign.java | 6 +++---
.../org/apache/commons/scxml2/model/Cancel.java | 2 +-
.../apache/commons/scxml2/model/CustomAction.java | 6 +++---
.../commons/scxml2/model/CustomActionWrapper.java | 4 ++--
.../org/apache/commons/scxml2/model/Datamodel.java | 2 +-
.../org/apache/commons/scxml2/model/ElseIf.java | 2 +-
.../commons/scxml2/model/EnterableState.java | 6 +++---
.../apache/commons/scxml2/model/Executable.java | 4 ++--
.../org/apache/commons/scxml2/model/Final.java | 4 ++--
.../org/apache/commons/scxml2/model/Finalize.java | 2 +-
.../org/apache/commons/scxml2/model/History.java | 6 +++---
.../java/org/apache/commons/scxml2/model/If.java | 4 ++--
.../org/apache/commons/scxml2/model/Initial.java | 4 ++--
.../org/apache/commons/scxml2/model/Invoke.java | 8 ++++----
.../java/org/apache/commons/scxml2/model/Log.java | 4 ++--
.../apache/commons/scxml2/model/Observable.java | 2 +-
.../org/apache/commons/scxml2/model/OnExit.java | 4 ++--
.../org/apache/commons/scxml2/model/Parallel.java | 2 +-
.../org/apache/commons/scxml2/model/Param.java | 2 +-
.../org/apache/commons/scxml2/model/Raise.java | 2 +-
.../org/apache/commons/scxml2/model/SCXML.java | 10 ++++-----
.../java/org/apache/commons/scxml2/model/Send.java | 2 +-
.../commons/scxml2/model/SimpleTransition.java | 4 ++--
.../org/apache/commons/scxml2/model/State.java | 2 +-
.../apache/commons/scxml2/model/Transition.java | 4 ++--
.../commons/scxml2/model/TransitionTarget.java | 4 ++--
.../commons/scxml2/model/TransitionalState.java | 6 +++---
.../scxml2/semantics/SCXMLSemanticsImpl.java | 4 ++--
.../org/apache/commons/scxml2/semantics/Step.java | 14 ++++++-------
.../org/apache/commons/scxml2/model/Hello.java | 2 +-
44 files changed, 108 insertions(+), 108 deletions(-)
diff --git
a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
index 1cd16840..3377626c 100644
--- a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
@@ -40,7 +40,7 @@ public class ActionExecutionContext {
}
/**
- * @return Returns the SCXML Execution Logger for the application
+ * @return the SCXML Execution Logger for the application
*/
public Log getAppLog() {
return exctx.getAppLog();
@@ -48,49 +48,49 @@ public class ActionExecutionContext {
/**
* @param state an EnterableState
- * @return Returns the context for an EnterableState
+ * @return the context for an EnterableState
*/
public Context getContext(final EnterableState state) {
return exctx.getScInstance().getContext(state);
}
/**
- * @return Returns the error reporter
+ * @return the error reporter
*/
public ErrorReporter getErrorReporter() {
return exctx.getErrorReporter();
}
/**
- * @return Returns The evaluator.
+ * @return The evaluator.
*/
public Evaluator getEvaluator() {
return exctx.getEvaluator();
}
/**
- * @return Returns the event dispatcher
+ * @return the event dispatcher
*/
public EventDispatcher getEventDispatcher() {
return exctx.getEventDispatcher();
}
/**
- * @return Returns the global context
+ * @return the global context
*/
public Context getGlobalContext() {
return exctx.getScInstance().getGlobalContext();
}
/**
- * @return Returns the I/O Processor for the internal event queue
+ * @return the I/O Processor for the internal event queue
*/
public SCXMLIOProcessor getInternalIOProcessor() {
return exctx;
}
/**
- * @return Returns the state machine
+ * @return the state machine
*/
public SCXML getStateMachine() {
return exctx.getStateMachine();
diff --git a/src/main/java/org/apache/commons/scxml2/PathResolver.java
b/src/main/java/org/apache/commons/scxml2/PathResolver.java
index b1fd91e6..7baa317b 100644
--- a/src/main/java/org/apache/commons/scxml2/PathResolver.java
+++ b/src/main/java/org/apache/commons/scxml2/PathResolver.java
@@ -26,7 +26,7 @@ public interface PathResolver {
* Gets a PathResolver rooted at this context sensitive path.
*
* @param ctxPath Context sensitive path, can be a relative URL
- * @return Returns a new resolver rooted at ctxPath
+ * @return a new resolver rooted at ctxPath
*/
PathResolver getResolver(String ctxPath);
diff --git a/src/main/java/org/apache/commons/scxml2/SCInstance.java
b/src/main/java/org/apache/commons/scxml2/SCInstance.java
index 760bd42c..2b3c0fcc 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstance.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstance.java
@@ -265,7 +265,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return Returns the current status for this instance
+ * @return the current status for this instance
*/
public Status getCurrentStatus() {
return currentStatus;
@@ -279,7 +279,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return Returns the global context, which is the top context
<em>within</em> the state machine.
+ * @return the global context, which is the top context <em>within</em>
the state machine.
*/
public Context getGlobalContext() {
if (globalContext == null) {
@@ -296,7 +296,7 @@ public class SCInstance implements Serializable {
* Gets the last configuration for this history.
*
* @param history The history.
- * @return Returns the lastConfiguration.
+ * @return the lastConfiguration.
*/
public Set<EnterableState> getLastConfiguration(final History history) {
Set<EnterableState> lastConfiguration = histories.get(history);
@@ -319,7 +319,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return Returns the state configuration for this instance
+ * @return the state configuration for this instance
*/
public StateConfiguration getStateConfiguration() {
return stateConfiguration;
@@ -409,7 +409,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return Returns if the state machine is running
+ * @return if the state machine is running
*/
public boolean isRunning() {
return running;
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index 5aaf45e3..a25bfe7a 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -231,34 +231,34 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return Returns the restricted execution context for actions
+ * @return the restricted execution context for actions
*/
public ActionExecutionContext getActionExecutionContext() {
return actionExecutionContext;
}
/**
- * @return Returns the SCXML Execution Logger for the application
+ * @return the SCXML Execution Logger for the application
*/
public Log getAppLog() {
return appLog;
}
/**
- * @return Returns the error reporter
+ * @return the error reporter
*/
public ErrorReporter getErrorReporter() {
return errorReporter;
}
/**
- * @return Returns The evaluator.
+ * @return The evaluator.
*/
public Evaluator getEvaluator() {
return evaluator;
}
/**
- * @return Returns the event dispatcher
+ * @return the event dispatcher
*/
public EventDispatcher getEventDispatcher() {
return eventdispatcher;
@@ -273,7 +273,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return Returns the map of current active Invokes and their invokeId
+ * @return the map of current active Invokes and their invokeId
*/
public Map<Invoke, String> getInvokeIds() {
return invokeIds;
@@ -293,14 +293,14 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return Returns the notification registry
+ * @return the notification registry
*/
public NotificationRegistry getNotificationRegistry() {
return notificationRegistry;
}
/**
- * @return Returns the SCInstance
+ * @return the SCInstance
*/
public SCInstance getScInstance() {
return scInstance;
@@ -311,14 +311,14 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return Returns the state machine
+ * @return the state machine
*/
public SCXML getStateMachine() {
return scInstance.getStateMachine();
}
/**
- * @return Returns true if the internal event queue isn't empty
+ * @return true if the internal event queue isn't empty
*/
public boolean hasPendingInternalEvent() {
return !internalEventQueue.isEmpty();
@@ -368,7 +368,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return Returns true if this state machine is running
+ * @return true if this state machine is running
*/
public boolean isRunning() {
return scInstance.isRunning();
@@ -396,7 +396,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return Returns the next event from the internal event queue, if
available
+ * @return the next event from the internal event queue, if available
*/
public TriggerEvent nextInternalEvent() {
return internalEventQueue.poll();
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
index 79cf696a..f12624f7 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
@@ -183,7 +183,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Gets the environment specific error reporter.
*
- * @return Returns the errorReporter.
+ * @return the errorReporter.
*/
public ErrorReporter getErrorReporter() {
return exctx.getErrorReporter();
@@ -201,7 +201,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Gets the event dispatcher.
*
- * @return Returns the eventdispatcher.
+ * @return the eventdispatcher.
*/
public EventDispatcher getEventdispatcher() {
return exctx.getEventDispatcher();
@@ -244,7 +244,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * @return Returns the current number of pending external events to be
processed.
+ * @return the current number of pending external events to be processed.
*/
public int getPendingEvents() {
return externalEventQueue.size();
@@ -281,7 +281,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* manipulation of any {@link org.apache.commons.scxml2.model.Datamodel}s
associated with this state
* machine definition.
*
- * @return Returns the stateMachine.
+ * @return the stateMachine.
*/
public SCXML getStateMachine() {
return exctx.getStateMachine();
@@ -320,7 +320,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * @return Returns true if there are pending external events to be
processed.
+ * @return true if there are pending external events to be processed.
*/
public boolean hasPendingEvents() {
return !externalEventQueue.isEmpty();
@@ -334,7 +334,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * @return Returns true if the state machine is running
+ * @return true if the state machine is running
*/
public boolean isRunning() {
return exctx.isRunning();
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
index 19a4458c..ec40665c 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
@@ -93,7 +93,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
}
/**
- * @return Returns the wrapped (modifiable) system context
+ * @return the wrapped (modifiable) system context
*/
Context getContext() {
return systemContext;
diff --git a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
index aee592a7..43c7beaa 100644
--- a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
+++ b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
@@ -91,7 +91,7 @@ public class StateConfiguration implements Serializable {
/**
* Gets the current atomic states (leaf only).
*
- * @return Returns the atomic states - simple (leaf) states only.
+ * @return the atomic states - simple (leaf) states only.
*/
public Set<EnterableState> getStates() {
return atomicStatesSet;
diff --git a/src/main/java/org/apache/commons/scxml2/Status.java
b/src/main/java/org/apache/commons/scxml2/Status.java
index 7603a676..08971ce7 100644
--- a/src/main/java/org/apache/commons/scxml2/Status.java
+++ b/src/main/java/org/apache/commons/scxml2/Status.java
@@ -49,7 +49,7 @@ public class Status implements Serializable {
}
/**
- * @return Returns the single top level final state in which the state
machine terminated, or null otherwise
+ * @return the single top level final state in which the state machine
terminated, or null otherwise
*/
public Final getFinalState() {
if (configuration.getStates().size() == 1) {
@@ -64,7 +64,7 @@ public class Status implements Serializable {
/**
* Gets the atomic states configuration (leaf only).
*
- * @return Returns the atomic states configuration - simple (leaf) states
only.
+ * @return the atomic states configuration - simple (leaf) states only.
*/
public Set<EnterableState> getStates() {
return configuration.getStates();
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 d3ce9792..aeb49ae1 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 {
* Gets the SCXML engine driving the "lifecycle" of the
* instances of this class.
*
- * @return Returns the engine.
+ * @return the engine.
*/
public SCXMLExecutor getEngine() {
return engine;
@@ -231,7 +231,7 @@ public abstract class AbstractStateMachine {
/**
* Gets the log for this class.
*
- * @return Returns the log.
+ * @return the log.
*/
public Log getLog() {
return log;
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 e18de1ac..2f8f1926 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
@@ -126,7 +126,7 @@ public class SimpleContext implements Context, Serializable
{
/**
* Gets the Map of all local variables in this Context.
*
- * @return Returns the vars.
+ * @return the vars.
*/
@Override
public Map<String, Object> getVars() {
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 782e0596..f6f2934c 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
@@ -287,7 +287,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
/**
* Creates a child context.
*
- * @return Returns a new child JSContext.
+ * @return a new child JSContext.
*/
@Override
public Context newContext(final Context parent) {
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 e42de51c..10ce70e3 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
@@ -147,7 +147,7 @@ final class ModelUpdater {
* 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 Returns the next to be used order value
+ * @return the next to be used order value
*/
private static int initDocumentOrder(final List<EnterableState> states,
int nextOrder) {
for (final EnterableState state : states) {
@@ -168,7 +168,7 @@ final class ModelUpdater {
* 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 Returns the next to be used observable id sequence value
+ * @return the next to be used observable id sequence value
*/
private static int initObservables(final List<EnterableState>states, int
nextObservableId) {
for (final EnterableState es : states) {
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 4d5f281a..2f53d1c5 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Action.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Action.java
@@ -55,7 +55,7 @@ public abstract class Action implements Serializable {
/**
* Gets the Executable parent.
*
- * @return Returns the parent.
+ * @return the parent.
*/
public Executable getParent() {
return parent;
diff --git
a/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
b/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
index 826c8e17..3a6c0b44 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
@@ -34,7 +34,7 @@ public interface ActionsContainer {
/**
* Gets the executable actions contained in this <container>.
*
- * @return Returns the actions.
+ * @return the actions.
*/
List<Action> getActions();
}
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 9063c89c..fb0434fc 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Assign.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Assign.java
@@ -90,7 +90,7 @@ public class Assign extends Action implements
ParsedValueContainer {
/**
* Gets the expr that will evaluate to the new value.
*
- * @return Returns the expr.
+ * @return the expr.
*/
public String getExpr() {
return expr;
@@ -99,7 +99,7 @@ public class Assign extends Action implements
ParsedValueContainer {
/**
* Gets the location for a previously defined XML data tree.
*
- * @return Returns the location.
+ * @return the location.
*/
public String getLocation() {
return location;
@@ -118,7 +118,7 @@ public class Assign extends Action implements
ParsedValueContainer {
/**
* Gets the source where the new XML instance for this location exists.
*
- * @return Returns the source.
+ * @return the source.
*/
public String getSrc() {
return src;
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 4c01cf52..f0b48aec 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Cancel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Cancel.java
@@ -73,7 +73,7 @@ public class Cancel extends Action {
/**
* Gets the ID of the send message that should be cancelled.
*
- * @return Returns the sendid.
+ * @return the sendid.
*/
public String getSendid() {
return sendid;
diff --git a/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
b/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
index dbbf36b7..df2f97fb 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
@@ -114,7 +114,7 @@ public class CustomAction {
/**
* Gets this custom action's implementation.
*
- * @return Returns the action class.
+ * @return the action class.
*/
public Class<? extends Action> getActionClass() {
return actionClass;
@@ -123,7 +123,7 @@ public class CustomAction {
/**
* Gets the local name for this custom action.
*
- * @return Returns the local name.
+ * @return the local name.
*/
public String getLocalName() {
return localName;
@@ -132,7 +132,7 @@ public class CustomAction {
/**
* Gets the namespace URI for this custom action.
*
- * @return Returns the namespace URI.
+ * @return the namespace URI.
*/
public String getNamespaceURI() {
return namespaceURI;
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 52467749..7ef4e27c 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
@@ -65,7 +65,7 @@ public class CustomActionWrapper extends Action {
/**
* Gets the attributes defined on the custom action element
*
- * @return Returns the map of attributes.
+ * @return the map of attributes.
*/
public final Map<String, String> getAttributes() {
return attributes;
@@ -81,7 +81,7 @@ public class CustomActionWrapper extends Action {
/**
* Gets the custom XML namespaces in effect for this custom action
*
- * @return Returns the map of namespaces.
+ * @return the map of namespaces.
*/
public final Map<String, String> getNamespaces() {
return namespaces;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
b/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
index a35c648a..18b53b6b 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
@@ -58,7 +58,7 @@ public class Datamodel implements Serializable {
/**
* Gets all the data children of this datamodel.
*
- * @return Returns the data.
+ * @return the data.
*/
public final List<Data> getData() {
return data;
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 37afd93f..d8aed86c 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
@@ -52,7 +52,7 @@ public class ElseIf extends Action {
/**
* Gets the conditional expression.
*
- * @return Returns the cond.
+ * @return the cond.
*/
public final String getCond() {
return cond;
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 6dcc1028..9d1ded4a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
@@ -69,7 +69,7 @@ public abstract class EnterableState extends TransitionTarget
implements Documen
/**
* Gets the OnEntry elements.
*
- * @return Returns the onEntry elements
+ * @return the onEntry elements
*/
public final List<OnEntry> getOnEntries() {
return onEntries;
@@ -78,7 +78,7 @@ public abstract class EnterableState extends TransitionTarget
implements Documen
/**
* Gets the OnExit elements
*
- * @return Returns the onExit elements
+ * @return the onExit elements
*/
public final List<OnExit> getOnExits() {
return onExits;
@@ -98,7 +98,7 @@ 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 Returns true if this is an atomic state.
+ * @return true if this is an atomic state.
*/
public abstract boolean isAtomicState();
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 b4640943..0e1b2869 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Executable.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Executable.java
@@ -59,7 +59,7 @@ public abstract class Executable implements Serializable {
/**
* Gets the executable actions contained in this Executable.
*
- * @return Returns the actions.
+ * @return the actions.
*/
public final List<Action> getActions() {
return actions;
@@ -68,7 +68,7 @@ public abstract class Executable implements Serializable {
/**
* Gets the EnterableState parent.
*
- * @return Returns the parent.
+ * @return the parent.
*/
public EnterableState getParent() {
return parent;
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 ac593a00..bbf10139 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Final.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Final.java
@@ -53,7 +53,7 @@ public class Final extends EnterableState {
}
/**
- * @return Returns the State parent
+ * @return the State parent
*/
@Override
public State getParent() {
@@ -62,7 +62,7 @@ public class Final extends EnterableState {
/**
* {@inheritDoc}
- * @return Returns always true (a state of type Final is always atomic)
+ * @return always true (a state of type Final is always atomic)
*/
@Override
public final boolean isAtomicState() {
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 3d03ba41..1043382a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Finalize.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Finalize.java
@@ -34,7 +34,7 @@ public class Finalize extends Executable {
}
/**
- * @return Returns the TransitionalState parent
+ * @return the TransitionalState parent
*/
@Override
public TransitionalState getParent() {
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 9e9e8346..0b43ef1b 100644
--- a/src/main/java/org/apache/commons/scxml2/model/History.java
+++ b/src/main/java/org/apache/commons/scxml2/model/History.java
@@ -46,7 +46,7 @@ public class History extends TransitionTarget {
}
/**
- * @return Returns the TransitionalState parent
+ * @return the TransitionalState parent
*/
@Override
public TransitionalState getParent() {
@@ -56,7 +56,7 @@ public class History extends TransitionTarget {
/**
* Gets the transition.
*
- * @return Returns the transition.
+ * @return the transition.
*/
public final SimpleTransition getTransition() {
return transition;
@@ -65,7 +65,7 @@ public class History extends TransitionTarget {
/**
* Is this history "deep" (as against "shallow").
*
- * @return Returns whether this is a "deep" history
+ * @return whether this is a "deep" history
*/
public final boolean isDeep() {
return isDeep;
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 90f7b934..580f342f 100644
--- a/src/main/java/org/apache/commons/scxml2/model/If.java
+++ b/src/main/java/org/apache/commons/scxml2/model/If.java
@@ -121,7 +121,7 @@ public class If extends Action implements ActionsContainer {
/**
* Gets the executable actions contained in this <if>.
*
- * @return Returns the actions.
+ * @return the actions.
*/
@Override
public final List<Action> getActions() {
@@ -131,7 +131,7 @@ public class If extends Action implements ActionsContainer {
/**
* Gets the conditional expression.
*
- * @return Returns the cond.
+ * @return the cond.
*/
public final String getCond() {
return cond;
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 2ccadb14..552bcbe4 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Initial.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Initial.java
@@ -55,7 +55,7 @@ public class Initial implements Serializable {
/**
* Gets the parent State.
*
- * @return Returns the parent state
+ * @return the parent state
*/
public final State getParent() {
return parent;
@@ -64,7 +64,7 @@ public class Initial implements Serializable {
/**
* Gets the initial transition.
*
- * @return Returns the transition.
+ * @return the transition.
*/
public final SimpleTransition getTransition() {
return transition;
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 314c33c1..d5a4564a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
@@ -234,7 +234,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * @return Returns the flag indicating whether to forward events to the
invoked process.
+ * @return the flag indicating whether to forward events to the invoked
process.
*/
public final Boolean getAutoForward() {
return autoForward;
@@ -269,7 +269,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Gets the identifier for this invoke (may be null).
*
- * @return Returns the id.
+ * @return the id.
*/
public final String getId() {
return id;
@@ -304,7 +304,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Gets the parent EnterableState.
*
- * @return Returns the parent state
+ * @return the parent state
*/
@Override
public EnterableState getParentEnterableState() {
@@ -356,7 +356,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * @return Returns true if all external events should be forwarded to the
invoked process.
+ * @return true if all external events should be forwarded to the invoked
process.
*/
public final boolean isAutoForward() {
return autoForward != null && autoForward;
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 04bece46..f2aaf645 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Log.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Log.java
@@ -62,7 +62,7 @@ public class Log extends Action {
/**
* Gets the log expression.
*
- * @return Returns the expression.
+ * @return the expression.
*/
public final String getExpr() {
return expr;
@@ -71,7 +71,7 @@ public class Log extends Action {
/**
* Gets the log label.
*
- * @return Returns the label.
+ * @return the label.
*/
public final String getLabel() {
return label;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Observable.java
b/src/main/java/org/apache/commons/scxml2/model/Observable.java
index 27ee1f71..76f515e3 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Observable.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Observable.java
@@ -27,7 +27,7 @@ package org.apache.commons.scxml2.model;
public interface Observable {
/**
- * @return Returns the id for this Observable which is unique within the
SCXML state machine
+ * @return the id for this Observable which is unique within the SCXML
state machine
*/
Integer getObservableId();
}
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 fcb977be..42563eee 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 {
}
/**
- * @return Returns the indicator whether to raise the non-standard
"exit.state.id" internal event after executing
+ * @return the indicator whether to raise the non-standard "exit.state.id"
internal event after executing
* this OnExit. When null no event will be raised
*/
public final Boolean getRaiseEvent() {
@@ -49,7 +49,7 @@ public class OnExit extends Executable {
}
/**
- * @return Returns true if the non-standard internal "exit.state.id" event
will be raised after executing this OnExit
+ * @return true if the non-standard internal "exit.state.id" event will be
raised after executing this OnExit
*/
public final boolean isRaiseEvent() {
return raiseEvent != null && 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 43e9ed8f..ad08356e 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Parallel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Parallel.java
@@ -46,7 +46,7 @@ public class Parallel extends TransitionalState {
}
/**
* {@inheritDoc}
- * @return Returns always false (a state of type Parallel is never atomic)
+ * @return always false (a state of type Parallel is never atomic)
*/
@Override
public final boolean isAtomicState() {
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 e546d7d0..bf1e2b46 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Param.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Param.java
@@ -64,7 +64,7 @@ public class Param implements Serializable {
/**
* Gets the location for a previously defined XML data tree.
*
- * @return Returns the location.
+ * @return the location.
*/
public String getLocation() {
return location;
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 00d7a3c7..481406e8 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Raise.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Raise.java
@@ -62,7 +62,7 @@ public class Raise extends Action {
/**
* Gets the event.
*
- * @return Returns the event.
+ * @return the event.
*/
public final String getEvent() {
return event;
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 93f2a96c..b54b65bd 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
@@ -174,7 +174,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the data model placed at document root.
*
- * @return Returns the data model.
+ * @return the data model.
*/
public final Datamodel getDatamodel() {
return datamodel;
@@ -200,7 +200,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the first immediate child of the SCXML root. Return null if
there's no child.
*
- * @return Returns the first immediate child of the SCXML root. Return
null if there's no child.
+ * @return the first immediate child of the SCXML root. Return null if
there's no child.
* @since 2.0
*/
public final EnterableState getFirstChild() {
@@ -227,7 +227,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the initial Transition.
*
- * @return Returns the initial transition for this state machine.
+ * @return the initial transition for this state machine.
* @since 2.0
*/
public final SimpleTransition getInitialTransition() {
@@ -265,7 +265,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the {@link PathResolver}.
*
- * @return Returns the pathResolver.
+ * @return the pathResolver.
*/
public PathResolver getPathResolver() {
return pathResolver;
@@ -293,7 +293,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the SCXML document version.
*
- * @return Returns the version.
+ * @return the version.
*/
public final String getVersion() {
return version;
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 52f37a96..d4ed6c81 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Send.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Send.java
@@ -303,7 +303,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
/**
* Gets the delay.
*
- * @return Returns the delay.
+ * @return the delay.
*/
public final String getDelay() {
return delay;
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 381e7de2..59d4b123 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
@@ -101,7 +101,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Gets the TransitionalState (State or Parallel) parent.
*
- * @return Returns the parent.
+ * @return the parent.
*/
@Override
public TransitionalState getParent() {
@@ -111,7 +111,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Gets the set of transition targets (may be an empty list).
*
- * @return Returns the target(s) as specified in SCXML markup.
+ * @return the target(s) as specified in SCXML markup.
* <p>Remarks: Is <code>empty</code> for "stay" transitions.
*
* @since 0.7
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 9a8bf74a..e1733d06 100644
--- a/src/main/java/org/apache/commons/scxml2/model/State.java
+++ b/src/main/java/org/apache/commons/scxml2/model/State.java
@@ -73,7 +73,7 @@ public class State extends TransitionalState {
/**
* {@inheritDoc}
- * @return Returns true if this State has no children
+ * @return true if this State has no children
*/
@Override
public final boolean isAtomicState() {
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 bbcbf899..dd6b5af6 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Transition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Transition.java
@@ -68,7 +68,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
/**
* Gets the guard condition (may be null).
*
- * @return Returns the cond.
+ * @return the cond.
*/
public String getCond() {
return cond;
@@ -78,7 +78,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
* Gets the event that will trigger this transition (pending
* evaluation of the guard condition in favor).
*
- * @return Returns the event.
+ * @return the event.
*/
public String getEvent() {
return event;
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 0a94a8ea..af4f1cf2 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
@@ -74,7 +74,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Gets the identifier for this transition target (may be null).
*
- * @return Returns the id.
+ * @return the id.
*/
public final String getId() {
return id;
@@ -98,7 +98,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Gets the parent TransitionTarget.
*
- * @return Returns the parent state
+ * @return the parent state
* (null if parent is <scxml> element)
*/
public EnterableState getParent() {
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 da2dbe0c..b9b165f7 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
@@ -117,7 +117,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the set of child transition targets (may be empty).
*
- * @return Returns the children.
+ * @return the children.
* @since 0.7
*/
public final List<EnterableState> getChildren() {
@@ -127,7 +127,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the data model for this transition target.
*
- * @return Returns the data model.
+ * @return the data model.
*/
public final Datamodel getDatamodel() {
return datamodel;
@@ -157,7 +157,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the TransitionalState (State or Parallel) parent.
*
- * @return Returns the parent.
+ * @return the parent.
*/
@Override
public TransitionalState getParent() {
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 f85a55e3..a47fa3b3 100644
--- a/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
+++ b/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
@@ -263,7 +263,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
}
/**
- * @return Returns true if no member of the provided states set is a
descendant of the provided state.
+ * @return true if no member of the provided states set is a descendant of
the provided state.
* @param states the set of states to check for descendants
* @param state the state to check with
*/
@@ -727,7 +727,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* @param exctx The execution context for this step
* @param transition The transition
* @param eventName The (optional) event name to match against
- * @return Returns true if the transition matches against the provided
eventName, or is event-less when no eventName
+ * @return true if the transition matches against the provided eventName,
or is event-less when no eventName
* is provided, <em>AND</em> its (optional) condition guard
evaluates to true.
*/
public boolean matchTransition(final SCXMLExecutionContext exctx, final
Transition transition, final String eventName) {
diff --git a/src/main/java/org/apache/commons/scxml2/semantics/Step.java
b/src/main/java/org/apache/commons/scxml2/semantics/Step.java
index b0891948..e5d6024d 100644
--- a/src/main/java/org/apache/commons/scxml2/semantics/Step.java
+++ b/src/main/java/org/apache/commons/scxml2/semantics/Step.java
@@ -94,49 +94,49 @@ public class Step {
}
/**
- * @return Returns the defaultEntrySet.
+ * @return the defaultEntrySet.
*/
public Set<EnterableState> getDefaultEntrySet() {
return defaultEntrySet;
}
/**
- * @return Returns the map of default History transitions to be executed
as result of entering states in this step
+ * @return the map of default History transitions to be executed as result
of entering states in this step
*/
public Map<TransitionalState, SimpleTransition>
getDefaultHistoryTransitions() {
return defaultHistoryTransitions;
}
/**
- * @return Returns the entrySet.
+ * @return the entrySet.
*/
public Set<EnterableState> getEntrySet() {
return entrySet;
}
/**
- * @return Returns the current event.
+ * @return the current event.
*/
public TriggerEvent getEvent() {
return event;
}
/**
- * @return Returns the exitSet.
+ * @return the exitSet.
*/
public Set<EnterableState> getExitSet() {
return exitSet;
}
/**
- * @return Returns the map of new History configurations created as result
of exiting states in this step
+ * @return the map of new History configurations created as result of
exiting states in this step
*/
public Map<History, Set<EnterableState>> getNewHistoryConfigurations() {
return newHistoryConfigurations;
}
/**
- * @return Returns the transitList.
+ * @return the transitList.
*/
public List<SimpleTransition> getTransitList() {
return transitList;
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 93e7da30..8828adf0 100644
--- a/src/test/java/org/apache/commons/scxml2/model/Hello.java
+++ b/src/test/java/org/apache/commons/scxml2/model/Hello.java
@@ -48,7 +48,7 @@ public class Hello extends Action {
/**
* Gets the name.
*
- * @return Returns the name.
+ * @return the name.
*/
public String getName() {
return name;
