comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/SuspendedEvent.java @ 22008:02e4cf046653

Providing a bit more meaningful documentation to our recent debugging improvements
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 22 Jul 2015 14:25:03 +0200
parents 5bc7f7b867ab
children f879b1fe3773
comparison
equal deleted inserted replaced
22007:12891f4cae7a 22008:02e4cf046653
42 * This event is delivered to all {@link Builder#onEvent(com.oracle.truffle.api.vm.EventConsumer) 42 * This event is delivered to all {@link Builder#onEvent(com.oracle.truffle.api.vm.EventConsumer)
43 * registered event handlers} when an execution is suspended on a 43 * registered event handlers} when an execution is suspended on a
44 * {@link Debugger#setLineBreakpoint(int, com.oracle.truffle.api.source.LineLocation, boolean) 44 * {@link Debugger#setLineBreakpoint(int, com.oracle.truffle.api.source.LineLocation, boolean)
45 * breakpoint} or during {@link #prepareStepInto(int) stepping}. Methods in this event can only be 45 * breakpoint} or during {@link #prepareStepInto(int) stepping}. Methods in this event can only be
46 * used while the handlers process the event. Then the state of the event becomes invalid and 46 * used while the handlers process the event. Then the state of the event becomes invalid and
47 * subsequent calls to the event methods yield {@link IllegalStateException}. 47 * subsequent calls to the event methods yield {@link IllegalStateException}. One can call
48 * 48 * {@link #getDebugger()} and keep reference to it for as long as necessary.
49 */ 49 */
50 public final class SuspendedEvent { 50 public final class SuspendedEvent {
51 private final List<String> recentWarnings; 51 private final List<String> recentWarnings;
52 private final MaterializedFrame mFrame; 52 private final MaterializedFrame mFrame;
53 private final Node astNode; 53 private final Node astNode;
79 }); 79 });
80 80
81 } 81 }
82 82
83 /** 83 /**
84 * Debugger associated with the just suspended execution. This debuger remains valid after the 84 * Debugger associated with the just suspended execution. This debugger remains valid after the
85 * event is processed, it is possible and suggested to keep a reference to it and use it any 85 * event is processed, it is possible and suggested to keep a reference to it and use it any
86 * time later when evaluating sources in the {@link TruffleVM}. 86 * time later when evaluating sources in the {@link TruffleVM}.
87 * 87 *
88 * @return instance of debugger associated with the just suspended execution and any subsequent 88 * @return instance of debugger associated with the just suspended execution and any subsequent
89 * ones in the same {@link TruffleVM}. 89 * ones in the same {@link TruffleVM}.