Module io.quarkus.qute.debug

Package io.quarkus.qute.debug.agent.completions

Class CompletionContext

java.lang.Object

io.quarkus.qute.debug.agent.completions.CompletionContext

All Implemented Interfaces:

ValueResolverContext

public class CompletionContext
extends Object
implements ValueResolverContext

Context for collecting code completions in the debugger.

Implements ValueResolverContext and is used when the debugger needs to provide completion suggestions in Qute templates.

Collects properties (fields and string-named) and methods (reflection or string-named) of the base object, storing them as CompletionItem. Can be converted into a CompletionsResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.lsp4j.debug.CompletionItem[]	EMPTY_COMPLETION_ITEMS	Empty array of completion items for DAP responses.

Constructor Summary

Constructors

Constructor	Description
CompletionContext(Object base, RemoteStackFrame stackFrame)

Method Summary

Modifier and Type	Method	Description
void	add(org.eclipse.lsp4j.debug.CompletionItem item)	Adds a completion item if it is not already present.
void	addMethod(Method method)	Registers a method to the context (for completion or variable tracking).
void	addMethod(String method)	Registers a method by name.
void	addProperty(Field field)	Registers a field as a property in the context.
void	addProperty(String property)	Registers a property by name.
Object	getBase()	Returns the base object being inspected.
RemoteStackFrame	getStackFrame()	Returns the current stack frame for the debugger.
boolean	isCollectMethod()	Returns true if the context is collecting methods.
boolean	isCollectProperty()	Returns true if the context is collecting properties.
org.eclipse.lsp4j.debug.CompletionsResponse	toResponse()	Converts collected items to a DAP CompletionsResponse.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_COMPLETION_ITEMS

public static final org.eclipse.lsp4j.debug.CompletionItem[] EMPTY_COMPLETION_ITEMS

Empty array of completion items for DAP responses.

Constructor Details

CompletionContext

public CompletionContext(Object base,
 RemoteStackFrame stackFrame)

Method Details

getBase

public Object getBase()

Description copied from interface: ValueResolverContext

Returns the base object being inspected.

Specified by:

getBase in interface ValueResolverContext

getStackFrame

public RemoteStackFrame getStackFrame()

Description copied from interface: ValueResolverContext

Returns the current stack frame for the debugger.

Specified by:

getStackFrame in interface ValueResolverContext

toResponse

public org.eclipse.lsp4j.debug.CompletionsResponse toResponse()

Converts collected items to a DAP CompletionsResponse.

addMethod

public void addMethod(Method method)

Description copied from interface: ValueResolverContext

Registers a method to the context (for completion or variable tracking).

Specified by:

addMethod in interface ValueResolverContext

addProperty

public void addProperty(Field field)

Description copied from interface: ValueResolverContext

Registers a field as a property in the context.

Specified by:

addProperty in interface ValueResolverContext

addProperty

public void addProperty(String property)

Description copied from interface: ValueResolverContext

Registers a property by name.

Specified by:

addProperty in interface ValueResolverContext

addMethod

public void addMethod(String method)

Description copied from interface: ValueResolverContext

Registers a method by name.

Specified by:

addMethod in interface ValueResolverContext

add

public void add(org.eclipse.lsp4j.debug.CompletionItem item)

Adds a completion item if it is not already present.

isCollectProperty

public boolean isCollectProperty()

Description copied from interface: ValueResolverContext

Returns true if the context is collecting properties.

Specified by:

isCollectProperty in interface ValueResolverContext

isCollectMethod

public boolean isCollectMethod()

Description copied from interface: ValueResolverContext

Returns true if the context is collecting methods.

Specified by:

isCollectMethod in interface ValueResolverContext