Package: IDbgpPropertyCommands

IDbgpPropertyCommands

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 org.overture.ide.debug.core.dbgp.IDbgpProperty;
25: import org.overture.ide.debug.core.dbgp.exceptions.DbgpException;
26:
27: public interface IDbgpPropertyCommands
28: {
29:         /*
30:          * -d stack depth (optional, debugger engine should assume zero if not provided) -c context id (optional, retrieved
31:          * by context-names, debugger engine should assume zero if not provided) -n property long name (required) -m max
32:          * data size to retrieve (optional) -t data type (optional) -p data page (optional, for arrays, hashes, objects,
33:          * etc.) -k property key as retrieved in a property element, optional, used for property_get of children and
34:          * property_value, required if it was provided by the debugger engine. -a property address as retrieved in a
35:          * property element, optional, used for property_set/value, required if it was provided by the debugger engine.
36:          */
37:
38:         IDbgpProperty getPropertyByKey(Integer page, String name,
39:                         Integer stackDepth, String key) throws DbgpException;
40:
41:         IDbgpProperty getProperty(String name) throws DbgpException;
42:
43:         IDbgpProperty getProperty(String name, int stackDepth) throws DbgpException;
44:
45:         IDbgpProperty getProperty(String name, int stackDepth, int contextId)
46:                         throws DbgpException;
47:
48:         IDbgpProperty getProperty(int page, String name, int stackDepth)
49:                         throws DbgpException;
50:
51:         boolean setProperty(IDbgpProperty property) throws DbgpException;
52:
53:         boolean setProperty(String name, int stackDepth, String value)
54:                         throws DbgpException;
55:
56:         boolean setProperty(String longName, String key, String newValue)
57:                         throws DbgpException;
58: }