1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* @(#)IErrors.java
*
* Copyright (C) 2002-2003 Matt Albrecht
* groboclown@users.sourceforge.net
* http://groboutils.sourceforge.net
*
* Part of the GroboUtils package at:
* http://groboutils.sourceforge.net
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package net.sourceforge.groboutils.mbtf.v1;
/**
* A container for registering errors or warnings caused by invalid
* validation of a state or transition.
*
* @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
* @version $Date: 2003/02/10 22:52:24 $
* @since June 12, 2002
*/
public interface IErrors
{
/**
* Immediately stop the path processing, and do not continue other paths
* for processing. This will throw a <tt>RuntimeException</tt>.
* <P>
* Halts should be a last-recourse to indicate that the system cannot be
* used for further testing.
*
* @param msg a human-readable error message.
* @exception TestHaltRuntimeException will always be generated.
*/
public void halt( String msg )
throws TestHaltRuntimeException;
/**
* Add a failure to the list of current errors. Validation methods that
* register failures will halt the current path's testing. This method
* will not throw an exception, so validation processing must leave the
* method on its own.
* <P>
* Failures should be registered when a non-recoverable error occurs in the
* system. The framework may still process other paths, though.
*
* @param msg a human-readable error message.
*/
public void addFailure( String msg );
/**
* Add a failure associated with a Throwable to the list of current errors.
* Validation methods that register failures will halt the current path's
* testing. This method will not throw an exception, so validation
* processing must leave the method on its own.
* <P>
* Failures should be registered when a non-recoverable error occurs in the
* system. The framework may still process other paths, though.
*
* @param msg a human-readable error message.
* @param t the exception associated with the error.
*/
public void addFailure( String msg, Throwable t );
/**
* Add a failure to the list of current errors. Validation methods that
* register failures will halt the current path's testing. This method
* will not throw a <tt>TestFailRuntimeException</tt>, so validation
* processing must leave the method on its own.
* <P>
* Failures should be registered when a non-recoverable error occurs in the
* system. The framework may still process other paths, though.
*
* @param msg a human-readable error message.
* @exception TestFailRuntimeException allows for easy exiting of a
* burried method call stack.
*/
public void fail( String msg )
throws TestFailRuntimeException;
/**
* Add a failure associated with a Throwable to the list of current errors.
* Validation methods that register failures will halt the current path's
* testing. This method will throw a <tt>TestFailRuntimeException</tt> to
* allow for an easy exit from a burried method call stack.
* <P>
* Failures should be registered when a non-recoverable error occurs in the
* system. The framework may still process other paths, though.
*
* @param msg a human-readable error message.
* @param t the exception associated with the error.
* @exception TestFailRuntimeException allows for easy exiting of a
* burried method call stack.
*/
public void fail( String msg, Throwable t )
throws TestFailRuntimeException;
/**
* Add an error to the list of current errors. Validation methods that
* register errors will not halt the current path's testing, but the error
* will be listed in the report with the associated path where the error
* condition occured.
* <P>
* Errors should be registered when an error occurs in the system, but
* the system can continue processing the path.
*
* @param msg a human-readable error message.
*/
public void addError( String msg );
/**
* Add an error associated with a Throwable to the list of current errors.
* Validation methods that register errors will halt the current path's
* testing.
* <P>
* Errors should be registered when an error occurs in the system, but
* the system can continue processing the path.
*
* @param msg a human-readable error message.
* @param t the exception associated with the error.
*/
public void addError( String msg, Throwable t );
/**
* Add a warning to the list of current warnings. Warnings will not
* halt the testing process, and will not register an error.
* <P>
* Warnings should be used when a questionable system state occurs, or if
* the tester wants to perform debugging.
*
* @param msg a human-readable message.
*/
public void addWarning( String msg );
/**
* Retrieve all registered errors.
*/
public IError[] getErrors();
}
|
