Interface Navigator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.List<NavigationPoint> ASYNC_RETRY
      A navigator can return this constant to indicate that the generation of navigation points is in progress.
    • Field Detail

      • ASYNC_RETRY

        static final java.util.List<NavigationPoint> ASYNC_RETRY
        A navigator can return this constant to indicate that the generation of navigation points is in progress. The caller should request the list again later using the same source text.
    • Method Detail

      • getNavigationPoints

        java.util.List<NavigationPoint> getNavigationPoints​(java.lang.String sourceText)
        Parses the specified source text and returns a list of navigation points.
        Parameters:
        sourceText - the source text to determine navigation points for
        Returns:
        a (possibly empty) list of the extracted points