01: /*
02: * @(#)IPath.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: * An ordered set of transitions plus a start state, which can be iterated
33: * through to discover a state-machine transition path.
34: *
35: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
36: * @version $Date: 2003/02/10 22:52:24 $
37: * @since June 12, 2002
38: */
39: public interface IPath {
40: /**
41: * Generate an iterator for this path. The iterator will only return
42: * transition elements.
43: *
44: * @return a new iterator for the path.
45: */
46: public IPathIterator iterator();
47:
48: /**
49: * Retrieve the starting state for this path.
50: *
51: * @return the start state for the path, which can never be <tt>null</tt>.
52: */
53: public IState getStartState();
54:
55: /**
56: * Returns the number of transitions in the path. This is named "size" to
57: * correspond to the <tt>java.util</tt>
58: * container classes terminology.
59: *
60: * @return the path transition count.
61: */
62: public int size();
63:
64: /**
65: * Returns the number of states visited in the path, which should
66: * always equal <tt>size() + 2</tt>, due to the start and final states,
67: * unless there are no transitions, in which case the depth is 1
68: * (there must always be a start state).
69: *
70: * @return the depth of the path.
71: */
72: public int getDepth();
73: }
|