Node (flexmark-java utilities 0.40.4 API)

java.lang.Object
- com.vladsch.flexmark.util.ast.Node

Direct Known Subclasses:

ContentNode, CustomNode
```
public abstract class Node
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static BasedSequence[] EMPTY_SEGMENTS

static String SPLICE

Fields
Modifier and Type	Field and Description
`static BasedSequence[]`	`EMPTY_SEGMENTS`
`static String`	`SPLICE`

Constructor Summary

Constructors
Constructor and Description

Node()

Node(BasedSequence chars)

Constructors
Constructor and Description
`Node()`
`Node(BasedSequence chars)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendChain(Node firstNode)` Append all from child to end of chain to this node
`void`	`appendChild(Node child)`
`static void`	`astChars(StringBuilder out, CharSequence chars, String name)`
`void`	`astExtraChars(StringBuilder out)`
`void`	`astString(StringBuilder out, boolean withExtra)`
`int`	`countAncestorsOfType(Class... classes)`
`int`	`countDirectAncestorsOfType(Class skip, Class... classes)`
`static void`	`delimitedSegmentSpan(StringBuilder out, BasedSequence openingSequence, BasedSequence sequence, BasedSequence closingSequence, String name)`
`static void`	`delimitedSegmentSpanChars(StringBuilder out, BasedSequence openingSequence, BasedSequence sequence, BasedSequence closingSequence, String name)`
`protected BasedSequence`	`deNullify(BasedSequence nullable)`
`void`	`extractChainTo(Node node)`
`void`	`extractToFirstInChain(Node node)`
`Node`	`getAncestorOfType(Class... classes)`
`void`	`getAstExtra(StringBuilder out)`
`Node`	`getBlankLineSibling()`
`BasedSequence`	`getChars()`
`BasedSequence`	`getCharsFromSegments()` Get the char sequence from segments making up the node's characters.
`BasedSequence`	`getChildChars()`
`ReversiblePeekingIterator<Node>`	`getChildIterator()`
`Node`	`getChildOfType(Class... classes)`
`ReversiblePeekingIterable<Node>`	`getChildren()`
`ReversiblePeekingIterable<Node>`	`getDescendants()`
`Document`	`getDocument()`
`int`	`getEndLineNumber()`
`int`	`getEndOffset()`
`BasedSequence`	`getExactChildChars()`
`Node`	`getFirstChild()`
`Node`	`getFirstChildAny(Class... classes)`
`Node`	`getFirstChildAnyNot(Class... classes)`
`Node`	`getFirstInChain()`
`Node`	`getLastBlankLineChild()` Overridden by ListBlock and any others whose children propagate their blank line to parent
`Node`	`getLastChild()`
`Node`	`getLastChildAny(Class... classes)`
`Node`	`getLastChildAnyNot(Class... classes)`
`Node`	`getLastInChain()`
`static BasedSequence`	`getLeadSegment(BasedSequence[] segments)`
`int`	`getLineNumber()`
`Node`	`getNext()`
`Node`	`getNextAny(Class... classes)`
`Node`	`getNextAnyNot(Class... classes)`
`String`	`getNodeName()`
`int`	`getNodeOfTypeIndex(Class... classes)`
`static int`	`getNodeOfTypeIndex(Node node, Class... classes)`
`Node`	`getOldestAncestorOfTypeAfter(Class ancestor, Class after)`
`Node`	`getParent()`
`Node`	`getPrevious()`
`Node`	`getPreviousAny(Class... classes)`
`Node`	`getPreviousAnyNot(Class... classes)`
`ReversiblePeekingIterator<Node>`	`getReversedChildIterator()`
`ReversiblePeekingIterable<Node>`	`getReversedChildren()`
`ReversiblePeekingIterable<Node>`	`getReversedDescendants()`
`abstract BasedSequence[]`	`getSegments()`
`BasedSequence[]`	`getSegmentsForChars()` Get the segments making up the node's characters.
`int`	`getStartLineNumber()`
`int`	`getStartOffset()`
`int`	`getTextLength()`
`static BasedSequence`	`getTrailSegment(BasedSequence[] segments)`
`boolean`	`hasChildren()`
`boolean`	`hasOrMoreChildren(int childCount)`
`void`	`insertAfter(Node sibling)`
`void`	`insertBefore(Node sibling)`
`void`	`insertChainAfter(Node firstNode)` Append all from child to end of chain to this node
`void`	`insertChainBefore(Node firstNode)` Append all from child to end of chain to this node
`boolean`	`isOrDescendantOfType(Class... classes)`
`void`	`moveTrailingBlankLines()`
`void`	`prependChild(Node child)`
`void`	`removeChildren()`
`static void`	`segmentSpan(StringBuilder out, BasedSequence sequence, String name)`
`static void`	`segmentSpan(StringBuilder out, int startOffset, int endOffset, String name)`
`static void`	`segmentSpanChars(StringBuilder out, BasedSequence sequence, String name)`
`static void`	`segmentSpanChars(StringBuilder out, int startOffset, int endOffset, String name, String chars)`
`static void`	`segmentSpanChars(StringBuilder out, int startOffset, int endOffset, String name, String chars1, String splice, String chars2)`
`void`	`setChars(BasedSequence chars)`
`void`	`setCharsFromContent()`
`void`	`setCharsFromContentOnly()`
`void`	`setCharsFromSegments()` Set the node's char string from segments making up the node's characters.
`protected void`	`setParent(Node parent)`
`static BasedSequence`	`spanningChars(BasedSequence... segments)`
`void`	`takeChildren(Node node)`
`String`	`toAstString(boolean withExtra)`
`static String`	`toSegmentSpan(BasedSequence sequence, String name)`
`String`	`toString()`
`protected String`	`toStringAttributes()`
`void`	`unlink()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_SEGMENTS

