You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ra...@apache.org on 2007/12/12 21:35:23 UTC
svn commit: r603728 - in
/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml: ./ env/
io/ model/
Author: rahul
Date: Wed Dec 12 12:35:21 2007
New Revision: 603728
URL: http://svn.apache.org/viewvc?rev=603728&view=rev
Log:
Non-functional changes. Primarily adding since tags (also removing a done TODO and moving a method to a more appropriate place in the source file).
Modified:
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/SCInstance.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractSCXMLListener.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractStateMachine.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Event.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Final.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Parallel.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/SCXML.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/State.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Transition.java
commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/TransitionTarget.java
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/SCInstance.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/SCInstance.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/SCInstance.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/SCInstance.java Wed Dec 12 12:35:21 2007
@@ -369,6 +369,8 @@
*
* @param transitionTarget The <code>TransitionTarget</code>.
* @return The completion status.
+ *
+ * @since 0.7
*/
public boolean isDone(final TransitionTarget transitionTarget) {
Boolean done = (Boolean) completions.get(transitionTarget);
@@ -385,6 +387,8 @@
*
* @param transitionTarget The TransitionTarget.
* @param done The completion status.
+ *
+ * @since 0.7
*/
public void setDone(final TransitionTarget transitionTarget,
final boolean done) {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractSCXMLListener.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractSCXMLListener.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractSCXMLListener.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractSCXMLListener.java Wed Dec 12 12:35:21 2007
@@ -24,6 +24,8 @@
* An abstract adapter class for the <code>SXCMLListener</code> interface.
* This class exists as a convenience for creating listener objects, and as
* such all the methods in this class are empty.
+ *
+ * @since 0.7
*/
public abstract class AbstractSCXMLListener implements SCXMLListener {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractStateMachine.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractStateMachine.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractStateMachine.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/env/AbstractStateMachine.java Wed Dec 12 12:35:21 2007
@@ -138,6 +138,8 @@
* @param stateMachine The parsed SCXML instance that
* describes the "lifecycle" of the
* instances of this class.
+ *
+ * @since 0.7
*/
public AbstractStateMachine(final SCXML stateMachine) {
// default is JEXL
@@ -155,6 +157,8 @@
*
* @see Context
* @see Evaluator
+ *
+ * @since 0.7
*/
public AbstractStateMachine(final SCXML stateMachine,
final Context rootCtx, final Evaluator evaluator) {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/io/SCXMLParser.java Wed Dec 12 12:35:21 2007
@@ -98,6 +98,8 @@
* <li><event> is now supported</li>
* </ul>
* <p>See latest version of the SCXML Working Draft for more details.</p>
+ *
+ * @since 0.7
*/
public final class SCXMLParser {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Event.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Event.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Event.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Event.java Wed Dec 12 12:35:21 2007
@@ -29,6 +29,7 @@
* The class in this SCXML object model that corresponds to the
* <event> SCXML element.
*
+ * @since 0.7
*/
public class Event extends Action {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Final.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Final.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Final.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Final.java Wed Dec 12 12:35:21 2007
@@ -20,7 +20,7 @@
* The class in this SCXML object model that corresponds to the
* <final> SCXML element.
*
- * TODO: Re-evaluate if we need this before v0.7 release.
+ * @since 0.7
*/
public class Final extends State {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Parallel.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Parallel.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Parallel.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Parallel.java Wed Dec 12 12:35:21 2007
@@ -77,6 +77,8 @@
* Get the set of child transition targets (may be empty).
*
* @return Set Returns the children.
+ *
+ * @since 0.7
*/
public final Set getChildren() {
return children;
@@ -86,6 +88,8 @@
* Add a child.
*
* @param tt A child transition target.
+ *
+ * @since 0.7
*/
public final void addChild(final TransitionTarget tt) {
// TODO: State is a sufficient enough type for the parameter
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/SCXML.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/SCXML.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/SCXML.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/SCXML.java Wed Dec 12 12:35:21 2007
@@ -118,6 +118,8 @@
* Get the initial TransitionTarget.
*
* @return Returns the initial target for this state machine.
+ *
+ * @since 0.7
*/
public final TransitionTarget getInitialTarget() {
return initialTarget;
@@ -127,6 +129,8 @@
* Set the initial TransitionTarget.
*
* @param initialTarget The initial target to set.
+ *
+ * @since 0.7
*/
public final void setInitialTarget(final TransitionTarget initialTarget) {
this.initialTarget = initialTarget;
@@ -176,6 +180,8 @@
* Get the immediate child targets of the SCXML root.
*
* @return Map Returns map of the child targets.
+ *
+ * @since 0.7
*/
public final Map getChildren() {
return children;
@@ -185,6 +191,8 @@
* Add an immediate child target of the SCXML root.
*
* @param tt The transition target to be added to the states Map.
+ *
+ * @since 0.7
*/
public final void addChild(final TransitionTarget tt) {
children.put(tt.getId(), tt);
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/State.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/State.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/State.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/State.java Wed Dec 12 12:35:21 2007
@@ -102,15 +102,6 @@
}
/**
- * Is this state a "final" state.
- *
- * @return boolean Returns the isFinal.
- */
- public final boolean isFinal() {
- return isFinal;
- }
-
- /**
* Set whether this is a "final" state.
*
* @param isFinal
@@ -122,10 +113,23 @@
}
/**
+ * Is this state a "final" state.
+ *
+ * @return boolean Returns the isFinal.
+ *
+ * @since 0.7
+ */
+ public final boolean isFinal() {
+ return isFinal;
+ }
+
+ /**
* Set whether this is a "final" state.
*
* @param isFinal
* The isFinal to set.
+ *
+ * @since 0.7
*/
public final void setFinal(final boolean isFinal) {
this.isFinal = isFinal;
@@ -278,6 +282,8 @@
*
* @param tt
* a child transition target
+ *
+ * @since 0.7
*/
public final void addChild(final TransitionTarget tt) {
this.children.put(tt.getId(), tt);
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Transition.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Transition.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Transition.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/Transition.java Wed Dec 12 12:35:21 2007
@@ -159,6 +159,8 @@
* @return Returns the target(s) as specified in SCXML markup.
* <p>Remarks: Is <code>empty</code> for "stay" transitions.
* Contains parent (the source node) for "self" transitions.</p>
+ *
+ * @since 0.7
*/
public final List getTargets() {
return targets;
@@ -188,6 +190,8 @@
* <p>Remarks: For both the "stay" and "self"
* transitions it returns parent (the source node). This method should
* never return an empty list or <code>null</code>.</p>
+ *
+ * @since 0.7
*/
public final List getRuntimeTargets() {
if (targets.size() == 0) {
@@ -245,6 +249,8 @@
*
* @see Path
* @return List returns the list of transition path(s)
+ *
+ * @since 0.7
*/
public final List getPaths() {
if (paths.size() == 0) {
Modified: commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/TransitionTarget.java
URL: http://svn.apache.org/viewvc/commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/TransitionTarget.java?rev=603728&r1=603727&r2=603728&view=diff
==============================================================================
--- commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/TransitionTarget.java (original)
+++ commons/proper/scxml/trunk/src/main/java/org/apache/commons/scxml/model/TransitionTarget.java Wed Dec 12 12:35:21 2007
@@ -191,6 +191,8 @@
*
* @param h
* History pseudo state
+ *
+ * @since 0.7
*/
public final void addHistory(final History h) {
history.add(h);
@@ -202,6 +204,8 @@
*
* @return boolean true if a given state contains at least one
* history pseudo state
+ *
+ * @since 0.7
*/
public final boolean hasHistory() {
return (!history.isEmpty());
@@ -213,6 +217,8 @@
* @return a list of all history pseudo states contained by a given state
* (can be empty)
* @see #hasHistory()
+ *
+ * @since 0.7
*/
public final List getHistory() {
return history;