org.netbeans.spi.jumpto.type

Interface TypeProvider

public interface TypeProvider

A Type Provider participates in the Goto Type dialog by providing TypeDescriptors, one for each matched type, when asked to do so. The Type Providers are registered in Lookup. XXX Should we return a Collection rather than a List?

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypeProvider.Context Represents search context.
static class	TypeProvider.Result Represents a collection of TypeDescriptors that match the given search criteria.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the current operation, if possible.
void	cleanup() The Go To Type dialog is dismissed for now - free up resources if applicable.
void	computeTypeNames(TypeProvider.Context context, TypeProvider.Result result) Compute a list of TypeDescriptors that match the given search text for the given search type.
String	getDisplayName() Describe this provider for the user, in case we want to offer filtering capabilities in the Go To Type dialog
String	name() Describe this provider with an internal name, in case we want to provide some kind of programmatic filtering (e.g.

Method Detail

name

String name()

Describe this provider with an internal name, in case we want to provide some kind of programmatic filtering (e.g. a Java EE dialog wanting to include or omit specific type providers, without relying on class names or localized display names)

Returns:

An internal String uniquely identifying this type provider, such as "java"

getDisplayName

String getDisplayName()

Describe this provider for the user, in case we want to offer filtering capabilities in the Go To Type dialog

Returns:

A display name describing the types being provided by this TypeProvider, such as "Java Types", "Ruby Types", etc.

computeTypeNames

void computeTypeNames(TypeProvider.Context context,
                      TypeProvider.Result result)

Compute a list of TypeDescriptors that match the given search text for the given search type. This might be a slow operation, and the infrastructure may end up calling TypeProvider.cancel() on the same type provider during the operation, in which case the method can return incomplete results. If there is a "current project", the Go To Type infrastructure will perform the search in two passes; first it will call TypeDescriptor.getTypeName() with the current project, which should be a reasonably fast search, and display those types first. It will then call the method again with a null project, which should return all types.

Note that a useful performance optimization is for the TypeProvider to cache a few of its most recent search results, and if the next search (e.g. more user keystrokes) is a simple narrowing of the search, just filter the previous search result. There is an explicit TypeProvider.cleanup() call that the Go To Type dialog will make at the end of the dialog interaction, which can be used to clean up the cache.

Parameters:

context - search context containg search text and type, optionally project

result - filled with type descriptors and optional message

cancel

void cancel()

Cancel the current operation, if possible. This might be called if the user has typed something (including the backspace key) which makes the current search obsolete and a new one should be initiated.

cleanup

void cleanup()

The Go To Type dialog is dismissed for now - free up resources if applicable. (A new "session" will be indicated by a new call to getTypeNames.) This allows the TypeProvider to cache its most recent search result, and if the next search is simply a narrower search, it can just filter the previous result.