public static final BasedSequence[] EMPTY_SEGMENTS

SPLICE
```
public static final String SPLICE
```
See Also:

Constant Field Values

Constructor Detail

Node
```
public Node()
```

Node
```
public Node(BasedSequence chars)
```

Method Detail

getAncestorOfType

public Node getAncestorOfType(Class... classes)

countAncestorsOfType

public int countAncestorsOfType(Class... classes)

countDirectAncestorsOfType

public int countDirectAncestorsOfType(Class skip,
                                      Class... classes)

getOldestAncestorOfTypeAfter

public Node getOldestAncestorOfTypeAfter(Class ancestor,
                                         Class after)

getChildOfType

public Node getChildOfType(Class... classes)

getNodeOfTypeIndex

public static int getNodeOfTypeIndex(Node node,
                                     Class... classes)

isOrDescendantOfType

public boolean isOrDescendantOfType(Class... classes)

getNodeOfTypeIndex

public int getNodeOfTypeIndex(Class... classes)

getLastBlankLineChild
```
public Node getLastBlankLineChild()
```
Overridden by ListBlock and any others whose children propagate their blank line to parent

Returns:

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

getChildren

public ReversiblePeekingIterable<Node> getChildren()

getReversedChildren

public ReversiblePeekingIterable<Node> getReversedChildren()

getDescendants

public ReversiblePeekingIterable<Node> getDescendants()

getReversedDescendants

public ReversiblePeekingIterable<Node> getReversedDescendants()

getChildIterator

public ReversiblePeekingIterator<Node> getChildIterator()

getReversedChildIterator

public ReversiblePeekingIterator<Node> getReversedChildIterator()

getChars
```
public BasedSequence getChars()
```

removeChildren
```
public void removeChildren()
```

hasChildren
```
public boolean hasChildren()
```

hasOrMoreChildren

public boolean hasOrMoreChildren(int childCount)

getDocument
```
public Document getDocument()
```

setChars

public void setChars(BasedSequence chars)

getNext
```
public Node getNext()
```

getLastInChain
```
public Node getLastInChain()
```

getStartOffset
```
public int getStartOffset()
```

getEndOffset
```
public int getEndOffset()
```

getTextLength
```
public int getTextLength()
```

getPrevious
```
public Node getPrevious()
```

extractToFirstInChain

public void extractToFirstInChain(Node node)

extractChainTo

public void extractChainTo(Node node)

getFirstInChain
```
public Node getFirstInChain()
```

getPreviousAnyNot

public Node getPreviousAnyNot(Class... classes)

getPreviousAny

public Node getPreviousAny(Class... classes)

getNextAnyNot

public Node getNextAnyNot(Class... classes)

getNextAny

public Node getNextAny(Class... classes)

getFirstChild
```
public Node getFirstChild()
```

getFirstChildAnyNot

public Node getFirstChildAnyNot(Class... classes)

getFirstChildAny

public Node getFirstChildAny(Class... classes)

getLastChild
```
public Node getLastChild()
```

getLastChildAnyNot

public Node getLastChildAnyNot(Class... classes)

getLastChildAny

public Node getLastChildAny(Class... classes)

getParent
```
public Node getParent()
```

setParent

