org.netbeans.spi.debugger.ui

Interface PinWatchUISupport.ValueProvider

Enclosing class:

PinWatchUISupport

public static interface PinWatchUISupport.ValueProvider

Provider of pinned watch value. Register an implementation of this class via DebuggerServiceRegistration for the corresponding debugger session ID path.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PinWatchUISupport.ValueProvider.ValueChangeListener Listener for watch value changes.

Method Summary

Modifier and Type	Method and Description
default String	getEditableValue(Watch watch) Determine whether the current watch value is editable and if yes, return the value to edit.
default String	getEvaluatingText() Get a localized text to be displayed when the watch is being evaluated.
default Action[]	getHeadActions(Watch watch) Get actions to be displayed at the head of pin watch component.
String	getId() Get a unique ID of this value provider.
default Action[]	getTailActions(Watch watch) Get actions to be displayed at the tail of pin watch component.
String	getValue(Watch watch) Get current value of pinned watch.
void	setChangeListener(Watch watch, PinWatchUISupport.ValueProvider.ValueChangeListener chl) Allows to set a value change listener for a specific watch.
default boolean	setValue(Watch watch, String value) Set a watch value as a response to finished editing.
void	unsetChangeListener(Watch watch) Unset a value change listener for a specific watch.

Method Detail

getId

String getId()

Get a unique ID of this value provider. Use this ID when pinning a watch via PinWatchUISupport.pin(org.netbeans.api.debugger.Watch, java.lang.String).

Returns:

An ID of this value provider.

getValue

String getValue(Watch watch)

Get current value of pinned watch. This method must not block, it's called synchronously in the EQ thread. This method should return most recent value of the watch, or the same instance which getEvaluatingText() returns when the watch value is being computed, or null when the watch can not be resolved.

Parameters:

watch - the watch whose value is to be returned.

Returns:

The current value of the watch, or getEvaluatingText(), or null.

getEvaluatingText

default String getEvaluatingText()

Get a localized text to be displayed when the watch is being evaluated. The pin watch UI highlights changed values. It uses this string to distinguish real watch values. Return the same instance from getValue(org.netbeans.api.debugger.Watch) when the watch is being computed.

Returns:

A localized text displayed while the watch is evaluating.

getEditableValue

default String getEditableValue(Watch watch)

Determine whether the current watch value is editable and if yes, return the value to edit. The value returned by getValue(org.netbeans.api.debugger.Watch) might not be the proper value to edit. It may contain type description or more descriptive information about the value. This method should provide a raw textual representation of the value to edit, or null when the value is not editable.
The default implementation return null.

Parameters:

watch - The watch to return the editable value for

Returns:

The string representation of the editable value, or null when the value is not editable.

setValue

default boolean setValue(Watch watch,
                         String value)

Set a watch value as a response to finished editing. This method is called only when a prior call to getEditableValue(org.netbeans.api.debugger.Watch) returns a non-null value.
The default implementation throws UnsupportedOperationException.

Parameters:

watch - The watch to set the value for.

value - The new watch value.

Returns:

true when the value was set successfully and the UI should get updated from getValue(org.netbeans.api.debugger.Watch), false when the set fails and the last watch value should stay. The implementation is responsible for any error reporting when the set fails.

getHeadActions

default Action[] getHeadActions(Watch watch)

Get actions to be displayed at the head of pin watch component. Typically, you put an expansion action there. The default implementation returns null.

Parameters:

watch - The watch to get the actions for

Returns:

An array of actions or null elements (for action separators), or null when no actions should be displayed.

getTailActions

default Action[] getTailActions(Watch watch)

Get actions to be displayed at the tail of pin watch component. Typically, you put a details action there, which displays a detailed view of the watch value. These actions, if any, are followed by comment and close actions, which are always present. The default implementation returns null.

Parameters:

watch - The watch to get the actions for

Returns:

An array of actions or null elements (for action separators), or null when no actions should be displayed.

setChangeListener

void setChangeListener(Watch watch,
                       PinWatchUISupport.ValueProvider.ValueChangeListener chl)

Allows to set a value change listener for a specific watch.

Parameters:

watch - The watch to listen for changes

chl - The value change listener.

unsetChangeListener

void unsetChangeListener(Watch watch)

Unset a value change listener for a specific watch. Use this method to unregister the listeners and free up associated resources.

Parameters:

watch - The watch to unset the listener from.