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-2006 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 watch in JPDA debugger.
046: *
047: * <pre style="background-color: rgb(255, 255, 102);">
048: * It's strongly recommended
049: * not to implement this interface in client code. New methods can be added to
050: * this interface at any time to keep up with the JDI functionality.</pre>
051: *
052: * @author Jan Jancura
053: */
054:
055: public interface JPDAWatch extends Variable {
056:
057: /**
058: * Watched expression.
059: *
060: * @return watched expression
061: */
062: public abstract String getExpression();
063:
064: /**
065: * Sets watched expression.
066: *
067: * @param expression a expression to be watched
068: */
069: public abstract void setExpression(String expression);
070:
071: /**
072: * Remove the watch from the list of all watches in the system.
073: */
074: public abstract void remove();
075:
076: /**
077: * Declared type of this local.
078: *
079: * @return declared type of this local
080: */
081: public abstract String getType();
082:
083: /**
084: * Text representation of current value of this local.
085: *
086: * @return text representation of current value of this local
087: */
088: public abstract String getValue();
089:
090: /**
091: * Returns description of problem is this watch can not be evaluated
092: * in current context.
093: *
094: * @return description of problem
095: */
096: public abstract String getExceptionDescription();
097:
098: /**
099: * Sets value of this local represented as text.
100: *
101: * @param value a new value of this variable represented as text
102: */
103: public abstract void setValue(String value)
104: throws InvalidExpressionException;
105:
106: /**
107: * Calls {@link java.lang.Object#toString} in debugged JVM and returns
108: * its value.
109: *
110: * @return toString () value of this instance
111: */
112: public abstract String getToStringValue()
113: throws InvalidExpressionException;
114: }
|