org.netbeans.spi.jumpto.symbol

Class SymbolProvider.Result

java.lang.Object

org.netbeans.spi.jumpto.symbol.SymbolProvider.Result

Enclosing interface:

SymbolProvider

public static final class SymbolProvider.Result
extends Object

Represents a collection of SymbolDescriptors that match the given search criteria. Moreover, it can contain message for the user, such as an incomplete search result.

Method Summary

Modifier and Type	Method and Description
void	addResult(List<? extends SymbolDescriptor> symbolDescriptors) Adds list of result descriptors.
void	addResult(SymbolDescriptor symbolDescriptor) Adds result descriptor.
void	pendingResult() Notify caller that a provider should be called again because of incomplete or inaccurate results.
void	setHighlightText(String textToHighlight) Sets a text to highlight in the Go To Symbol panel.
void	setMessage(String msg) Optional message.

Methods inherited from class java.lang.Object

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

Method Detail

setMessage

public void setMessage(String msg)

Optional message. It can inform the user about result, e.g. that result can be incomplete etc.

Parameters:

msg - message

addResult

public void addResult(SymbolDescriptor symbolDescriptor)

Adds result descriptor.

Parameters:

symbolDescriptor - symbol descriptor to be added to result

addResult

public void addResult(List<? extends SymbolDescriptor> symbolDescriptors)

Adds list of result descriptors.

Parameters:

symbolDescriptors - symbol descriptor to be added to result

setHighlightText

public void setHighlightText(@NonNull
                             String textToHighlight)

Sets a text to highlight in the Go To Symbol panel. By default the highlight text matches the text to search SymbolProvider.Context.getText() and SymbolProvider has no need to call this method. When the SymbolProvider changes the text to search and uses a part of it just as a restriction it has to call the method to specify the real search text. For example Java SymbolProvider splits the following text to search "*Util.toF" to restriction regexp for type "*Util" and a new search text "toF". In order to let the infrastructure correctly highlight found elements the Java SymbolProvider needs to call SymbolProvider.Result.setHighlightText(java.lang.String).

Parameters:

textToHighlight - the text to highlight

Throws:

IllegalStateException - when some result was already added or the highlight text was already set.

Since:

1.37

pendingResult

public void pendingResult()

Notify caller that a provider should be called again because of incomplete or inaccurate results. Method can be used when long running task blocks the provider to complete the data.

Since:

1.14