You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/01/04 20:41:05 UTC
(commons-scxml) 02/02: Javadoc
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
commit 7bda233df367054ce10d5b7991038c9031e6ca82
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jan 4 15:40:57 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java | 2 ++
src/main/java/org/apache/commons/scxml2/StateConfiguration.java | 1 +
src/main/java/org/apache/commons/scxml2/TriggerEvent.java | 1 +
src/main/java/org/apache/commons/scxml2/env/SimpleContext.java | 3 +++
src/main/java/org/apache/commons/scxml2/env/SimpleErrorHandler.java | 2 ++
src/main/java/org/apache/commons/scxml2/env/SimpleErrorReporter.java | 1 +
src/main/java/org/apache/commons/scxml2/env/SimpleSCXMLListener.java | 1 +
src/main/java/org/apache/commons/scxml2/env/Tracer.java | 4 ++++
src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java | 1 +
.../java/org/apache/commons/scxml2/invoke/SimpleSCXMLInvoker.java | 4 ++++
src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java | 1 +
src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java | 4 ++++
src/main/java/org/apache/commons/scxml2/model/Assign.java | 1 +
src/main/java/org/apache/commons/scxml2/model/Parallel.java | 1 +
src/main/java/org/apache/commons/scxml2/model/Param.java | 1 +
15 files changed, 28 insertions(+)
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index b8c2ad08..55b1d776 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -44,6 +44,7 @@ public class SCXMLExecutionContext implements SCXMLIOProcessor {
* Default and required supported SCXML Processor Invoker service URI
*/
public static final String SCXML_INVOKER_TYPE_URI = "http://www.w3.org/TR/scxml/";
+
/**
* Alias for {@link #SCXML_INVOKER_TYPE_URI}
*/
@@ -253,6 +254,7 @@ public class SCXMLExecutionContext implements SCXMLIOProcessor {
public ErrorReporter getErrorReporter() {
return errorReporter;
}
+
/**
* @return The evaluator.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
index 41b3d0e8..1b0a99fa 100644
--- a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
+++ b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
@@ -27,6 +27,7 @@ import org.apache.commons.scxml2.model.EnterableState;
* The current active states of a state machine
*/
public class StateConfiguration implements Serializable {
+
/**
* Serial version UID.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/TriggerEvent.java b/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
index d74c95a5..83b02e4d 100644
--- a/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
+++ b/src/main/java/org/apache/commons/scxml2/TriggerEvent.java
@@ -104,6 +104,7 @@ public class TriggerEvent implements Serializable {
private final String originType;
private final String invokeId;
private final Object data;
+
/**
* Constructs a new instance.
*
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 a95f48fa..aa4bc345 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
@@ -32,10 +32,13 @@ public class SimpleContext implements Context, Serializable {
/** Serial version UID. */
private static final long serialVersionUID = 1L;
+
/** Implementation independent log category. */
private static final Log log = LogFactory.getLog(Context.class);
+
/** The parent Context to this Context. */
private final Context parent;
+
/** The Map of variables and their values in this Context. */
private Map<String, Object> vars;
diff --git a/src/main/java/org/apache/commons/scxml2/env/SimpleErrorHandler.java b/src/main/java/org/apache/commons/scxml2/env/SimpleErrorHandler.java
index 56212c79..248cce36 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleErrorHandler.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleErrorHandler.java
@@ -31,8 +31,10 @@ public class SimpleErrorHandler implements ErrorHandler, Serializable {
/** Serial version UID. */
private static final long serialVersionUID = 1L;
+
/** Message prefix. */
private static final String MSG_PREFIX = "SCXML SAX Parsing: ";
+
/** Message postfix. */
private static final String MSG_POSTFIX = " Correct the SCXML document.";
diff --git a/src/main/java/org/apache/commons/scxml2/env/SimpleErrorReporter.java b/src/main/java/org/apache/commons/scxml2/env/SimpleErrorReporter.java
index 224f9bb3..e4921930 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleErrorReporter.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleErrorReporter.java
@@ -39,6 +39,7 @@ public class SimpleErrorReporter implements ErrorReporter, Serializable {
/** Serial version UID. */
private static final long serialVersionUID = 1L;
+
/** Log. */
private static final Log log = LogFactory.getLog(SimpleErrorReporter.class);
diff --git a/src/main/java/org/apache/commons/scxml2/env/SimpleSCXMLListener.java b/src/main/java/org/apache/commons/scxml2/env/SimpleSCXMLListener.java
index 7ba4f5cc..1972fb62 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleSCXMLListener.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleSCXMLListener.java
@@ -32,6 +32,7 @@ public class SimpleSCXMLListener implements SCXMLListener, Serializable {
/** Serial version UID. */
private static final long serialVersionUID = 1L;
+
/** Log. */
private static final Log log = LogFactory.getLog(SimpleSCXMLListener.class);
diff --git a/src/main/java/org/apache/commons/scxml2/env/Tracer.java b/src/main/java/org/apache/commons/scxml2/env/Tracer.java
index 195e1d7e..bb466caf 100644
--- a/src/main/java/org/apache/commons/scxml2/env/Tracer.java
+++ b/src/main/java/org/apache/commons/scxml2/env/Tracer.java
@@ -39,12 +39,16 @@ public class Tracer implements ErrorHandler, ErrorReporter,
/** Serial version UID. */
private static final long serialVersionUID = 1L;
+
/** ErrorHandler delegate. */
private final ErrorHandler errHandler;
+
/** ErrorReporter delegate. */
private final ErrorReporter errReporter;
+
/** SCXMLListener delegate. */
private final SCXMLListener scxmlListener;
+
/** XMLReporter delegate. */
private final XMLReporter xmlReporter;
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 a2f02dd7..0221df48 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
@@ -22,6 +22,7 @@ import org.apache.commons.scxml2.Builtin;
* Global JEXL namespace functor, providing the standard SCXML In() predicate.
*/
public final class JexlBuiltin {
+
/**
* The context currently in use for evaluation.
*/
diff --git a/src/main/java/org/apache/commons/scxml2/invoke/SimpleSCXMLInvoker.java b/src/main/java/org/apache/commons/scxml2/invoke/SimpleSCXMLInvoker.java
index 222e870c..c9442e1d 100644
--- a/src/main/java/org/apache/commons/scxml2/invoke/SimpleSCXMLInvoker.java
+++ b/src/main/java/org/apache/commons/scxml2/invoke/SimpleSCXMLInvoker.java
@@ -41,12 +41,16 @@ public class SimpleSCXMLInvoker implements Invoker, Serializable {
/** Serial version UID. */
private static final long serialVersionUID = 1L;
+
/** InvokeId ID. */
private String invokeId;
+
/** Invoking parent SCXMLExecutor */
private SCXMLExecutor parentSCXMLExecutor;
+
/** The invoked state machine executor. */
private SCXMLExecutor executor;
+
/** Cancellation status. */
private boolean canceled;
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 6b9f0c24..41c1cd30 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
@@ -296,6 +296,7 @@ final class ModelUpdater {
/*
* Post-processing methods to make the SCXML object SCXMLExecutor ready.
*/
+
/**
* <p>Update the SCXML object model and make it SCXMLExecutor ready.
* This is part of post-read processing, and sets up the necessary
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 522c62f4..54edc65f 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -225,6 +225,7 @@ public final class SCXMLReader {
/*
* Public constructors
*/
+
/**
* Default constructor.
*/
@@ -384,6 +385,7 @@ public final class SCXMLReader {
/*
* Package access constructors
*/
+
/**
* Convenience package access constructor.
*
@@ -810,6 +812,7 @@ public final class SCXMLReader {
/*
* Public methods
*/
+
/**
* Parse the SCXML document at the supplied path.
*
@@ -1238,6 +1241,7 @@ public final class SCXMLReader {
/*
* Private utility functions for reading the SCXML document.
*/
+
/**
* Reads the SCXML document through the {@link XMLStreamReader}.
*
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 6b94835a..300ea2cd 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Assign.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Assign.java
@@ -151,6 +151,7 @@ public class Assign extends Action implements ParsedValueContainer {
public final void setParsedValue(final ParsedValue assignValue) {
this.assignValue = assignValue;
}
+
/**
* Sets the source where the new XML instance for this location exists.
*
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 8546a3aa..af1251cd 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Parallel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Parallel.java
@@ -45,6 +45,7 @@ public class Parallel extends TransitionalState {
public final void addChild(final TransitionalState ts) {
super.addChild(ts);
}
+
/**
* {@inheritDoc}
*
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 cabf8053..de48da8d 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Param.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Param.java
@@ -52,6 +52,7 @@ public class Param implements Serializable {
name = null;
expr = null;
}
+
/**
* Gets the expression for this param value.
*