| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| package freemarker.debug; |
| |
| import java.rmi.Remote; |
| import java.rmi.RemoteException; |
| import java.util.Collection; |
| import java.util.List; |
| |
| /** |
| * The main debugger interface. Allows management of breakpoints as well as |
| * installation of listeners for debug events. |
| */ |
| public interface Debugger extends Remote { |
| public static final int DEFAULT_PORT = 7011; |
| |
| /** |
| * Adds a breakpoint |
| * @param breakpoint the breakpoint to add |
| */ |
| public void addBreakpoint(Breakpoint breakpoint) |
| throws RemoteException; |
| |
| /** |
| * Removes a single breakpoint |
| * @param breakpoint the breakpoint to remove |
| */ |
| public void removeBreakpoint(Breakpoint breakpoint) |
| throws RemoteException; |
| |
| /** |
| * Removes all breakpoints for a specific template |
| */ |
| public void removeBreakpoints(String templateName) |
| throws RemoteException; |
| |
| /** |
| * Removes all breakpoints |
| */ |
| public void removeBreakpoints() |
| throws RemoteException; |
| |
| /** |
| * Retrieves a list of all {@link Breakpoint} objects. |
| */ |
| public List getBreakpoints() |
| throws RemoteException; |
| |
| /** |
| * Retrieves a list of all {@link Breakpoint} objects for the specified |
| * template. |
| */ |
| public List getBreakpoints(String templateName) |
| throws RemoteException; |
| |
| /** |
| * Retrieves a collection of all {@link DebuggedEnvironment} objects that |
| * are currently suspended. |
| */ |
| public Collection getSuspendedEnvironments() |
| throws RemoteException; |
| |
| /** |
| * Adds a listener for debugger events. |
| * @return an identification token that should be passed to |
| * {@link #removeDebuggerListener(Object)} to remove this listener. |
| */ |
| public Object addDebuggerListener(DebuggerListener listener) |
| throws RemoteException; |
| |
| /** |
| * Removes a previously added debugger listener. |
| * @param id the identification token for the listener that was returned |
| * from a prior call to {@link #addDebuggerListener(DebuggerListener)}. |
| */ |
| public void removeDebuggerListener(Object id) |
| throws RemoteException; |
| } |