01: //
02: // Copyright (C) 2005 United States Government as represented by the
03: // Administrator of the National Aeronautics and Space Administration
04: // (NASA). All Rights Reserved.
05: //
06: // This software is distributed under the NASA Open Source Agreement
07: // (NOSA), version 1.3. The NOSA has been approved by the Open Source
08: // Initiative. See the file NOSA-1.3-JPF at the top of the distribution
09: // directory tree for the complete NOSA document.
10: //
11: // THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY
12: // KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT
13: // LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO
14: // SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
15: // A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT
16: // THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT
17: // DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE.
18: //
19: package gov.nasa.jpf;
20:
21: /**
22: * interface to register for notification by the Search object.
23: * Observer role in same-name pattern
24: */
25: public interface SearchListener extends JPFListener {
26:
27: /**
28: * got the next state
29: */
30: void stateAdvanced(Search search);
31:
32: /**
33: * state is fully explored
34: */
35: void stateProcessed(Search search);
36:
37: /**
38: * state was backtracked one step
39: */
40: void stateBacktracked(Search search);
41:
42: /**
43: * a previously generated state was restored
44: * (can be on a completely different path)
45: */
46: void stateRestored(Search search);
47:
48: /**
49: * JPF encountered a property violation
50: */
51: void propertyViolated(Search search);
52:
53: /**
54: * we get this after we enter the search loop, but BEFORE the first forward
55: */
56: void searchStarted(Search search);
57:
58: /**
59: * there was some contraint hit in the search, we back out
60: * could have been turned into a property, but usually is an attribute of
61: * the search, not the application
62: */
63: void searchConstraintHit(Search search);
64:
65: /**
66: * we're done, either with or without a preceeding error
67: */
68: void searchFinished(Search search);
69: }
|