~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to debuggerjpda/api/src/org/netbeans/api/debugger/jpda/LocalVariable.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
ImportĀ upstreamĀ versionĀ 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "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
/**
 
46
 * Represents one local. This interface is extended by {@link ObjectVariable}
 
47
 * interface, if the represented local contains not primitive value (object
 
48
 * value).
 
49
 *
 
50
 * <pre style="background-color: rgb(255, 255, 102);">
 
51
 * Since JDI interfaces evolve from one version to another, it's strongly recommended
 
52
 * not to implement this interface in client code. New methods can be added to
 
53
 * this interface at any time to keep up with the JDI functionality.</pre>
 
54
 *
 
55
 * @see ObjectVariable
 
56
 * @author   Jan Jancura
 
57
 */
 
58
public interface LocalVariable extends Variable {
 
59
 
 
60
    /**
 
61
     * Declared name of local.
 
62
     *
 
63
     * @return name of this local.
 
64
     */
 
65
    public abstract String getName ();
 
66
 
 
67
    /**
 
68
     * Returns name of enclosing class.
 
69
     *
 
70
     * @return name of enclosing class
 
71
     */
 
72
    public abstract String getClassName ();
 
73
 
 
74
    /**
 
75
     * Declared type of this local.
 
76
     *
 
77
     * @return declared type of this local
 
78
     */
 
79
    public abstract String getDeclaredType ();
 
80
 
 
81
    /**
 
82
     * Sets value of this local represented as text.
 
83
     *
 
84
     * @param value a new value of this local represented as text
 
85
     * @throws InvalidExpressionException if the expression is not correct
 
86
     */
 
87
    public abstract void setValue (String value) 
 
88
    throws InvalidExpressionException;
 
89
}