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.scxml2.model;
18  
19  import org.apache.commons.scxml2.ActionExecutionContext;
20  import org.apache.commons.scxml2.SCXMLExpressionException;
21  import org.apache.commons.scxml2.TriggerEvent;
22  
23  /**
24   * The class in this SCXML object model that corresponds to the
25   * <raise> SCXML element.
26   *
27   * @since 2.0
28   */
29  public class Raise extends Action {
30  
31      /**
32       * Serial version UID.
33       */
34      private static final long serialVersionUID = 1L;
35  
36      /**
37       * The event to be generated.
38       */
39      private String event;
40  
41      /**
42       * Constructor.
43       */
44      public Raise() {
45          super();
46      }
47  
48      /**
49       * Get the event.
50       *
51       * @return Returns the event.
52       */
53      public final String getEvent() {
54          return event;
55      }
56  
57      /**
58       * Set the event.
59       *
60       * @param event The event to set.
61       */
62      public final void setEvent(final String event) {
63          this.event = event;
64      }
65  
66      /**
67       * {@inheritDoc}
68       */
69      @Override
70      public void execute(ActionExecutionContext exctx) throws ModelException, SCXMLExpressionException {
71  
72          if (exctx.getAppLog().isDebugEnabled()) {
73              exctx.getAppLog().debug("<raise>: Adding event '" + event + "' to list of derived events.");
74          }
75          TriggerEvent ev = new TriggerEvent(event, TriggerEvent.SIGNAL_EVENT);
76          exctx.getInternalIOProcessor().addEvent(ev);
77  
78      }
79  }