01: /*
02: * @(#)IState.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: * Associates a system state with the transitions leading out of the state,
33: * and with the validation of the state. The state object should be immutable
34: * once the path generation begins.
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 IState {
41: /**
42: * Retrieves the name for the state. 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 state.
46: */
47: public String getName();
48:
49: /**
50: * Retrieves the list of transitions leading from this state.
51: *
52: * @return a non-null list of all transitions from this state. If the
53: * length of the list is 0, then this is a terminal state.
54: */
55: public ITransition[] getTransitions();
56:
57: /**
58: * Retrieves the list of all validation instances used to assert that
59: * the current state is valid.
60: *
61: * @return a non-null list of all validation instances for this state.
62: * An empty list will cause a warning on all but the first
63: * (initial) state. This list should not include the included
64: * Transitions' validates.
65: */
66: public IValidate[] getValidates();
67: }
|