Interface ReferenceFinder

All Known Implementing Classes:
AnnotationReferenceFinder, KeywordReferenceFinder, NewExpressionReferenceFinder, PlatformMemberReferenceFinder, ReferenceIndexReferenceFinder, SourceDefinedSymbolDeclarationReferenceFinder
public interface ReferenceFinder
Интерфейс поискового движка.

URI документа — тот, под которым документ зарегистрирован в контексте (DocumentContext.getUri()): поиск его не нормализует.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<Reference>
    findReference(URI uri, TerminalNode terminal)
    Поиск символа по уже известному терминалу-идентификатору — без спуска по AST от корня к позиции.
    Optional<Reference>
    findReference(URI uri, Position position)
    Поиск символа по позиции курсора.
    default Optional<Symbol>
    findTargetSymbol(URI uri, TerminalNode terminal)
    Целевой символ по терминалу без обязательного построения полной ссылки.

  • Method Details

    • findReference

      Optional<Reference> findReference(URI uri, Position position)
      Поиск символа по позиции курсора.
      Parameters:
      uri - URI документа, в котором необходимо осуществить поиск.
      position - позиция курсора.
      Returns:
      данные ссылки.

    • findReference

      default Optional<Reference> findReference(URI uri, TerminalNode terminal)
      Поиск символа по уже известному терминалу-идентификатору — без спуска по AST от корня к позиции. Реализация по умолчанию делегирует в findReference(URI, Position) по стартовой позиции терминала (полное поведенческое соответствие позиционному варианту). Finder'ы, чья стоимость — именно этот спуск (findTerminalNodeContainsPosition и аналоги), переопределяют метод на подъём вверх от terminal.
      Parameters:
      uri - URI документа, в котором необходимо осуществить поиск.
      terminal - терминал-идентификатор под курсором.
      Returns:
      данные ссылки.

    • findTargetSymbol

      default Optional<Symbol> findTargetSymbol(URI uri, TerminalNode terminal)
      Целевой символ по терминалу без обязательного построения полной ссылки. По умолчанию сохраняет терминальный путь конкретного поисковика.
      Parameters:
      uri - URI документа.
      terminal - терминал обращения.
      Returns:
      доступная цель ссылки.