Top Fields Constructors Methods
com.vladsch.flexmark.util.ast

public abstract Class Node

extends Object
Class Inheritance
Known Direct Subclasses
com.vladsch.flexmark.util.ast.ContentNode
Imports
com.vladsch.flexmark.util.collection.iteration.ReversiblePeekingIterable, .ReversiblePeekingIterator, com.vladsch.flexmark.util.misc.Pair, .Utils, com.vladsch.flexmark.util.sequence.BasedSequence, .Range, .SegmentedSequence, com.vladsch.flexmark.util.sequence.builder.SequenceBuilder, com.vladsch.flexmark.util.visitor.AstNode, org.jetbrains.annotations.NotNull, .Nullable, java.util.Arrays

Field Summary

Modifier and TypeField and Description
public static final AstNode<Node>
AST_ADAPTER

private @NotNull BasedSequence
chars

public static final BasedSequence[]
EMPTY_SEGMENTS

pack-priv @Nullable Node
firstChild

private @Nullable Node
lastChild

pack-priv @Nullable Node
next

private @Nullable Node
parent

private @Nullable Node
prev

public static final String
SPLICE

Constructor Summary

AccessConstructor and Description
public
Node()

public
Node(@NotNull BasedSequence chars)

Method Summary

Modifier and TypeMethod and Description
public void
appendChain(@NotNull Node
first child in chain
firstNode)

Append all from child to end of chain to this node

public void
appendChild(Node child)

public static void
astChars(@NotNull StringBuilder out, @NotNull CharSequence chars, @NotNull String name)

public void
astExtraChars(@NotNull StringBuilder out)

public void
astString(@NotNull StringBuilder out, boolean withExtra)

public BasedSequence
baseSubSequence(int startIndex, int endIndex)

public BasedSequence
baseSubSequence(int startIndex)

public int
countAncestorsOfType(@NotNull Class<?>... classes)

public int
countDirectAncestorsOfType(@Nullable Class<?> skip, @NotNull Class<?>... classes)

public static void
delimitedSegmentSpan(@NotNull StringBuilder out, @NotNull BasedSequence openingSequence, @NotNull BasedSequence sequence, @NotNull BasedSequence closingSequence, @NotNull String name)

public static void
delimitedSegmentSpanChars(@NotNull StringBuilder out, @NotNull BasedSequence openingSequence, @NotNull BasedSequence sequence, @NotNull BasedSequence closingSequence, @NotNull String name)

public int
endOfLine(int index)

public void
extractChainTo(@NotNull Node node)

public void
extractToFirstInChain(@NotNull Node node)

public @Nullable Node
getAncestorOfType(@NotNull Class<?>... classes)

public void
getAstExtra(@NotNull StringBuilder out)

public BasedSequence
getBaseSequence()

public @NotNull Node
getBlankLineSibling()

public @NotNull BasedSequence
getChars()

public @NotNull BasedSequence

Returns:

concatenated string of all segments
getCharsFromSegments()

Get the char sequence from segments making up the node's characters.

public BasedSequence
getChildChars()

public @NotNull ReversiblePeekingIterator<Node>
getChildIterator()

public @Nullable Node
getChildOfType(@NotNull Class<?>... classes)

public @NotNull ReversiblePeekingIterable<Node>
getChildren()

public @NotNull ReversiblePeekingIterable<Node>
getDescendants()

public @NotNull Document
getDocument()

public BasedSequence
getEmptyPrefix()

public BasedSequence
getEmptySuffix()

public int
getEndLineNumber()

public int
getEndOffset()

public int
getEndOfLine()

public BasedSequence
getExactChildChars()

public @Nullable Node
getFirstChild()

public @Nullable Node
getFirstChildAny(@NotNull Class<?>... classes)

public @Nullable Node
getFirstChildAnyNot(@NotNull Class<?>... classes)

public @NotNull Node
getFirstInChain()

public @Nullable Node
getGrandParent()

public @Nullable Node

Returns:

return a child block that can contain the parent's last blank line
getLastBlankLineChild()

Overridden by ListBlock and any others whose children propagate their blank line to parent

