KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > mbtf > v1 > IPathHistory


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