Package org.yamcs.studio.autocomplete.para

Class ParameterContentProvider

java.lang.Object

org.yamcs.studio.autocomplete.para.ParameterContentProvider

All Implemented Interfaces:

IAutoCompleteProvider

Direct Known Subclasses:

RawContentProvider

public class ParameterContentProvider
extends Object
implements IAutoCompleteProvider

PV Name lookup for Yamcs Parameters

AutoCompleteService will re-use one instance of this class for all lookups, calling listResult whenever the user types a new character, using a new thread for each lookup. Before starting a new lookup, however, cancel() is invoked. This means there are never multiple concurrent lookups started on purpose, but a previously started lookup may still continue in its thread in case cancel() has no immediate effect.

Constructor Summary

Constructors

Constructor	Description
ParameterContentProvider()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterContentProvider

public ParameterContentProvider()

Method Details

accept

public boolean accept(ContentType type)

Specified by:

accept in interface IAutoCompleteProvider

Returns:

true if provider handles this type of content

getPrefix

public String getPrefix()

requirePrefix

public boolean requirePrefix()

listResult

public AutoCompleteResult listResult(ContentDescriptor desc,
 int limit)

Specified by:

listResult in interface IAutoCompleteProvider

Returns:

AutoCompleteResult matching the provided ContentDescriptor

cancel

public void cancel()

Description copied from interface: IAutoCompleteProvider

Called by AutoCompleteService when the task is canceled.

Specified by:

cancel in interface IAutoCompleteProvider