Package com.vladsch.flexmark.ext.macros

Class MacroReference

java.lang.Object

com.vladsch.flexmark.util.ast.Node

com.vladsch.flexmark.ext.macros.MacroReference

All Implemented Interfaces:

DelimitedNode, DoNotDecorate, ReferencingNode<MacroDefinitionRepository,MacroDefinitionBlock>, TextContainer

public class MacroReference
extends Node
implements DelimitedNode, DoNotDecorate, ReferencingNode<MacroDefinitionRepository,MacroDefinitionBlock>

A MacroReference node

Nested Class Summary

Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.ast.TextContainer

TextContainer.Flags

Field Summary

Fields

Modifier and Type	Field	Description
protected BasedSequence	closingMarker
protected MacroDefinitionBlock	myMacroDefinitionBlock
protected BasedSequence	openingMarker
protected BasedSequence	text

Fields inherited from class com.vladsch.flexmark.util.ast.Node

AST_ADAPTER, EMPTY_SEGMENTS, SPLICE

Fields inherited from interface com.vladsch.flexmark.util.ast.TextContainer

F_ADD_SPACES_BETWEEN_NODES, F_FOR_HEADING_ID, F_LINK_ANCHOR, F_LINK_NODE_TEXT, F_LINK_PAGE_REF, F_LINK_TEXT, F_LINK_TEXT_TYPE, F_LINK_URL, F_NO_TRIM_REF_TEXT_END, F_NO_TRIM_REF_TEXT_START, F_NODE_TEXT

Constructor Summary

Constructors

Constructor	Description
MacroReference()
MacroReference(BasedSequence chars)
MacroReference(BasedSequence openingMarker, BasedSequence text, BasedSequence closingMarker)

Method Summary

Modifier and Type	Method	Description
void	getAstExtra(@NotNull StringBuilder out)
BasedSequence	getClosingMarker()
MacroDefinitionBlock	getMacroDefinitionBlock()
MacroDefinitionBlock	getMacroDefinitionBlock(MacroDefinitionRepository repository)
BasedSequence	getOpeningMarker()
@NotNull BasedSequence	getReference()
MacroDefinitionBlock	getReferenceNode(MacroDefinitionRepository repository)
MacroDefinitionBlock	getReferenceNode(Document document)
@NotNull BasedSequence[]	getSegments()
BasedSequence	getText()
boolean	isDefined()
void	setClosingMarker(BasedSequence closingMarker)
void	setMacroDefinitionBlock(MacroDefinitionBlock macroDefinitionBlock)
void	setOpeningMarker(BasedSequence openingMarker)
void	setText(BasedSequence text)

Methods inherited from class com.vladsch.flexmark.util.ast.Node

appendChain, appendChild, astChars, astExtraChars, astString, baseSubSequence, baseSubSequence, countAncestorsOfType, countDirectAncestorsOfType, delimitedSegmentSpan, delimitedSegmentSpanChars, endOfLine, extractChainTo, extractToFirstInChain, getAncestorOfType, getBaseSequence, getBlankLineSibling, getChars, getCharsFromSegments, getChildChars, getChildIterator, getChildOfType, getChildren, getDescendants, getDocument, getEmptyPrefix, getEmptySuffix, getEndLineNumber, getEndOffset, getEndOfLine, getExactChildChars, getFirstChild, getFirstChildAny, getFirstChildAnyNot, getFirstInChain, getGrandParent, getLastBlankLineChild, getLastChild, getLastChildAny, getLastChildAnyNot, getLastInChain, getLeadSegment, getLineColumnAtEnd, getLineNumber, getNext, getNextAny, getNextAnyNot, getNodeName, getNodeOfTypeIndex, getNodeOfTypeIndex, getOldestAncestorOfTypeAfter, getParent, getPrevious, getPreviousAny, getPreviousAnyNot, getReversedChildIterator, getReversedChildren, getReversedDescendants, getSegmentsForChars, getSourceRange, getStartLineNumber, getStartOffset, getStartOfLine, getTextLength, getTrailSegment, hasChildren, hasOrMoreChildren, insertAfter, insertBefore, insertChainAfter, insertChainBefore, isOrDescendantOfType, lineColumnAtIndex, lineColumnAtStart, moveTrailingBlankLines, prependChild, removeChildren, segmentSpan, segmentSpan, segmentSpanChars, segmentSpanChars, segmentSpanChars, segmentSpanCharsToVisible, setChars, setCharsFromContent, setCharsFromContentOnly, setCharsFromSegments, setParent, spanningChars, startOfLine, takeChildren, toAstString, toSegmentSpan, toString, toStringAttributes, unlink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vladsch.flexmark.util.ast.DelimitedNode

collectText, getChars

Methods inherited from interface com.vladsch.flexmark.util.ast.TextContainer

collectEndText

Field Details

openingMarker

protected BasedSequence openingMarker

text

protected BasedSequence text

closingMarker

protected BasedSequence closingMarker

myMacroDefinitionBlock

protected MacroDefinitionBlock myMacroDefinitionBlock

Constructor Details

MacroReference

public MacroReference()

MacroReference

public MacroReference(BasedSequence chars)

MacroReference

public MacroReference(BasedSequence openingMarker,
 BasedSequence text,
 BasedSequence closingMarker)

Method Details

isDefined

public boolean isDefined()

Specified by:

isDefined in interface ReferencingNode<MacroDefinitionRepository,MacroDefinitionBlock>

getReference

@NotNull
public @NotNull BasedSequence getReference()

Specified by:

getReference in interface ReferencingNode<MacroDefinitionRepository,MacroDefinitionBlock>

getReferenceNode

public MacroDefinitionBlock getReferenceNode(Document document)

Specified by:

getReferenceNode in interface ReferencingNode<MacroDefinitionRepository,MacroDefinitionBlock>

getReferenceNode

public MacroDefinitionBlock getReferenceNode(MacroDefinitionRepository repository)

Specified by:

getReferenceNode in interface ReferencingNode<MacroDefinitionRepository,MacroDefinitionBlock>

getMacroDefinitionBlock

public MacroDefinitionBlock getMacroDefinitionBlock(MacroDefinitionRepository repository)

getMacroDefinitionBlock

public MacroDefinitionBlock getMacroDefinitionBlock()

setMacroDefinitionBlock

public void setMacroDefinitionBlock(MacroDefinitionBlock macroDefinitionBlock)

getSegments

@NotNull
public @NotNull BasedSequence[] getSegments()

Specified by:

getSegments in class Node

getAstExtra

public void getAstExtra(@NotNull
 @NotNull StringBuilder out)

Overrides:

getAstExtra in class Node

getOpeningMarker

public BasedSequence getOpeningMarker()

Specified by:

getOpeningMarker in interface DelimitedNode

setOpeningMarker

public void setOpeningMarker(BasedSequence openingMarker)

Specified by:

setOpeningMarker in interface DelimitedNode

getText

public BasedSequence getText()

Specified by:

getText in interface DelimitedNode

setText

public void setText(BasedSequence text)

Specified by:

setText in interface DelimitedNode

getClosingMarker

public BasedSequence getClosingMarker()

Specified by:

getClosingMarker in interface DelimitedNode

setClosingMarker

public void setClosingMarker(BasedSequence closingMarker)

Specified by:

setClosingMarker in interface DelimitedNode