Package org.eclipse.lemminx.customservice.synapse.expression.pojo

Class ExpressionCompletionRequest

java.lang.Object

org.eclipse.lemminx.customservice.synapse.expression.pojo.ExpressionCompletionRequest

All Implemented Interfaces:

ICompletionRequest, IPositionRequest, ISharedSettingsRequest

public class ExpressionCompletionRequest
extends Object
implements ICompletionRequest

Constructor Summary

Constructors

Constructor	Description
ExpressionCompletionRequest(DOMDocument xmlDocument, org.eclipse.lsp4j.Position position)
ExpressionCompletionRequest(DOMDocument xmlDocument, org.eclipse.lsp4j.Position position, int offset)

Method Summary

Modifier and Type	Method	Description
boolean	canSupportMarkupKind(String kind)	Returns true if the client can support the given Markup kind for documentation and false otherwise.
<T> T	getComponent(Class clazz)
DOMAttr	getCurrentAttribute()
String	getCurrentAttributeName()
String	getCurrentTag()
String	getFilterForStartTagName(String tagName)
String	getInsertAttrValue(String value)
org.eclipse.lsp4j.InsertTextFormat	getInsertTextFormat()	Returns the proper insert text format according the support of snippet.
LineIndentInfo	getLineIndentInfo()	Returns the line indent information of the offset where completion was triggered.
DOMNode	getNode()	Returns the node where completion was triggered.
int	getOffset()	Returns the offset where completion was triggered.
DOMElement	getParentElement()	Returns the parent element of the node where completion was triggered and null otherwise.
org.eclipse.lsp4j.Position	getPosition()	Returns the position
org.eclipse.lsp4j.Range	getReplaceRange()	Returns the replace range.
org.eclipse.lsp4j.Range	getReplaceRangeForTagName()	Returns the range for replacing a tag name for an existing DOM element.
SharedSettings	getSharedSettings()	Returns the sharedSettings instance
DOMDocument	getXMLDocument()	Returns the XML document.
XMLGenerator	getXMLGenerator()
boolean	isAutoCloseTags()	Returns true if tag should be autoclosed with an end tag and false otherwise.
boolean	isCompletionSnippetsSupported()	Returns true if the client support snippet and false otherwise.
boolean	isResolveAdditionalTextEditsSupported()	Returns true if the editor supports delayed resolution of additionalTextEdits and false otherwise.
boolean	isResolveDocumentationSupported()	Returns true if the editor supports delayed resolution of documentation and false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Details

ExpressionCompletionRequest

public ExpressionCompletionRequest(DOMDocument xmlDocument,
 org.eclipse.lsp4j.Position position)

ExpressionCompletionRequest

public ExpressionCompletionRequest(DOMDocument xmlDocument,
 org.eclipse.lsp4j.Position position,
 int offset)

Method Details

getOffset

public int getOffset()

Description copied from interface: IPositionRequest

Returns the offset where completion was triggered.

Specified by:

getOffset in interface IPositionRequest

Returns:

the offset where completion was triggered

getPosition

public org.eclipse.lsp4j.Position getPosition()

Description copied from interface: IPositionRequest

Returns the position

Specified by:

getPosition in interface IPositionRequest

Returns:

the position

getNode

public DOMNode getNode()

Description copied from interface: IPositionRequest

Returns the node where completion was triggered.

Specified by:

getNode in interface IPositionRequest

Returns:

the offset where completion was triggered

getParentElement

public DOMElement getParentElement()

Description copied from interface: IPositionRequest

Returns the parent element of the node where completion was triggered and null otherwise.

Specified by:

getParentElement in interface IPositionRequest

Returns:

the parent element of the node where completion was triggered and null otherwise.

getXMLDocument

public DOMDocument getXMLDocument()

Description copied from interface: IPositionRequest

Returns the XML document.

Specified by:

getXMLDocument in interface IPositionRequest

Returns:

the XML document.

getCurrentTag

public String getCurrentTag()

