org.netbeans.spi.search.provider

Class SearchComposition<R>

java.lang.Object

org.netbeans.spi.search.provider.SearchComposition<R>

public abstract class SearchComposition<R>
extends Object

Object that encapsulates search state, settings and provides access to its results displayer.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchComposition() Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
abstract SearchResultsDisplayer<R>	getSearchResultsDisplayer() Get results displayer.
abstract boolean	isTerminated() Tells whether the search has been terminated.
abstract void	start(SearchListener listener) Start searching.
abstract void	terminate() Terminate searching.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchComposition

protected SearchComposition()

Constructor for subclasses.

Method Detail

start

public abstract void start(@NonNull
                           SearchListener listener)

Start searching.

terminate

public abstract void terminate()

Terminate searching.

isTerminated

public abstract boolean isTerminated()

Tells whether the search has been terminated.

Returns:

False if search has not been started yet, is still in progress, or has finished normally. True if the search has been terminated.

getSearchResultsDisplayer

@NonNull
public abstract SearchResultsDisplayer<R> getSearchResultsDisplayer()

Get results displayer. All invocations of this method on a this object should return identical object.