org.eclipse.lemminx.extensions.contentmodel.participants.completion

Class AbstractCMCompletionResolver

java.lang.Object

org.eclipse.lemminx.extensions.contentmodel.participants.completion.AbstractCMCompletionResolver

All Implemented Interfaces:

ICompletionItemResolveParticipant

Direct Known Subclasses:

AttributeNameCompletionResolver, AttributeValueCompletionResolver

public abstract class AbstractCMCompletionResolver
extends Object
implements ICompletionItemResolveParticipant

Represents a completion item resolver that resolves the completion item using information from the content model

Field Summary

Fields

Modifier and Type	Field and Description
static String	OFFSET_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractCMCompletionResolver()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addDocumentationToCompletion(ICompletionItemResolverRequest request, org.eclipse.lsp4j.CompletionItem toResolve, DOMElement parentElement, DOMAttr attr) Add the documentation from the content model to the given completion request.
org.eclipse.lsp4j.CompletionItem	resolveCompletionItem(ICompletionItemResolverRequest request, org.eclipse.lsp4j.jsonrpc.CancelChecker cancelChecker) Returns the completion item with the remaining fields resolved.

Methods inherited from class java.lang.Object

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

Field Detail

OFFSET_KEY

public static final String OFFSET_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractCMCompletionResolver

public AbstractCMCompletionResolver()

Method Detail

resolveCompletionItem

public org.eclipse.lsp4j.CompletionItem resolveCompletionItem(ICompletionItemResolverRequest request,
                                                              org.eclipse.lsp4j.jsonrpc.CancelChecker cancelChecker)

Description copied from interface: ICompletionItemResolveParticipant

Returns the completion item with the remaining fields resolved.

Specified by:

resolveCompletionItem in interface ICompletionItemResolveParticipant

Parameters:

request - the completion item resolve request

cancelChecker - the cancel checker

Returns:

the completion item with the remaining fields resolved

addDocumentationToCompletion

protected abstract void addDocumentationToCompletion(ICompletionItemResolverRequest request,
                                                     org.eclipse.lsp4j.CompletionItem toResolve,
                                                     DOMElement parentElement,
                                                     DOMAttr attr)

Add the documentation from the content model to the given completion request.

Parameters:

request - the completion resolve request

toResolve - the unresolved completion item to resolve

parentElement - the parent element to where completion was opened on

attr - the attribute that completion was opened on, may be null