Skip to main content
summaryrefslogtreecommitdiffstats
blob: afd697383c22f8fd701ffac778dca85612ceabad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*******************************************************************************
 * Copyright (c) 2000, 2004 QNX Software Systems and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     QNX Software Systems - Initial API and implementation
 *******************************************************************************/

package org.eclipse.cdt.debug.core.cdi.model;

import org.eclipse.cdt.debug.core.cdi.CDIException;

/**
 * 
 * Represents the value of a variable. A value representing 
 * a complex data structure contains variables.
 * 
 * @since Jul 9, 2002
 */
public interface ICDIValue extends ICDIObject {
	/**
	 * Returns a description of the type of data this value contains.
	 * 
	 * @return  the name of this value's data type
	 * @throws CDIException if this method fails.  Reasons include:
	 */
	String getTypeName() throws CDIException;
	
	/**
	 * Returns this value as a <code>String</code>.
	 *
	 * @return a String representation of this value
	 * @throws CDIException if this method fails.  Reasons include:
	 */
	String getValueString() throws CDIException;

	/**
	 * Return the number of children.
	 * @return int children count
	 */
	int getChildrenNumber() throws CDIException;
	
	/**
	 * @return true if value is a container like structure.
	 */
	boolean hasChildren() throws CDIException;
	
	/**
	 * Returns the variables in this value. An empty collection 
	 * is returned if there are no variables.
	 * 
	 * @return an array of variables
	 * @throws CDIException if this method fails.  Reasons include:
	 */
	ICDIVariable[] getVariables() throws CDIException;	
}

Back to the top