protected void setParent(Node parent)

appendChild
```
public void appendChild(Node child)
```

prependChild
```
public void prependChild(Node child)
```

unlink
```
public void unlink()
```

insertAfter

public void insertAfter(Node sibling)

insertBefore

public void insertBefore(Node sibling)

toString
```
public String toString()
```
Overrides:

toString in class Object

getAstExtra

public void getAstExtra(StringBuilder out)

astExtraChars

public void astExtraChars(StringBuilder out)

astChars

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

toStringAttributes
```
protected String toStringAttributes()
```

getSegments

public abstract BasedSequence[] getSegments()

getLeadSegment

public static BasedSequence getLeadSegment(BasedSequence[] segments)

getTrailSegment

public static BasedSequence getTrailSegment(BasedSequence[] segments)

spanningChars

public static BasedSequence spanningChars(BasedSequence... segments)

setCharsFromContentOnly
```
public void setCharsFromContentOnly()
```

setCharsFromContent
```
public void setCharsFromContent()
```

deNullify

protected BasedSequence deNullify(BasedSequence nullable)

segmentSpan

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

segmentSpanChars

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

segmentSpanChars

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

segmentSpan

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

segmentSpanChars

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

delimitedSegmentSpan

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

delimitedSegmentSpanChars

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

takeChildren
```
public void takeChildren(Node node)
```

getNodeName
```
public String getNodeName()
```

astString

public void astString(StringBuilder out,
                      boolean withExtra)

toAstString

public String toAstString(boolean withExtra)

toSegmentSpan

public static String toSegmentSpan(BasedSequence sequence,
                                   String name)

getChildChars
```
public BasedSequence getChildChars()
```

getExactChildChars

public BasedSequence getExactChildChars()

getBlankLineSibling
```
public Node getBlankLineSibling()
```

moveTrailingBlankLines
```
public void moveTrailingBlankLines()
```

getLineNumber
```
public int getLineNumber()
```

getStartLineNumber
```
public int getStartLineNumber()
```

getEndLineNumber
```
public int getEndLineNumber()
```

getSegmentsForChars
```
public BasedSequence[] getSegmentsForChars()
```
Get the segments making up the node's characters.
Used to get segments after the some of the node's elements were modified

Returns:

array of segments

getCharsFromSegments
```
public BasedSequence getCharsFromSegments()
```
Get the char sequence from segments making up the node's characters.
Used to get segments after the some of the node's elements were modified

Returns:

concatenated string of all segments

setCharsFromSegments
```
public void setCharsFromSegments()
```
Set the node's char string from segments making up the node's characters.
Used to get segments after the some of the node's elements were modified

appendChain
```
public void appendChain(Node firstNode)
```
Append all from child to end of chain to this node

Parameters:

firstNode - first child in chain

insertChainAfter
```
public void insertChainAfter(Node firstNode)
```
Append all from child to end of chain to this node

Parameters:

firstNode - first child in chain

insertChainBefore
```
public void insertChainBefore(Node firstNode)
```
Append all from child to end of chain to this node

Parameters:

firstNode - first child in chain

Class Node

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_SEGMENTS

SPLICE

Constructor Detail

Node

Node

Method Detail

getAncestorOfType

countAncestorsOfType

countDirectAncestorsOfType

getOldestAncestorOfTypeAfter

getChildOfType

getNodeOfTypeIndex

isOrDescendantOfType

getNodeOfTypeIndex

getLastBlankLineChild

getChildren

getReversedChildren

getDescendants

getReversedDescendants

getChildIterator

getReversedChildIterator

getChars

removeChildren

hasChildren

hasOrMoreChildren

getDocument

setChars

getNext

getLastInChain

getStartOffset

getEndOffset

getTextLength

getPrevious

extractToFirstInChain

extractChainTo

getFirstInChain

getPreviousAnyNot

getPreviousAny

getNextAnyNot

getNextAny

getFirstChild

getFirstChildAnyNot

getFirstChildAny

getLastChild

getLastChildAnyNot

getLastChildAny

getParent

setParent

appendChild

prependChild

unlink

insertAfter

insertBefore

toString

getAstExtra

astExtraChars

astChars

toStringAttributes

getSegments

getLeadSegment

getTrailSegment

spanningChars

setCharsFromContentOnly

setCharsFromContent

deNullify

segmentSpan

segmentSpanChars

segmentSpanChars

segmentSpan

segmentSpanChars

delimitedSegmentSpan

delimitedSegmentSpanChars

takeChildren

getNodeName