KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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
16 /**
17  * A variable that contains the value of an instance or class variable.
18  * <p>
19  * Clients are not intended to implement this interface.
20  * </p>
21  * @see org.eclipse.debug.core.model.IVariable
22  * @since 2.0
23  */
24 public interface IJavaFieldVariable extends IJavaVariable {
25     
26     /**
27      * Returns whether this variable is declared as transient.
28      *
29      * @return whether this variable has been declared as transient
30      * @exception DebugException if this method fails. Reasons include:
31      * <ul><li>Failure communicating with the VM. The DebugException's
32      * status code contains the underlying exception responsible for
33      * the failure.</li></ul>
34      */
35     public boolean isTransient() throws DebugException;
36     
37     /**
38      * Returns whether this variable is declared as volatile.
39      *
40      * @return whether this variable has been declared as volatile
41      * @exception DebugException if this method fails. Reasons include:
42      * <ul><li>Failure communicating with the VM. The DebugException's
43      * status code contains the underlying exception responsible for
44      * the failure.</li></ul>
45      */
46     public boolean isVolatile() throws DebugException;
47         
48     /**
49      * Returns the type that declares this variable.
50      *
51      * @return the type that declares this variable
52      */
53     public IJavaType getDeclaringType();
54     
55     /**
56      * Returns the object that contains this field variable, or <code>null</code>
57      * if no object contains this field variable (static field variable).
58      *
59      * @return the object that contains this field variable
60      * @since 3.0
61      */
62     public IJavaObject getReceiver();
63     
64     /**
65      * Returns the type that contains this field variable.
66      *
67      * @return the type that contains this field variable
68      * @since 3.0
69      */
70     public IJavaReferenceType getReceivingType();
71     
72 }
73
74
75
Popular Tags