Package com.vladsch.flexmark.ext.macros

Class MacroReference

  • All Implemented Interfaces:
    com.vladsch.flexmark.util.ast.DelimitedNode, com.vladsch.flexmark.util.ast.DoNotDecorate, com.vladsch.flexmark.util.ast.ReferencingNode<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository,​MacroDefinitionBlock>, com.vladsch.flexmark.util.ast.TextContainer
    public class MacroReference
extends com.vladsch.flexmark.util.ast.Node
implements com.vladsch.flexmark.util.ast.DelimitedNode, com.vladsch.flexmark.util.ast.DoNotDecorate, com.vladsch.flexmark.util.ast.ReferencingNode<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository,​MacroDefinitionBlock>
    A MacroReference node

    • Nested Class Summary

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

        com.vladsch.flexmark.util.ast.TextContainer.Flags

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vladsch.flexmark.util.sequence.BasedSequence closingMarker  
      protected MacroDefinitionBlock myMacroDefinitionBlock  
      protected com.vladsch.flexmark.util.sequence.BasedSequence openingMarker  
      protected com.vladsch.flexmark.util.sequence.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​(com.vladsch.flexmark.util.sequence.BasedSequence chars)  
      MacroReference​(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker, com.vladsch.flexmark.util.sequence.BasedSequence text, com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void getAstExtra​(@NotNull StringBuilder out)  
      com.vladsch.flexmark.util.sequence.BasedSequence getClosingMarker()  
      MacroDefinitionBlock getMacroDefinitionBlock()  
      MacroDefinitionBlock getMacroDefinitionBlock​(com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository repository)  
      com.vladsch.flexmark.util.sequence.BasedSequence getOpeningMarker()  
      @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getReference()  
      MacroDefinitionBlock getReferenceNode​(com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository repository)  
      MacroDefinitionBlock getReferenceNode​(com.vladsch.flexmark.util.ast.Document document)  
      @NotNull com.vladsch.flexmark.util.sequence.BasedSequence[] getSegments()  
      com.vladsch.flexmark.util.sequence.BasedSequence getText()  
      boolean isDefined()  
      void setClosingMarker​(com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)  
      void setMacroDefinitionBlock​(MacroDefinitionBlock macroDefinitionBlock)  
      void setOpeningMarker​(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker)  
      void setText​(com.vladsch.flexmark.util.sequence.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 interface com.vladsch.flexmark.util.ast.DelimitedNode

        collectText, getChars

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

        collectEndText

    • Field Detail

      • openingMarker

        protected com.vladsch.flexmark.util.sequence.BasedSequence openingMarker

      • text

        protected com.vladsch.flexmark.util.sequence.BasedSequence text

      • closingMarker

        protected com.vladsch.flexmark.util.sequence.BasedSequence closingMarker

    • Constructor Detail

      • MacroReference

        public MacroReference()

      • MacroReference

        public MacroReference​(com.vladsch.flexmark.util.sequence.BasedSequence chars)

      • MacroReference

        public MacroReference​(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker,
                      com.vladsch.flexmark.util.sequence.BasedSequence text,
                      com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)

    • Method Detail

      • isDefined

        public boolean isDefined()
        Specified by:
        isDefined in interface com.vladsch.flexmark.util.ast.ReferencingNode<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository,​MacroDefinitionBlock>

      • getReference

        @NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence getReference()
        Specified by:
        getReference in interface com.vladsch.flexmark.util.ast.ReferencingNode<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository,​MacroDefinitionBlock>

      • getReferenceNode

        public MacroDefinitionBlock getReferenceNode​(com.vladsch.flexmark.util.ast.Document document)
        Specified by:
        getReferenceNode in interface com.vladsch.flexmark.util.ast.ReferencingNode<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository,​MacroDefinitionBlock>

      • getReferenceNode

        public MacroDefinitionBlock getReferenceNode​(com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository repository)
        Specified by:
        getReferenceNode in interface com.vladsch.flexmark.util.ast.ReferencingNode<com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository,​MacroDefinitionBlock>

      • getMacroDefinitionBlock

        public MacroDefinitionBlock getMacroDefinitionBlock​(com.vladsch.flexmark.ext.macros.internal.MacroDefinitionRepository repository)

      • setMacroDefinitionBlock

        public void setMacroDefinitionBlock​(MacroDefinitionBlock macroDefinitionBlock)

      • getSegments

        @NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence[] getSegments()
        Specified by:
        getSegments in class com.vladsch.flexmark.util.ast.Node

      • getAstExtra

        public void getAstExtra​(@NotNull
                        @NotNull StringBuilder out)
        Overrides:
        getAstExtra in class com.vladsch.flexmark.util.ast.Node

      • getOpeningMarker

        public com.vladsch.flexmark.util.sequence.BasedSequence getOpeningMarker()
        Specified by:
        getOpeningMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode

      • setOpeningMarker

        public void setOpeningMarker​(com.vladsch.flexmark.util.sequence.BasedSequence openingMarker)
        Specified by:
        setOpeningMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode

      • getText

        public com.vladsch.flexmark.util.sequence.BasedSequence getText()
        Specified by:
        getText in interface com.vladsch.flexmark.util.ast.DelimitedNode

      • setText

        public void setText​(com.vladsch.flexmark.util.sequence.BasedSequence text)
        Specified by:
        setText in interface com.vladsch.flexmark.util.ast.DelimitedNode

      • getClosingMarker

        public com.vladsch.flexmark.util.sequence.BasedSequence getClosingMarker()
        Specified by:
        getClosingMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode

      • setClosingMarker

        public void setClosingMarker​(com.vladsch.flexmark.util.sequence.BasedSequence closingMarker)
        Specified by:
        setClosingMarker in interface com.vladsch.flexmark.util.ast.DelimitedNode