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;
18
19 import org.apache.commons.scxml2.model.EnterableState;
20 import org.apache.commons.scxml2.model.Transition;
21 import org.apache.commons.scxml2.model.TransitionTarget;
22
23 /**
24 * Listener interface for observable entities in the SCXML model.
25 * Observable entities include {@link org.apache.commons.scxml2.model.SCXML}
26 * instances (subscribe to all entry, exit and transition notifications),
27 * {@link org.apache.commons.scxml2.model.State} instances (subscribe to
28 * particular entry and exit notifications) and
29 * {@link org.apache.commons.scxml2.model.Transition} instances (subscribe to
30 * particular transitions).
31 *
32 */
33 public interface SCXMLListener {
34
35 /**
36 * Handle the entry into a EnterableState.
37 *
38 * @param state The EnterableState entered
39 */
40 void onEntry(EnterableState state);
41
42 /**
43 * Handle the exit out of a EnterableState.
44 *
45 * @param state The EnterableState exited
46 */
47 void onExit(EnterableState state);
48
49 /**
50 * Handle the transition.
51 *
52 * @param from The source TransitionTarget
53 * @param to The destination TransitionTarget
54 * @param transition The Transition taken
55 * @param event The event name triggering the transition
56 */
57 void onTransition(TransitionTarget from, TransitionTarget to,
58 Transition transition, String event);
59
60 }
61