Package com.intellij.xdebugger.frame

Class XValueMarkerProvider<V extends XValue,M>

java.lang.Object

com.intellij.xdebugger.frame.XValueMarkerProvider<V,M>

Direct Known Subclasses:

JavaValueMarker

public abstract class XValueMarkerProvider<V extends XValue,M>
extends java.lang.Object

Provides implementation of 'Mark Object' feature.

If debugger values have unique ids just return these ids from getMarker(XValue) method. Alternatively implement markValue(XValue) to store a value in some registry and implement unmarkValue(XValue, Object) to remote it from the registry. In such a case the getMarker(XValue) method can return null if the value isn't marked.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XValueMarkerProvider(java.lang.Class<V> valueClass)

Method Summary

Modifier and Type	Method and Description
abstract boolean	canMark(V value)
abstract M	getMarker(V value) This method is used to determine whether the value was marked or not.
java.lang.Class<V>	getValueClass()
M	markValue(V value) This method is called when 'Mark Object' action is invoked.
void	unmarkValue(V value, M marker) This method is called when 'Unmark Object' action is invoked.

Methods inherited from class java.lang.Object

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

Constructor Detail

XValueMarkerProvider

protected XValueMarkerProvider(java.lang.Class<V> valueClass)

Method Detail

canMark

public abstract boolean canMark(V value)

Returns:

true if 'Mark Object' action should be enabled for value

getMarker

public abstract M getMarker(V value)

This method is used to determine whether the value was marked or not. The returned object is compared using Object.equals(Object) method with markers returned by markValue(XValue) methods.

This method may return null if the value wasn't marked by markValue(XValue) method.

Returns:

a marker for value

markValue

public M markValue(V value)

This method is called when 'Mark Object' action is invoked. Return an unique marker for value and store it in some registry if necessary.

Returns:

a marker for value

unmarkValue

public void unmarkValue(V value,
                        M marker)

This method is called when 'Unmark Object' action is invoked.

getValueClass

public final java.lang.Class<V> getValueClass()