KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > debug > core > IJavaVariable


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jdt.debug.core;
12
13
14 import org.eclipse.debug.core.DebugException;
15 import org.eclipse.debug.core.model.IVariable;
16
17 /**
18  * A local variable, field slot, or receiver (this) in a Java virtual machine.
19  * <p>
20  * Clients are not intended to implement this interface.
21  * </p>
22  * @see org.eclipse.debug.core.model.IVariable
23  */
24 public interface IJavaVariable extends IVariable, IJavaModifiers {
25     
26     /**
27      * Returns the JNI-style signature for the declared type of this
28      * variable, or <code>null</code> if the type associated with the
29      * signature is not yet loaded in the target VM.
30      *
31      * @return signature, or <code>null</code> if not accessible
32      * @exception DebugException if this method fails. Reasons include:
33      * <ul><li>Failure communicating with the VM. The DebugException's
34      * status code contains the underlying exception responsible for
35      * the failure.</li>
36      * <li>The type associated with the signature is not yet loaded</li></ul>
37      */
38     public String JavaDoc getSignature() throws DebugException;
39     
40     /**
41      * Returns the generic signature as defined in the JVM
42      * specification for the declared type of this variable,
43      * or <code>null</code> if the type associated with the
44      * signature is not yet loaded in the target VM.
45      * Returns the same value as #getSignature() if the declared type
46      * of this variable is not a generic type.
47      *
48      * @return generic signature, or <code>null</code> if not accessible
49      * @exception DebugException if this method fails. Reasons include:
50      * <ul><li>Failure communicating with the VM. The DebugException's
51      * status code contains the underlying exception responsible for
52      * the failure.</li>
53      * <li>The type associated with the signature is not yet loaded</li></ul>
54      * @since 3.1
55      */
56     public String JavaDoc getGenericSignature() throws DebugException;
57     
58     /**
59      * Returns the declared type of this variable.
60      *
61      * @return the declared type of this variable
62      * @exception DebugException if this method fails. Reasons include:
63      * <ul><li>Failure communicating with the VM. The DebugException's
64      * status code contains the underlying exception responsible for
65      * the failure.</li>
66      * <li>The type associated with the signature is not yet loaded</li></ul>
67      * @since 2.0
68      */
69     public IJavaType getJavaType() throws DebugException;
70     
71     /**
72      * Returns whether this variable is local.
73      *
74      * @return whether this variable is a local variable
75      * @exception DebugException if this method fails. Reasons include:
76      * <ul><li>Failure communicating with the VM. The DebugException's
77      * status code contains the underlying exception responsible for
78      * the failure.</li></ul>
79      * @since 2.1
80      */
81     public boolean isLocal() throws DebugException;
82     
83 }
84
85
86
Popular Tags