Package org.yamcs.studio.autocomplete

Interface IAutoCompleteProvider

All Known Implementing Classes:

AutoCompleteHistoryProvider, FormulaFunctionProvider, LocalContentProvider, OpsContentProvider, ParameterContentProvider, RawContentProvider, SimContentProvider, StateContentProvider, SysContentProvider

public interface IAutoCompleteProvider

Interface for auto-complete providers. Each parser is provided via OSGI services. The listResult method is executed by AutoCompleteService in a dedicated thread.

Method Summary

Modifier and Type	Method	Description
boolean	accept(ContentType type)
void	cancel()	Called by AutoCompleteService when the task is canceled.
AutoCompleteResult	listResult(ContentDescriptor desc, int limit)

Method Details

accept

boolean accept(ContentType type)

Returns:

true if provider handles this type of content

listResult

AutoCompleteResult listResult(ContentDescriptor desc,
 int limit)

Returns:

AutoCompleteResult matching the provided ContentDescriptor

cancel

void cancel()

Called by AutoCompleteService when the task is canceled.