001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.debug;
054:
055: import java.rmi.Remote;
056: import java.rmi.RemoteException;
057: import java.util.Collection;
058: import java.util.List;
059:
060: /**
061: * The main debugger interface. Allows management of breakpoints as well as
062: * installation of listeners for debug events.
063: * @author Attila Szegedi
064: * @version $Id: Debugger.java,v 1.1 2003/05/02 15:55:48 szegedia Exp $
065: */
066: public interface Debugger extends Remote {
067: public static final int DEFAULT_PORT = 7011;
068:
069: /**
070: * Adds a breakpoint
071: * @param breakpoint the breakpoint to add
072: * @throws RemoteException
073: */
074: public void addBreakpoint(Breakpoint breakpoint)
075: throws RemoteException;
076:
077: /**
078: * Removes a single breakpoint
079: * @param breakpoint the breakpoint to remove
080: * @throws RemoteException
081: */
082: public void removeBreakpoint(Breakpoint breakpoint)
083: throws RemoteException;
084:
085: /**
086: * Removes all breakpoints for a specific template
087: * @param templateName
088: * @throws RemoteException
089: */
090: public void removeBreakpoints(String templateName)
091: throws RemoteException;
092:
093: /**
094: * Removes all breakpoints
095: * @throws RemoteException
096: */
097: public void removeBreakpoints() throws RemoteException;
098:
099: /**
100: * Retrieves a list of all {@link Breakpoint} objects.
101: * @throws RemoteException
102: */
103: public List getBreakpoints() throws RemoteException;
104:
105: /**
106: * Retrieves a list of all {@link Breakpoint} objects for the specified
107: * template.
108: * @throws RemoteException
109: */
110: public List getBreakpoints(String templateName)
111: throws RemoteException;
112:
113: /**
114: * Retrieves a collection of all {@link DebuggedEnvironment} objects that
115: * are currently suspended.
116: * @throws RemoteException
117: */
118: public Collection getSuspendedEnvironments() throws RemoteException;
119:
120: /**
121: * Adds a listener for debugger events.
122: * @return an identification token that should be passed to
123: * {@link #removeDebuggerListener(Object)} to remove this listener.
124: * @throws RemoteException
125: */
126: public Object addDebuggerListener(DebuggerListener listener)
127: throws RemoteException;
128:
129: /**
130: * Removes a previously added debugger listener.
131: * @param id the identification token for the listener that was returned
132: * from a prior call to {@link #addDebuggerListener(DebuggerListener)}.
133: * @throws RemoteException
134: */
135: public void removeDebuggerListener(Object id)
136: throws RemoteException;
137: }
|