View Javadoc

1   package cz.cuni.amis.pogamut.base.component.bus.event;
2   
3   import cz.cuni.amis.pogamut.base.component.IComponent;
4   import cz.cuni.amis.pogamut.base.component.bus.IComponentEvent;
5   import cz.cuni.amis.pogamut.base.component.bus.event.impl.FatalErrorEvent;
6   
7   /**
8    * Marks that fatal error has happened that prevents the component from running.
9    * <p><p>
10   * It is strongly advised to override toString() as in ${link {@link FatalErrorEvent}. 
11   */
12  public interface IFatalErrorEvent<SOURCE extends IComponent> extends IComponentEvent<SOURCE> {
13  	
14  	/**
15  	 * Returns description of what went wrong.
16  	 * @return
17  	 */
18  	public String getMessage();
19  	
20  	/**
21  	 * Exception associated with the error, may be null. 
22  	 * @return
23  	 */
24  	public Throwable getCause();
25  		
26  	/**
27  	 * Stack trace of the error - first element of the stacktrace should be the place where
28  	 * the fatal error event has been created.
29  	 * @return
30  	 */
31  	public StackTraceElement[] getStackTrace();
32  	
33  	/**
34  	 * Called to get a long human-readable description of the fatal error.
35  	 */
36  	public String getSummary();
37  	
38  }