View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  package org.apache.commons.scxml.model;
    18
    19  import java.util.LinkedHashSet;
    20  import java.util.Set;
    21
    22  /***
    23   * The class in this SCXML object model that corresponds to the
    24   * &lt;parallel&gt; SCXML element, which is a wrapper element to
    25   * encapsulate parallel state machines. For the &lt;parallel&gt; element
    26   * to be useful, each of its &lt;state&gt; substates must itself be
    27   * complex, that is, one with either &lt;state&gt; or &lt;parallel&gt;
    28   * children.
    29   *
    30   */
    31  public class Parallel extends TransitionTarget {
    32
    33      /***
    34       * Serial version UID.
    35       */
    36      private static final long serialVersionUID = 2L;
    37
    38      /***
    39       * The set of parallel state machines contained in this &lt;parallel&gt;.
    40       */
    41      private Set children;
    42
    43      /***
    44       * Constructor.
    45       */
    46      public Parallel() {
    47          this.children = new LinkedHashSet();
    48      }
    49
    50      /***
    51       * Get the set of parallel state machines contained in this Parallel.
    52       *
    53       * @return Returns the state.
    54       *
    55       * @deprecated Use getChildren() instead.
    56       */
    57      public final Set getStates() {
    58          return children;
    59      }
    60
    61      /***
    62       * Add a State to the list of parallel state machines contained
    63       * in this Parallel.
    64       *
    65       * @param state The state to add.
    66       *
    67       * @deprecated Use addChild(TransitionTarget) instead.
    68       */
    69      public final void addState(final State state) {
    70          if (state != null) {
    71              this.children.add(state);
    72              state.setParent(this);
    73          }
    74      }
    75
    76      /***
    77       * Get the set of child transition targets (may be empty).
    78       *
    79       * @return Set Returns the children.
    80       *
    81       * @since 0.7
    82       */
    83      public final Set getChildren() {
    84          return children;
    85      }
    86
    87      /***
    88       * Add a child.
    89       *
    90       * @param tt A child transition target.
    91       *
    92       * @since 0.7
    93       */
    94      public final void addChild(final TransitionTarget tt) {
    95          // TODO: State is a sufficient enough type for the parameter
    96          this.children.add(tt);
    97          tt.setParent(this);
    98      }
    99
    100 }
    101