org.netbeans.spi.debugger.ui

Class CodeEvaluator.EvaluatorService

java.lang.Object

org.netbeans.spi.debugger.ui.CodeEvaluator.EvaluatorService

Enclosing class:

CodeEvaluator

public abstract static class CodeEvaluator.EvaluatorService
extends Object

Service handling evaluations in the code evaluator. Register an implementation of this class via CodeEvaluator.EvaluatorService.Registration annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CodeEvaluator.EvaluatorService.Registration Declarative registration of a EvaluatorService implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CAN_EVALUATE Property name fired in order to refresh the evaluate button state.
static String	PROP_EXPRESSIONS_HISTORY Property name fired in order to refresh the list of expressions history.

Constructor Summary

Constructors

Constructor and Description
EvaluatorService()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Add a property change listener to be notified about property change events.
abstract boolean	canEvaluate() Provide status whether the service is ready to evaluate code now.
abstract void	evaluate(String expression) Evaluate the given expression.
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Fire a property change event.
abstract List<String>	getExpressionsHistory() Get the historical evaluated expressions.
void	removePropertyChangeListener(PropertyChangeListener l) Remove a property change listener.
abstract void	setupContext(JEditorPane editorPane, Runnable setUpCallback) Perform setup of the editor pane of the code evaluator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_CAN_EVALUATE

public static final String PROP_CAN_EVALUATE

Property name fired in order to refresh the evaluate button state.

See Also:

Constant Field Values

PROP_EXPRESSIONS_HISTORY

public static final String PROP_EXPRESSIONS_HISTORY

Property name fired in order to refresh the list of expressions history.

See Also:

Constant Field Values

Constructor Detail

EvaluatorService

public EvaluatorService()

Method Detail

setupContext

public abstract void setupContext(JEditorPane editorPane,
                                  Runnable setUpCallback)

Perform setup of the editor pane of the code evaluator. Typically perform binding for code completion.

Parameters:

editorPane -

setUpCallback - call this back when the setup is finished. As the setup may require asynchronous calls, this is necessary to notify the infrastructure that the code editor is set up.

canEvaluate

public abstract boolean canEvaluate()

Provide status whether the service is ready to evaluate code now. Fire PROP_CAN_EVALUATE when this status changes.

Returns:

true when code evaluation is possible (e.g. the debugger is suspended), false otherwise.

evaluate

public abstract void evaluate(String expression)

Evaluate the given expression. The evaluation typically should be performed asynchronously, and the result is then set to CodeEvaluator.Result or any other custom result handler.

Parameters:

expression - The expression to evaluate.

getExpressionsHistory

public abstract List<String> getExpressionsHistory()

Get the historical evaluated expressions. Items provided by this list are accessible from the code evaluator UI.

Returns:

The list of evaluated expressions.

firePropertyChange

protected final void firePropertyChange(String propertyName,
                                        Object oldValue,
                                        Object newValue)

Fire a property change event.

Parameters:

propertyName - The property name, one of PROP_* constants.

oldValue - An old value

newValue - A new value

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener l)

Add a property change listener to be notified about property change events.

Parameters:

l - the property change listener

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener l)

Remove a property change listener.

Parameters:

l - the property change listener