Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	FootnoteLinkRefProcessor.Factory

Modifier and Type	Field and Description
pack-priv static final int	BRACKET_NESTING_LEVEL
private final FootnoteRepository	footnoteRepository
pack-priv static final boolean	WANT_EXCLAMATION_PREFIX

Constructor Summary

Access	Constructor and Description
public	FootnoteLinkRefProcessor(Document document)

Method Summary

Modifier and Type	Method and Description
public @NotNull BasedSequence	adjustInlineText(@NotNull Document document, @NotNull Node node)
public boolean	allowDelimiters(@NotNull BasedSequence chars, @NotNull Document document, @NotNull Node node)
public @NotNull Node	createNode(@NotNull BasedSequence nodeChars)
public int	getBracketNestingLevel() Implements com.vladsch.flexmark.parser.LinkRefProcessor.getBracketNestingLevel. Whether the element consists of nested [] inside the link ref.
public boolean	getWantExclamationPrefix() Implements com.vladsch.flexmark.parser.LinkRefProcessor.getWantExclamationPrefix. Whether the image ref is desired, if not then !
public boolean	isMatch(@NotNull BasedSequence nodeChars)
public void	updateNodeElements(@NotNull Document document, @NotNull Node node)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BRACKET_NESTING_LEVEL	back to summary
pack-priv static final int BRACKET_NESTING_LEVEL

footnoteRepository	back to summary
private final FootnoteRepository footnoteRepository

WANT_EXCLAMATION_PREFIX	back to summary
pack-priv static final boolean WANT_EXCLAMATION_PREFIX

Constructor Detail

FootnoteLinkRefProcessor	back to summary
public FootnoteLinkRefProcessor(Document document)

Method Detail

adjustInlineText	back to summary
public @NotNull BasedSequence adjustInlineText(@NotNull Document document, @NotNull Node node) Annotations @NotNull @Override

allowDelimiters	back to summary
public boolean allowDelimiters(@NotNull BasedSequence chars, @NotNull Document document, @NotNull Node node) Annotations @Override

createNode	back to summary
public @NotNull Node createNode(@NotNull BasedSequence nodeChars) Annotations @NotNull @Override

getBracketNestingLevel back to summary

getBracketNestingLevel	back to summary
public int getBracketNestingLevel() Implements com.vladsch.flexmark.parser.LinkRefProcessor.getBracketNestingLevel. Doc from com.vladsch.flexmark.parser.LinkRefProcessor.getBracketNestingLevel. 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 Returns:int desired nesting level for references, `>0` for nested, 0 for not nested Annotations @Override

public int getBracketNestingLevel()

Implements com.vladsch.flexmark.parser.LinkRefProcessor.getBracketNestingLevel.

Doc from com.vladsch.flexmark.parser.LinkRefProcessor.getBracketNestingLevel.

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

Returns:int

desired nesting level for references, >0 for nested, 0 for not nested

Annotations

@Override

getWantExclamationPrefix	back to summary
public boolean getWantExclamationPrefix() Implements com.vladsch.flexmark.parser.LinkRefProcessor.getWantExclamationPrefix. Doc from com.vladsch.flexmark.parser.LinkRefProcessor.getWantExclamationPrefix. Whether the image ref is desired, if not then ! will be stripped off the prefix and treated as plain text Returns:boolean true if ! is part of the desired element, false otherwise Annotations @Override

getWantExclamationPrefix

back to summary

public boolean getWantExclamationPrefix()

Implements com.vladsch.flexmark.parser.LinkRefProcessor.getWantExclamationPrefix.

Doc from com.vladsch.flexmark.parser.LinkRefProcessor.getWantExclamationPrefix.

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

Returns:boolean

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

Annotations

@Override

isMatch	back to summary
public boolean isMatch(@NotNull BasedSequence nodeChars) Annotations @Override

updateNodeElements	back to summary
public void updateNodeElements(@NotNull Document document, @NotNull Node node) Annotations @Override

com.vladsch.flexmark.ext.footnotes.internal back to summary

public Class FootnoteLinkRefProcessor.Factory

Class Inheritance

extends Object
implements LinkRefProcessorFactory

java.lang.Object
com.vladsch.flexmark.ext.footnotes.internal.FootnoteLinkRefProcessor.Factory

All Implemented Interfaces

com.vladsch.flexmark.parser.LinkRefProcessorFactory, java.util.function.Function

Constructor Summary

Access	Constructor and Description
public	Factory()

Method Summary

Modifier and Type	Method and Description
public @NotNull LinkRefProcessor	apply(@NotNull Document the function argument document) Implements java.util.function.Function.apply. Applies this function to the given argument.
public int	getBracketNestingLevel(@NotNull DataHolder options)
public boolean	getWantExclamationPrefix(@NotNull DataHolder options)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Factory	back to summary
public Factory()

Method Detail

apply	back to summary
public @NotNull LinkRefProcessor apply(@NotNull Document document) Implements java.util.function.Function.apply. Doc from java.util.function.Function.apply. Applies this function to the given argument. Parameters document:@NotNull Document the function argument Returns:@NotNull LinkRefProcessor the function result Annotations @NotNull @Override

apply

back to summary

public @NotNull LinkRefProcessor apply(@NotNull Document document)

Implements java.util.function.Function.apply.

Doc from java.util.function.Function.apply.

Applies this function to the given argument.

Parameters