1   package freemarker.debug;
    2   
    3   import java.rmi.RemoteException;
    4   
    5   /**
    6    * Represents the debugger-side mirror of a debugged 
    7    * {@link freemarker.core.Environment} object in the remote VM. This interface
    8    * extends {@link DebugModel}, and the properties of the Environment are exposed
    9    * as hash keys on it. Specifically, the following keys are supported:
   10    * "currentNamespace", "dataModel", "globalNamespace", "knownVariables", 
   11    * "mainNamespace", and "template".
   12    * <p>The debug model for the template supports keys "configuration" and "name".
   13    * <p>The debug model for the configuration supports key "sharedVariables".
   14    * <p>Additionally, all of the debug models for environment, template, and 
   15    * configuration also support all the setting keys of 
   16    * {@link freemarker.core.Configurable} objects. 
   17   
   18    * @author Attila Szegedi
   19    * @version $Id: DebuggedEnvironment.java,v 1.1 2003/05/02 15:55:48 szegedia Exp $
   20    */
   21   public interface DebuggedEnvironment extends DebugModel
   22   {
   23       /**
   24        * Resumes the processing of the environment in the remote VM after it was 
   25        * stopped on a breakpoint.
   26        * @throws RemoteException
   27        */
   28       public void resume() throws RemoteException;
   29       
   30       /**
   31        * Stops the processing of the environment after it was stopped on
   32        * a breakpoint. Causes a {@link freemarker.core.StopException} to be
   33        * thrown in the processing thread in the remote VM. 
   34        * @throws RemoteException
   35        */
   36       public void stop() throws RemoteException;
   37       
   38       /**
   39        * Returns a unique identifier for this environment
   40        * @throws RemoteException
   41        */
   42       public long getId() throws RemoteException;
   43   }