KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > debugger > jpda > Field


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.debugger.jpda;
21
22
23 /**
24  * Represents one field. This interface is extended by {@link ObjectVariable}
25  * interface, if the represented field contains not primitive value (object
26  * value).
27  *
28  * <pre style="background-color: rgb(255, 255, 102);">
29  * Since JDI interfaces evolve from one version to another, it's strongly recommended
30  * not to implement this interface in client code. New methods can be added to
31  * this interface at any time to keep up with the JDI functionality.</pre>
32  *
33  * @see ObjectVariable
34  * @author Jan Jancura
35  */
36 public interface Field extends Variable {
37
38     /**
39      * Declared name of field.
40      *
41      * @return name of this field.
42      */
43     public abstract String JavaDoc getName ();
44
45     /**
46      * Returns name of enclosing class.
47      *
48      * @return name of enclosing class
49      */
50     public abstract String JavaDoc getClassName ();
51
52     /**
53      * Declared type of this field.
54      *
55      * @return declared type of this field
56      */
57     public abstract String JavaDoc getDeclaredType ();
58
59     /**
60      * Returns <code>true</code> for static fields.
61      *
62      * @return <code>true</code> for static fields
63      */
64     public abstract boolean isStatic ();
65
66     /**
67      * Sets value of this field represented as text.
68      *
69      * @return sets value of this field represented as text
70      * @throws InvalidExpressionException if the expression is not correct
71      */
72     public abstract void setValue (String JavaDoc value)
73     throws InvalidExpressionException;
74 }
75
Popular Tags