Specified by:

getCurrentTag in interface IPositionRequest

getCurrentAttribute

public DOMAttr getCurrentAttribute()

Specified by:

getCurrentAttribute in interface IPositionRequest

getCurrentAttributeName

public String getCurrentAttributeName()

Specified by:

getCurrentAttributeName in interface IPositionRequest

getLineIndentInfo

public LineIndentInfo getLineIndentInfo()
                                 throws BadLocationException

Description copied from interface: IPositionRequest

Returns the line indent information of the offset where completion was triggered.

Specified by:

getLineIndentInfo in interface IPositionRequest

Returns:

Throws:

BadLocationException

getComponent

public <T> T getComponent(Class clazz)

Specified by:

getComponent in interface IPositionRequest

canSupportMarkupKind

public boolean canSupportMarkupKind(String kind)

Description copied from interface: ISharedSettingsRequest

Returns true if the client can support the given Markup kind for documentation and false otherwise.

Specified by:

canSupportMarkupKind in interface ISharedSettingsRequest

Parameters:

kind - the markup kind

Returns:

true if the client can support the given Markup kind for documentation and false otherwise.

getSharedSettings

public SharedSettings getSharedSettings()

Description copied from interface: ISharedSettingsRequest

Returns the sharedSettings instance

Specified by:

getSharedSettings in interface ISharedSettingsRequest

Returns:

the sharedSettings instance

getReplaceRange

public org.eclipse.lsp4j.Range getReplaceRange()

Description copied from interface: ICompletionRequest

Returns the replace range.

Specified by:

getReplaceRange in interface ICompletionRequest

Returns:

the replace range.

getReplaceRangeForTagName

public org.eclipse.lsp4j.Range getReplaceRangeForTagName()

Description copied from interface: ICompletionRequest

Returns the range for replacing a tag name for an existing DOM element.

Specified by:

getReplaceRangeForTagName in interface ICompletionRequest

Returns:

the range for replacing a tag name for an existing DOM element.

getXMLGenerator

public XMLGenerator getXMLGenerator()
                             throws BadLocationException

Specified by:

getXMLGenerator in interface ICompletionRequest

Throws:

BadLocationException

getFilterForStartTagName

public String getFilterForStartTagName(String tagName)

Specified by:

getFilterForStartTagName in interface ICompletionRequest

getInsertAttrValue

public String getInsertAttrValue(String value)

Specified by:

getInsertAttrValue in interface ICompletionRequest

isCompletionSnippetsSupported

public boolean isCompletionSnippetsSupported()

Description copied from interface: ICompletionRequest

Returns true if the client support snippet and false otherwise.

Specified by:

isCompletionSnippetsSupported in interface ICompletionRequest

Returns:

true if the client support snippet and false otherwise.

isAutoCloseTags

public boolean isAutoCloseTags()

Description copied from interface: ICompletionRequest

Returns true if tag should be autoclosed with an end tag and false otherwise.

Specified by:

isAutoCloseTags in interface ICompletionRequest

Returns:

true if tag should be autoclosed with an end tag and false otherwise.

isResolveDocumentationSupported

public boolean isResolveDocumentationSupported()

Description copied from interface: ICompletionRequest

Returns true if the editor supports delayed resolution of documentation and false otherwise.

Specified by:

isResolveDocumentationSupported in interface ICompletionRequest

isResolveAdditionalTextEditsSupported

public boolean isResolveAdditionalTextEditsSupported()

Description copied from interface: ICompletionRequest

Returns true if the editor supports delayed resolution of additionalTextEdits and false otherwise.

Specified by:

isResolveAdditionalTextEditsSupported in interface ICompletionRequest

getInsertTextFormat

public org.eclipse.lsp4j.InsertTextFormat getInsertTextFormat()

Description copied from interface: ICompletionRequest

Returns the proper insert text format according the support of snippet.

Specified by:

getInsertTextFormat in interface ICompletionRequest

Returns:

the proper insert text format according the support of snippet.