Interface LinkResult

public interface LinkResult
What to do with a link/image processed by LinkProcessor.

  • Method Details

    • none

      static LinkResult none()
      Link not handled by processor.

    • wrapTextIn

      static LinkResult wrapTextIn(Node node, Position position)
      Wrap the link text in a node. This is the normal behavior for links, e.g. for this: 
      [my *text*](destination)
      The text is my *text*, a text node and emphasis. The text is wrapped in a Link node, which means the text is added as child nodes to it.
      Parameters:
      node - the node to which the link text nodes will be added as child nodes
      position - the position to continue parsing from

    • replaceWith

      static LinkResult replaceWith(Node node, Position position)
      Replace the link with a node. E.g. for this: 
      [^foo]
      The processor could decide to create a FootnoteReference node instead which replaces the link.
      Parameters:
      node - the node to replace the link with
      position - the position to continue parsing from

    • includeMarker

      LinkResult includeMarker()
      If a LinkInfo.marker() is present, include it in processing (i.e. treat it the same way as the brackets).