01: /*
02: * @(#)ITransition.java
03: *
04: * Copyright (C) 2002-2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Part of the GroboUtils package at:
09: * http://groboutils.sourceforge.net
10: *
11: * Permission is hereby granted, free of charge, to any person obtaining a
12: * copy of this software and associated documentation files (the "Software"),
13: * to deal in the Software without restriction, including without limitation
14: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15: * and/or sell copies of the Software, and to permit persons to whom the
16: * Software is furnished to do so, subject to the following conditions:
17: *
18: * The above copyright notice and this permission notice shall be included in
19: * all copies or substantial portions of the Software.
20: *
21: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27: * DEALINGS IN THE SOFTWARE.
28: */
29: package net.sourceforge.groboutils.mbtf.v1;
30:
31: /**
32: * Corresponds to a state-machine transition from one state to another.
33: * Transitions must verify that their associated action can be performed
34: * on the current system's state.
35: *
36: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
37: * @version $Date: 2003/02/10 22:52:25 $
38: * @since June 12, 2002
39: */
40: public interface ITransition {
41: /**
42: * Retrieves the name for the transition. This should be unique for
43: * state-machine assembly purposes, but it does not have to be.
44: *
45: * @return a non-null name for this transition.
46: */
47: public String getName();
48:
49: /**
50: * Returns the next state if the corresponding action is executed.
51: *
52: * @return destination state, which can never be <tt>null</tt>.
53: */
54: public IState getDestinationState();
55:
56: /**
57: * Returns the action used to transition to the destination state.
58: *
59: * @return transition's action, which can never be <tt>null</tt>.
60: */
61: public IAction getAction();
62:
63: /**
64: * Returns all validation methods used to assert that the system can
65: * perform this transition.
66: *
67: * @return a list of associated validation instances.
68: */
69: public IValidate[] getValidates();
70: }
|