SearchProvider (Search API)

java.lang.Object
- org.netbeans.spi.search.provider.SearchProvider

public abstract class SearchProvider
extends java.lang.Object

Search provider can register complex search feature to the IDE.

Example:

 // use annotation to register this provider
 @ServiceProvider(service = SearchProvider.class)
 public class ExampleSearchProvider extends SearchProvider {

   // Create presenter
   public Presenter createPresenter(boolean replaceMode) {
       return new BasicSearchPresenter(replaceMode);
   }

   // Replacing is supported.
   public boolean isReplaceSupported() {
       return true;
   }
   
   // This search provider is always enabled.
   public boolean isEnabled() {
       return true; // could be disabled on some platforms
   }
 }

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchProvider.Presenter
Presenter for search provider.

Nested Classes
Modifier and Type	Class	Description
`static class`	`SearchProvider.Presenter`	Presenter for search provider.

Constructor Summary

Constructors
Modifier Constructor Description

protected SearchProvider()
Constructor for subclasses.

Constructors
Modifier	Constructor	Description
`protected`	`SearchProvider()`	Constructor for subclasses.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract SearchProvider.Presenter`	`createPresenter(boolean replaceMode)`	Create presenter for this search provider.
`abstract java.lang.String`	`getTitle()`	Get title to show in a tab of the search dialog.
`abstract boolean`	`isEnabled()`	Tells whether this search provider is enabled.
`abstract boolean`	`isReplaceSupported()`	If replace is supported, this dialog will be shown in replace dialog.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SearchProvider
```
protected SearchProvider()
```
    Constructor for subclasses.
- Method Detail
  - createPresenter
```
@NonNull
public abstract SearchProvider.Presenter createPresenter(boolean replaceMode)
```
    Create presenter for this search provider.
    
    Parameters:
    
    replaceMode - True if the presenter will be used in Replace dialog, false if it will be used in Find dialog.
    
    Returns:
    
    New presenter that will be used in the search dialog.
  - getTitle
```
@NonNull
public abstract java.lang.String getTitle()
```
    Get title to show in a tab of the search dialog.
    
    Returns:
    
    Localized title for this search provider.
  - isReplaceSupported
```
public abstract boolean isReplaceSupported()
```
    If replace is supported, this dialog will be shown in replace dialog.
    
    Returns:
    
    True if replace is supported by this type of search, false otherwise.
  - isEnabled
```
public abstract boolean isEnabled()
```
    Tells whether this search provider is enabled. It can depend on operating system, type of opened projects, or available databases.
    
    Returns:
    
    True if this provider is enabled at the moment, false otherwise.

Class SearchProvider

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchProvider

Method Detail

createPresenter

getTitle

isReplaceSupported

isEnabled