01: /*
02: * @(#)IPathHistory.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: * Records the states and transition history during a path traversal.
33: * The instance can be cloned for the cases of errors and warnings needing to
34: * store the path history when they occured. The instance should also support
35: * a toString() method for easy debugging and logging.
36: *
37: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
38: * @version $Date: 2003/02/10 22:52:24 $
39: * @since June 12, 2002
40: */
41: public interface IPathHistory {
42: /**
43: * When the current state changes, add the new state here. This should
44: * be called for the start state, and once at the end of every successful
45: * transition.
46: */
47: public void addState(IState s);
48:
49: /**
50: * When a transition is about to occur, it should be added here.
51: */
52: public void addTransition(ITransition t);
53:
54: /**
55: * After a validation call, the error results should be added here.
56: */
57: public void addValidate(IValidate val, IState owningState,
58: IErrors errors);
59:
60: /**
61: * After a validation call, the error results should be added here.
62: */
63: public void addValidate(IValidate val,
64: ITransition owningTransition, IErrors errors);
65:
66: /**
67: * Returns the total number of errors (halts, failures, and errors)
68: * registered during validation and transitions.
69: */
70: public int getErrorCount();
71:
72: /**
73: * Returns a copy of this instance. The copied instance must not change
74: * when the parent copy changes.
75: */
76: public IPathHistory copy();
77: }
|