Package org.eclipse.xtext.ide.server.symbol

Interface IDocumentSymbolService

All Known Implementing Classes:

DocumentSymbolService, HierarchicalDocumentSymbolService, IDocumentSymbolService.Noop

@Beta
public interface IDocumentSymbolService

Common service interface for providing document symbol information for text documents.

For more details, see the textDocument/documentSymbol LSP method.

This interface is not meant to be injected. Use the DocumentSymbolService and the HierarchicalDocumentSymbolService directly instead.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IDocumentSymbolService.Noop

Method Summary

Modifier and Type	Method	Description
java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<org.eclipse.lsp4j.SymbolInformation,org.eclipse.lsp4j.DocumentSymbol>>	getSymbols(Document document, org.eclipse.xtext.resource.XtextResource resource, org.eclipse.lsp4j.DocumentSymbolParams params, org.eclipse.xtext.util.CancelIndicator cancelIndicator)

Method Detail

getSymbols

java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<org.eclipse.lsp4j.SymbolInformation,org.eclipse.lsp4j.DocumentSymbol>> getSymbols(Document document,
                                                                                                                                                 org.eclipse.xtext.resource.XtextResource resource,
                                                                                                                                                 org.eclipse.lsp4j.DocumentSymbolParams params,
                                                                                                                                                 org.eclipse.xtext.util.CancelIndicator cancelIndicator)