com.vladsch.flexmark.parser

Interface LinkRefProcessorFactory

All Superinterfaces:

com.vladsch.flexmark.util.ComputableFactory<LinkRefProcessor,com.vladsch.flexmark.ast.Document>

public interface LinkRefProcessorFactory
extends com.vladsch.flexmark.util.ComputableFactory<LinkRefProcessor,com.vladsch.flexmark.ast.Document>

Processing of elements which are based on a link ref: [] or ![] This includes footnote references [^...] and wiki links [[...]]

Method Summary

Modifier and Type	Method and Description
LinkRefProcessor	create(com.vladsch.flexmark.ast.Document document) Create a link ref processor for the document
int	getBracketNestingLevel(com.vladsch.flexmark.util.options.DataHolder options) Whether the element consists of nested [] inside the link ref.
boolean	getWantExclamationPrefix(com.vladsch.flexmark.util.options.DataHolder options) Whether the image ref is desired, if not then ! will be stripped off the prefix and treated as plain text

Method Detail

getWantExclamationPrefix

boolean getWantExclamationPrefix(com.vladsch.flexmark.util.options.DataHolder options)

Whether the image ref is desired, if not then ! will be stripped off the prefix and treated as plain text

Parameters:

options - options

Returns:

true if ! is part of the desired element, false otherwise

getBracketNestingLevel

int getBracketNestingLevel(com.vladsch.flexmark.util.options.DataHolder options)

Whether the element consists of nested [] inside the link ref. For example Wiki link [[]] processor would return 1 Only immediately nested [] are considered. [[ ]] is nesting 1, [ [ ]] is not considered

When >0 then preview of next characters is used and if they will match then inner reference will not be created to allow outer one to match the desired element

Parameters:

options - options

Returns:

nesting level for references, >0 for nesting

create

LinkRefProcessor create(com.vladsch.flexmark.ast.Document document)

Create a link ref processor for the document

Specified by:

create in interface com.vladsch.flexmark.util.ComputableFactory<LinkRefProcessor,com.vladsch.flexmark.ast.Document>

Parameters:

document - on which the processor will work

Returns:

link ref processor