org.netbeans.spi.debugger.ui

Class CodeEvaluator.Result<R,H>

java.lang.Object

org.netbeans.spi.debugger.ui.CodeEvaluator.Result<R,H>

Type Parameters:

R - The type of the result object

H - The type of the result history item (CodeEvaluator.Result.DefaultHistoryItem can be used).

Enclosing class:

CodeEvaluator

public static final class CodeEvaluator.Result<R,H>
extends Object

A helper class managing the evaluator result. Use it when "resultsView" is used to visualize the result of evaluation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeEvaluator.Result.DefaultHistoryItem A default implementation of a history item.
static interface	CodeEvaluator.Result.Listener<R> Listener that is notified when result changes.

Method Summary

Modifier and Type	Method and Description
void	addListener(CodeEvaluator.Result.Listener<R> l) Add a result change listener.
static <R,H> CodeEvaluator.Result<R,H>	get(DebuggerEngine engine) Get an instance of Result for the given DebuggerEngine.
String	getExpression() Get the current expression.
List<H>	getHistoryItems() Get the history items.
R	getResult() Get the current result.
void	removeListener(CodeEvaluator.Result.Listener<R> l) Remove a result change listener.
void	setAndOpen(String expression, R result, H historyItem) Set the current expression, it's result and a history item, that is added to the list of history items upon the next evaluation.
void	setMaxHistoryItems(int maxHistoryItems) Set the maximum number of result history items being held.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static <R,H> CodeEvaluator.Result<R,H> get(DebuggerEngine engine)

Get an instance of Result for the given DebuggerEngine. A new instance is created if there is not one available, an existing instance is returned otherwise.

Type Parameters:

R - The type of the result object

H - The type of the result history item

Parameters:

engine - The debugger engine

Returns:

an instance of Result container.

setMaxHistoryItems

public void setMaxHistoryItems(int maxHistoryItems)

Set the maximum number of result history items being held. By default this is 100.

Parameters:

maxHistoryItems - maximum number of history items

setAndOpen

public void setAndOpen(String expression,
                       R result,
                       H historyItem)

Set the current expression, it's result and a history item, that is added to the list of history items upon the next evaluation.

Parameters:

expression - The evaluated expression

result - The result of that expression

historyItem - A history representation of the result

getExpression

public String getExpression()

Get the current expression.

Returns:

the expression set by CodeEvaluator.Result.setAndOpen(java.lang.String, java.lang.Object, java.lang.Object)

getResult

public R getResult()

Get the current result.

Returns:

the result set by CodeEvaluator.Result.setAndOpen(java.lang.String, java.lang.Object, java.lang.Object)

getHistoryItems

public List<H> getHistoryItems()

Get the history items.

Returns:

the history items.

addListener

public void addListener(CodeEvaluator.Result.Listener<R> l)

Add a result change listener.

Parameters:

l - result change listener

removeListener

public void removeListener(CodeEvaluator.Result.Listener<R> l)

Remove a result change listener.

Parameters:

l - result change listener