Package: IDbgpSpawnpointCommands

IDbgpSpawnpointCommands

Coverage

1: /*
2: * #%~
3: * org.overture.ide.debug
4: * %%
5: * Copyright (C) 2008 - 2014 Overture
6: * %%
7: * This program is free software: you can redistribute it and/or modify
8: * it under the terms of the GNU General Public License as
9: * published by the Free Software Foundation, either version 3 of the
10: * License, or (at your option) any later version.
11: *
12: * This program is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: * GNU General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public
18: * License along with this program. If not, see
19: * <http://www.gnu.org/licenses/gpl-3.0.html>.
20: * #~%
21: */
22: package org.overture.ide.debug.core.dbgp.commands;
23:
24: import java.net.URI;
25:
26: import org.overture.ide.debug.core.dbgp.IDbgpSpawnpoint;
27: import org.overture.ide.debug.core.dbgp.exceptions.DbgpException;
28:
29: public interface IDbgpSpawnpointCommands
30: {
31:
32:         /**
33:          * Sets the spawn point at the specified location. Returns the id of created spawn point.
34:          *
35:          * @param uri
36:          * @param lineNumber
37:          * @param enabled
38:          * @return
39:          * @throws DbgpException
40:          */
41:         IDbgpSpawnpoint setSpawnpoint(URI uri, int lineNumber, boolean enabled)
42:                         throws DbgpException;
43:
44:         /**
45:          * Retrieves the information about the specified spawn point
46:          *
47:          * @param spawnpointId
48:          * @return
49:          * @throws DbgpException
50:          */
51:         IDbgpSpawnpoint getSpawnpoint(String spawnpointId) throws DbgpException;
52:
53:         /**
54:          * Updates the specified spawn point
55:          *
56:          * @param spawnpointId
57:          * @param enabled
58:          * @return
59:          * @throws DbgpException
60:          */
61:         void updateSpawnpoint(String spawnpointId, boolean enabled)
62:                         throws DbgpException;
63:
64:         /**
65:          * Removes the specified spawn point
66:          *
67:          * @param spawnpointId
68:          * @throws DbgpException
69:          */
70:         void removeSpawnpoint(String spawnpointId) throws DbgpException;
71:
72:         /**
73:          * Retrieves all spawn points. If there are no spawn points empty array is returned.
74:          *
75:          * @return
76:          * @throws DbgpException
77:          */
78:         IDbgpSpawnpoint[] listSpawnpoints() throws DbgpException;
79:
80: }