public @Nullable Node
getLastChild()

public @Nullable Node
getLastChildAny(@NotNull Class<?>... classes)

public @Nullable Node
getLastChildAnyNot(@NotNull Class<?>... classes)

public @NotNull Node
getLastInChain()

public static @NotNull BasedSequence
getLeadSegment(@NotNull BasedSequence[] segments)

public Pair<Integer, Integer>
getLineColumnAtEnd()

public int
getLineNumber()

public @Nullable Node
getNext()

public @Nullable Node
getNextAny(@NotNull Class<?>... classes)

public @Nullable Node
getNextAnyNot(@NotNull Class<?>... classes)

public @NotNull String
getNodeName()

public static int
getNodeOfTypeIndex(@NotNull Node node, @NotNull Class<?>... classes)

public int
getNodeOfTypeIndex(@NotNull Class<?>... classes)

public @Nullable Node
getOldestAncestorOfTypeAfter(@NotNull Class<?> ancestor, @NotNull Class<?> after)

public @Nullable Node
getParent()

public @Nullable Node
getPrevious()

public @Nullable Node
getPreviousAny(@NotNull Class<?>... classes)

public @Nullable Node
getPreviousAnyNot(@NotNull Class<?>... classes)

public @NotNull ReversiblePeekingIterator<Node>
getReversedChildIterator()

public @NotNull ReversiblePeekingIterable<Node>
getReversedChildren()

public @NotNull ReversiblePeekingIterable<Node>
getReversedDescendants()

public abstract @NotNull BasedSequence[]
getSegments()

public @NotNull BasedSequence[]

Returns:

array of segments
getSegmentsForChars()

Get the segments making up the node's characters.

public Range
getSourceRange()

public int
getStartLineNumber()

public int
getStartOffset()

public int
getStartOfLine()

public int
getTextLength()

public static @NotNull BasedSequence
getTrailSegment(BasedSequence[] segments)

public boolean
hasChildren()

public boolean
hasOrMoreChildren(int childCount)

public void
insertAfter(@NotNull Node sibling)

public void
insertBefore(Node sibling)

public void
insertChainAfter(@NotNull Node
first child in chain
firstNode)

Append all from child to end of chain to this node

public void
insertChainBefore(@NotNull Node
first child in chain
firstNode)

Append all from child to end of chain to this node

public boolean
isOrDescendantOfType(@NotNull Class<?>... classes)

public Pair<Integer, Integer>
lineColumnAtIndex(int index)

public Pair<Integer, Integer>
lineColumnAtStart()

public void
moveTrailingBlankLines()

public void
prependChild(@NotNull Node child)

public void
removeChildren()

public static void
segmentSpan(@NotNull StringBuilder out, int startOffset, int endOffset, @Nullable String name)

public static void
segmentSpan(@NotNull StringBuilder out, @NotNull BasedSequence sequence, @Nullable String name)

public static void
segmentSpanChars(@NotNull StringBuilder out, int startOffset, int endOffset, @Nullable String name, @NotNull String chars)

public static void
segmentSpanChars(@NotNull StringBuilder out, int startOffset, int endOffset, @Nullable String name, @NotNull String chars1, @NotNull String splice, @NotNull String chars2)

public static void
segmentSpanChars(@NotNull StringBuilder out, @NotNull BasedSequence sequence, @NotNull String name)

public static void
segmentSpanCharsToVisible(@NotNull StringBuilder out, @NotNull BasedSequence sequence, @NotNull String name)

public void
setChars(@NotNull BasedSequence chars)

public void
setCharsFromContent()

public void
setCharsFromContentOnly()

public void
setCharsFromSegments()

Set the node's char string from segments making up the node's characters.

protected void
setParent(@Nullable Node parent)

public static @NotNull BasedSequence
spanningChars(BasedSequence... segments)

public int
startOfLine(int index)

public void
takeChildren(@NotNull Node node)

public @NotNull String
toAstString(boolean withExtra)

public static @NotNull String
toSegmentSpan(@NotNull BasedSequence sequence, @Nullable String name)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

protected @NotNull String
toStringAttributes()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait