Package com.vladsch.flexmark.util.ast

Class Document

java.lang.Object

com.vladsch.flexmark.util.ast.Node

com.vladsch.flexmark.util.ast.ContentNode

com.vladsch.flexmark.util.ast.Block

com.vladsch.flexmark.util.ast.Document

All Implemented Interfaces:

Content, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.data.MutableDataHolder, com.vladsch.flexmark.util.data.MutableDataSetter

public class Document
extends Block
implements com.vladsch.flexmark.util.data.MutableDataHolder

Field Summary

Fields

Modifier and Type	Field	Description
static Document	NULL

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

lineSegments

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

AST_ADAPTER, EMPTY_SEGMENTS, SPLICE

Constructor Summary

Constructors

Constructor	Description
Document(com.vladsch.flexmark.util.data.DataHolder options, com.vladsch.flexmark.util.sequence.BasedSequence chars)

Method Summary

Modifier and Type	Method	Description
@NotNull com.vladsch.flexmark.util.data.DataHolder	aggregate()
static @NotNull com.vladsch.flexmark.util.data.DataHolder	aggregate(@Nullable com.vladsch.flexmark.util.data.DataHolder other, @Nullable com.vladsch.flexmark.util.data.DataHolder overrides)
static @NotNull com.vladsch.flexmark.util.data.DataHolder	aggregateActions(@NotNull com.vladsch.flexmark.util.data.DataHolder other, @NotNull com.vladsch.flexmark.util.data.DataHolder overrides)
@NotNull com.vladsch.flexmark.util.data.MutableDataHolder	clear()
boolean	contains(@NotNull com.vladsch.flexmark.util.data.DataKeyBase<?> key)
@NotNull Map<? extends com.vladsch.flexmark.util.data.DataKeyBase<?>,Object>	getAll()
@NotNull Collection<? extends com.vladsch.flexmark.util.data.DataKeyBase<?>>	getKeys()
int	getLineCount()
int	getLineNumber(int offset)	Get line number at offset
@Nullable Object	getOrCompute(@NotNull com.vladsch.flexmark.util.data.DataKeyBase<?> key, @NotNull com.vladsch.flexmark.util.data.DataValueFactory<?> factory)
@NotNull com.vladsch.flexmark.util.sequence.BasedSequence[]	getSegments()
static com.vladsch.flexmark.util.data.MutableDataSet	merge(com.vladsch.flexmark.util.data.DataHolder... dataHolders)
@NotNull com.vladsch.flexmark.util.data.MutableDataSet	remove(@NotNull com.vladsch.flexmark.util.data.DataKeyBase<?> key)
<T> @NotNull com.vladsch.flexmark.util.data.MutableDataHolder	set(@NotNull com.vladsch.flexmark.util.data.DataKey<T> key, T value)
<T> @NotNull com.vladsch.flexmark.util.data.MutableDataHolder	set(@NotNull com.vladsch.flexmark.util.data.NullableDataKey<T> key, T value)
@NotNull com.vladsch.flexmark.util.data.MutableDataSet	setAll(@NotNull com.vladsch.flexmark.util.data.DataHolder other)
@NotNull com.vladsch.flexmark.util.data.MutableDataSet	setFrom(@NotNull com.vladsch.flexmark.util.data.MutableDataSetter dataSetter)
@NotNull com.vladsch.flexmark.util.data.MutableDataHolder	setIn(@NotNull com.vladsch.flexmark.util.data.MutableDataHolder dataHolder)
@NotNull com.vladsch.flexmark.util.data.MutableDataSet	toDataSet()
@NotNull com.vladsch.flexmark.util.data.DataSet	toImmutable()
@NotNull com.vladsch.flexmark.util.data.MutableDataSet	toMutable()

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

getParent, setParent

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

getContentChars, getContentChars, getContentLines, getContentLines, getLineChars, getSpanningChars, setContent, setContent, setContent, setContentLine, setContentLines

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, getAstExtra, 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, 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, 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.data.MutableDataHolder

get

Field Detail

NULL

public static final Document NULL

Constructor Detail

Document

public Document(com.vladsch.flexmark.util.data.DataHolder options,
                com.vladsch.flexmark.util.sequence.BasedSequence chars)

Method Detail

getSegments

@NotNull
public @NotNull com.vladsch.flexmark.util.sequence.BasedSequence[] getSegments()

Specified by:

getSegments in class Node

clear

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataHolder clear()

Specified by:

clear in interface com.vladsch.flexmark.util.data.MutableDataHolder

set

@NotNull
public <T> @NotNull com.vladsch.flexmark.util.data.MutableDataHolder set(@NotNull
                                                                         @NotNull com.vladsch.flexmark.util.data.DataKey<T> key,
                                                                         @NotNull
                                                                         T value)

Specified by:

set in interface com.vladsch.flexmark.util.data.MutableDataHolder

set

@NotNull
public <T> @NotNull com.vladsch.flexmark.util.data.MutableDataHolder set(@NotNull
                                                                         @NotNull com.vladsch.flexmark.util.data.NullableDataKey<T> key,
                                                                         @Nullable
                                                                         T value)

Specified by:

set in interface com.vladsch.flexmark.util.data.MutableDataHolder

setFrom

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataSet setFrom(@NotNull
                                                                      @NotNull com.vladsch.flexmark.util.data.MutableDataSetter dataSetter)

Specified by:

setFrom in interface com.vladsch.flexmark.util.data.MutableDataHolder

setAll

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataSet setAll(@NotNull
                                                                     @NotNull com.vladsch.flexmark.util.data.DataHolder other)

Specified by:

setAll in interface com.vladsch.flexmark.util.data.MutableDataHolder

merge

public static com.vladsch.flexmark.util.data.MutableDataSet merge(com.vladsch.flexmark.util.data.DataHolder... dataHolders)

setIn

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataHolder setIn(@NotNull
                                                                       @NotNull com.vladsch.flexmark.util.data.MutableDataHolder dataHolder)

Specified by:

setIn in interface com.vladsch.flexmark.util.data.DataHolder

Specified by:

setIn in interface com.vladsch.flexmark.util.data.MutableDataHolder

Specified by:

setIn in interface com.vladsch.flexmark.util.data.MutableDataSetter

remove

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataSet remove(@NotNull
                                                                     @NotNull com.vladsch.flexmark.util.data.DataKeyBase<?> key)

Specified by:

remove in interface com.vladsch.flexmark.util.data.MutableDataHolder

getOrCompute

@Nullable
public @Nullable Object getOrCompute(@NotNull
                                     @NotNull com.vladsch.flexmark.util.data.DataKeyBase<?> key,
                                     @NotNull
                                     @NotNull com.vladsch.flexmark.util.data.DataValueFactory<?> factory)

Specified by:

getOrCompute in interface com.vladsch.flexmark.util.data.DataHolder

Specified by:

getOrCompute in interface com.vladsch.flexmark.util.data.MutableDataHolder

toMutable

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataSet toMutable()

Specified by:

toMutable in interface com.vladsch.flexmark.util.data.DataHolder

toImmutable

@NotNull
public @NotNull com.vladsch.flexmark.util.data.DataSet toImmutable()

Specified by:

toImmutable in interface com.vladsch.flexmark.util.data.DataHolder

toDataSet

@NotNull
public @NotNull com.vladsch.flexmark.util.data.MutableDataSet toDataSet()

Specified by:

toDataSet in interface com.vladsch.flexmark.util.data.DataHolder

aggregateActions

@NotNull
public static @NotNull com.vladsch.flexmark.util.data.DataHolder aggregateActions(@NotNull
                                                                                  @NotNull com.vladsch.flexmark.util.data.DataHolder other,
                                                                                  @NotNull
                                                                                  @NotNull com.vladsch.flexmark.util.data.DataHolder overrides)

aggregate

@NotNull
public @NotNull com.vladsch.flexmark.util.data.DataHolder aggregate()

aggregate

@NotNull
public static @NotNull com.vladsch.flexmark.util.data.DataHolder aggregate(@Nullable
                                                                           @Nullable com.vladsch.flexmark.util.data.DataHolder other,
                                                                           @Nullable
                                                                           @Nullable com.vladsch.flexmark.util.data.DataHolder overrides)

getAll

@NotNull
public @NotNull Map<? extends com.vladsch.flexmark.util.data.DataKeyBase<?>,Object> getAll()

Specified by:

getAll in interface com.vladsch.flexmark.util.data.DataHolder

getKeys

@NotNull
public @NotNull Collection<? extends com.vladsch.flexmark.util.data.DataKeyBase<?>> getKeys()

Specified by:

getKeys in interface com.vladsch.flexmark.util.data.DataHolder

contains

public boolean contains(@NotNull
                        @NotNull com.vladsch.flexmark.util.data.DataKeyBase<?> key)

Specified by:

contains in interface com.vladsch.flexmark.util.data.DataHolder

getLineCount

public int getLineCount()

Specified by:

getLineCount in interface Content

Overrides:

getLineCount in class ContentNode

getLineNumber

public int getLineNumber(int offset)

Get line number at offset

Next line starts after the EOL sequence. offsets between \r and \n are considered part of the same line as offset before \r.

Parameters:

offset - offset in document text

Returns:

line number at offset