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

public Class Document

extends Block
implements MutableDataHolder
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.data.MutableDataHolder, com.vladsch.flexmark.util.data.MutableDataSetter, com.vladsch.flexmark.util.data.DataHolder
Imports
com.vladsch.flexmark.util.data.*, com.vladsch.flexmark.util.misc.Utils, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.util.Collection, .Map

Field Summary

Modifier and TypeField and Description
private final MutableDataSet
dataSet

public static final Document
NULL

Hides com.vladsch.flexmark.util.data.DataHolder.NULL.

Constructor Summary

AccessConstructor and Description
public
Document(DataHolder options, BasedSequence chars)

Method Summary

Modifier and TypeMethod and Description
public @NotNull DataHolder
aggregate()

public static @NotNull DataHolder
aggregate(@Nullable DataHolder other, @Nullable DataHolder overrides)

public static @NotNull DataHolder
aggregateActions(@NotNull DataHolder other, @NotNull DataHolder overrides)

public @NotNull MutableDataHolder
clear()

Implements com.vladsch.flexmark.util.data.MutableDataHolder.clear.

clear all options out of the data set

public boolean
contains(@NotNull DataKeyBase<?> key)

public @NotNull Map<? extends DataKeyBase<?>, Object>
getAll()

Implements com.vladsch.flexmark.util.data.DataHolder.getAll.

public @NotNull Collection<? extends DataKeyBase<?>>
getKeys()

Implements com.vladsch.flexmark.util.data.DataHolder.getKeys.

public int
getLineCount()

Overrides com.vladsch.flexmark.util.ast.ContentNode.getLineCount.

Implements com.vladsch.flexmark.util.ast.Content.getLineCount.

public int

Returns:

line number at offset
getLineNumber(int
offset in document text
offset)

Get line number at offset

Next line starts after the EOL sequence.

public @Nullable Object
getOrCompute(@NotNull DataKeyBase<?> key, @NotNull DataValueFactory<?> factory)

public @NotNull BasedSequence[]
getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

public static MutableDataSet
merge(DataHolder... dataHolders)

public @NotNull MutableDataSet
remove(@NotNull DataKeyBase<?> key)

public <T> @NotNull MutableDataHolder
set(@NotNull DataKey<T> key, T value)

public <T> @NotNull MutableDataHolder
set(@NotNull NullableDataKey<T> key, T value)

public @NotNull MutableDataSet
setAll(@NotNull DataHolder other)

public @NotNull MutableDataSet
setFrom(@NotNull MutableDataSetter dataSetter)

public @NotNull MutableDataHolder
setIn(@NotNull MutableDataHolder dataHolder)

public @NotNull MutableDataSet
toDataSet()

Overrides default com.vladsch.flexmark.util.data.DataHolder.toDataSet.

public @NotNull DataSet
toImmutable()

Implements com.vladsch.flexmark.util.data.DataHolder.toImmutable.

public @NotNull MutableDataSet
toMutable()

Implements com.vladsch.flexmark.util.data.DataHolder.toMutable.

Inherited from com.vladsch.flexmark.util.ast.Block:
getParentsetParent

Field Detail

dataSetback to summary
private final MutableDataSet dataSet
NULLback to summary
public static final Document NULL

Hides com.vladsch.flexmark.util.data.DataHolder.NULL.

Constructor Detail

Documentback to summary
public Document(DataHolder options, BasedSequence chars)

Method Detail

aggregateback to summary
public @NotNull DataHolder aggregate()
Annotations
@NotNull
aggregateback to summary
public static @NotNull DataHolder aggregate(@Nullable DataHolder other, @Nullable DataHolder overrides)
Annotations
@NotNull
aggregateActionsback to summary
public static @NotNull DataHolder aggregateActions(@NotNull DataHolder other, @NotNull DataHolder overrides)
Annotations
@NotNull
clearback to summary
public @NotNull MutableDataHolder clear()

Implements com.vladsch.flexmark.util.data.MutableDataHolder.clear.

Doc from com.vladsch.flexmark.util.data.MutableDataHolder.clear.

clear all options out of the data set

Returns:@NotNull MutableDataHolder

mutable data holder for chained calls

Annotations
@Override
@NotNull
containsback to summary
public boolean contains(@NotNull DataKeyBase<?> key)
Annotations
@Override
getAllback to summary
public @NotNull Map<? extends DataKeyBase<?>, Object> getAll()

Implements com.vladsch.flexmark.util.data.DataHolder.getAll.

Annotations
@Override
@NotNull
getKeysback to summary
public @NotNull Collection<? extends DataKeyBase<?>> getKeys()

Implements com.vladsch.flexmark.util.data.DataHolder.getKeys.

Annotations
@Override
@NotNull
getLineCountback to summary
public int getLineCount()

Overrides com.vladsch.flexmark.util.ast.ContentNode.getLineCount.

Implements com.vladsch.flexmark.util.ast.Content.getLineCount.

Annotations
@Override
getLineNumberback to summary
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:int

offset in document text

Returns:int

line number at offset

getOrComputeback to summary
public @Nullable Object getOrCompute(@NotNull DataKeyBase<?> key, @NotNull DataValueFactory<?> factory)
Annotations
@Override
@Nullable
getSegmentsback to summary
public @NotNull BasedSequence[] getSegments()

Implements abstract com.vladsch.flexmark.util.ast.Node.getSegments.

Annotations
@Override
@NotNull
mergeback to summary
public static MutableDataSet merge(DataHolder... dataHolders)
removeback to summary
public @NotNull MutableDataSet remove(@NotNull DataKeyBase<?> key)
Annotations
@NotNull
@Override
setback to summary
public <T> @NotNull MutableDataHolder set(@NotNull DataKey<T> key, T value)
Annotations
@NotNull
@Override
setback to summary
public <T> @NotNull MutableDataHolder set(@NotNull NullableDataKey<T> key, T value)
Annotations
@NotNull
@Override
setAllback to summary
public @NotNull MutableDataSet setAll(@NotNull DataHolder other)
Annotations
@NotNull
@Override
setFromback to summary
public @NotNull MutableDataSet setFrom(@NotNull MutableDataSetter dataSetter)
Annotations
@NotNull
@Override
setInback to summary
public @NotNull MutableDataHolder setIn(@NotNull MutableDataHolder dataHolder)
Annotations
@NotNull
@Override
toDataSetback to summary
public @NotNull MutableDataSet toDataSet()

Overrides default com.vladsch.flexmark.util.data.DataHolder.toDataSet.

Annotations
@Override
@NotNull
toImmutableback to summary
public @NotNull DataSet toImmutable()

Implements com.vladsch.flexmark.util.data.DataHolder.toImmutable.

Annotations
@Override
@NotNull
toMutableback to summary
public @NotNull MutableDataSet toMutable()

Implements com.vladsch.flexmark.util.data.DataHolder.toMutable.

Annotations
@Override
@NotNull