LinkInfo

All Known Implementing Classes:: InlineParserImpl.LinkInfoImpl

public interface LinkInfo

A parsed link/image. There are different types of links.

Inline links:

 [text](destination)
 [text](destination "title")

Reference links, which have different subtypes. Full::

 [text][label]

Collapsed (label is ""):

 [text][]

Shortcut (label is null):

 [text]

Images use the same syntax as links but with a ! marker() front, e.g.


 ![text](destination)

.

Method Summary

Modifier and Type

Method

Description

Position

afterTextBracket()

The position after the closing text bracket, e.g.:

String

destination()

The destination if available, e.g.

String

label()

The label, or null for inline links or for shortcut links (in which case text(Scanner) should be used as the label).

Text

marker()

The marker if present, or null.

Text

openingBracket()

The text node of the opening bracket [.

String

text(Scanner scanner)

The text between the first brackets, e.g.

String

title()

The title if available, e.g.

Method Details
- marker
  
  Text marker()
  
  The marker if present, or null. A marker is e.g. ! for an image, or a custom marker as specified in Parser.Builder.linkMarker(java.lang.Character).
- openingBracket
  
  Text openingBracket()
  
  The text node of the opening bracket [.
- text
  
  String text(Scanner scanner)
  
  The text between the first brackets, e.g. `foo` in `[foo][bar]`.
  Call this during link processing with the scanner passed to LinkProcessor.process(org.commonmark.parser.beta.LinkInfo, org.commonmark.parser.beta.Scanner, org.commonmark.parser.InlineParserContext). The text is extracted without changing the scanner's position.
  
  Parameters:
  
  scanner - the scanner passed to the link processor
- label
  
  String label()
  
  The label, or null for inline links or for shortcut links (in which case text(Scanner) should be used as the label).
- destination
  
  String destination()
  
  The destination if available, e.g. in `[foo](destination)`, or null
- title
  
  String title()
  
  The title if available, e.g. in `[foo](destination "title")`, or null
- afterTextBracket
  
  Position afterTextBracket()
  The position after the closing text bracket, e.g.:
  [foo][bar] ^