001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.api.debugger.jpda;
043:
044: /**
045: * Represents one field. This interface is extended by {@link ObjectVariable}
046: * interface, if the represented field contains not primitive value (object
047: * value).
048: *
049: * <pre style="background-color: rgb(255, 255, 102);">
050: * Since JDI interfaces evolve from one version to another, it's strongly recommended
051: * not to implement this interface in client code. New methods can be added to
052: * this interface at any time to keep up with the JDI functionality.</pre>
053: *
054: * @see ObjectVariable
055: * @author Jan Jancura
056: */
057: public interface Field extends Variable {
058:
059: /**
060: * Declared name of field.
061: *
062: * @return name of this field.
063: */
064: public abstract String getName();
065:
066: /**
067: * Returns name of enclosing class.
068: *
069: * @return name of enclosing class
070: */
071: public abstract String getClassName();
072:
073: /**
074: * Get the class type in which this field was declared.
075: * @return the class type
076: */
077: public abstract JPDAClassType getDeclaringClass();
078:
079: /**
080: * Declared type of this field.
081: *
082: * @return declared type of this field
083: */
084: public abstract String getDeclaredType();
085:
086: /**
087: * Returns <code>true</code> for static fields.
088: *
089: * @return <code>true</code> for static fields
090: */
091: public abstract boolean isStatic();
092:
093: /**
094: * Sets value of this field represented as text.
095: *
096: * @return sets value of this field represented as text
097: * @throws InvalidExpressionException if the expression is not correct
098: */
099: public abstract void setValue(String value)
100: throws InvalidExpressionException;
101: }
|