01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.api.debugger.jpda;
43:
44: /**
45: * Represents one local. This interface is extended by {@link ObjectVariable}
46: * interface, if the represented local contains not primitive value (object
47: * value).
48: *
49: * <pre style="background-color: rgb(255, 255, 102);">
50: * Since JDI interfaces evolve from one version to another, it's strongly recommended
51: * not to implement this interface in client code. New methods can be added to
52: * this interface at any time to keep up with the JDI functionality.</pre>
53: *
54: * @see ObjectVariable
55: * @author Jan Jancura
56: */
57: public interface LocalVariable extends Variable {
58:
59: /**
60: * Declared name of local.
61: *
62: * @return name of this local.
63: */
64: public abstract String getName();
65:
66: /**
67: * Returns name of enclosing class.
68: *
69: * @return name of enclosing class
70: */
71: public abstract String getClassName();
72:
73: /**
74: * Declared type of this local.
75: *
76: * @return declared type of this local
77: */
78: public abstract String getDeclaredType();
79:
80: /**
81: * Sets value of this local represented as text.
82: *
83: * @param value a new value of this local represented as text
84: * @throws InvalidExpressionException if the expression is not correct
85: */
86: public abstract void setValue(String value)
87: throws InvalidExpressionException;
88: }
|