Package com.vladsch.flexmark.util.ast

Interface IParse

  • public interface IParse
    Interface to generic parser for RenderingTestCase customizations

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable com.vladsch.flexmark.util.data.DataHolder getOptions()
      Get Options for parsing
      @NotNull Node parse​(@NotNull com.vladsch.flexmark.util.sequence.BasedSequence input)
      Parse the specified input text into a tree of nodes.
      @NotNull Node parse​(@NotNull String input)
      Parse the specified input text into a tree of nodes.
      @NotNull Node parseReader​(@NotNull Reader input)
      Parse the specified reader into a tree of nodes.
      boolean transferReferences​(@NotNull Document document, @NotNull Document included, @Nullable Boolean onlyIfUndefined)
      Transfer reference definition between documents

    • Method Detail

      • parse

        @NotNull
@NotNull Node parse​(@NotNull
                    @NotNull com.vladsch.flexmark.util.sequence.BasedSequence input)
        Parse the specified input text into a tree of nodes.

        Note that this method is thread-safe (a new parser state is used for each invocation).

        Parameters:
        input - the text to parse
        Returns:
        the root node

      • parse

        @NotNull
@NotNull Node parse​(@NotNull
                    @NotNull String input)
        Parse the specified input text into a tree of nodes.

        Note that this method is thread-safe (a new parser state is used for each invocation).

        Parameters:
        input - the text to parse
        Returns:
        the root node

      • parseReader

        @NotNull
@NotNull Node parseReader​(@NotNull
                          @NotNull Reader input)
                   throws IOException
        Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader.

        Note that this method is thread-safe (a new parser state is used for each invocation).

        Parameters:
        input - the reader to parse
        Returns:
        the root node
        Throws:
        IOException - when reading throws an exception

      • getOptions

        @Nullable
@Nullable com.vladsch.flexmark.util.data.DataHolder getOptions()
        Get Options for parsing
        Returns:
        DataHolder for options

      • transferReferences

        boolean transferReferences​(@NotNull
                           @NotNull Document document,
                           @NotNull
                           @NotNull Document included,
                           @Nullable
                           @Nullable Boolean onlyIfUndefined)
        Transfer reference definition between documents
        Parameters:
        document - destination document
        included - source document
        onlyIfUndefined - true if only should transfer references not already defined in the destination document, false to transfer all, null to use repository's KEEP_TYPE to make the determination (if KEEP_FIRST then only transfer if undefined,
        Returns:
        true if any references were transferred