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, DataHolder, MutableDataHolder, MutableDataSetter

public class Document
extends Block
implements MutableDataHolder

Field Summary

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

lineSegments

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

EMPTY_SEGMENTS, SPLICE

Constructor Summary

Constructors

Constructor and Description
Document(DataHolder options, BasedSequence chars)

Method Summary

Modifier and Type	Method and Description
MutableDataHolder	clear() clear all options out of the data set
boolean	contains(DataKey key)
<T> T	get(DataKey<T> key) Get the given key, if it does not exist then use the key's factory to create a new value and put it into the collection so that the following get of the same key will find a value
Map<DataKey,Object>	getAll()
int	getLineCount()
int	getLineNumber(int offset)
<T> T	getOrCompute(DataKey<T> key, DataValueFactory<T> factory) Will return the value previously set or generate a new value using the given factory.
BasedSequence[]	getSegments()
Collection<DataKey>	keySet()
<T> MutableDataHolder	remove(DataKey<T> key) Remove the stored value for the key, used to force to default or to force recompute
<T> MutableDataHolder	set(DataKey<T> key, T value) Store the given value for the key
MutableDataHolder	setAll(DataHolder other) Copy all values from one data holder to this data holder
MutableDataHolder	setFrom(MutableDataSetter dataSetter) Store the given value for the key
MutableDataHolder	setIn(MutableDataHolder dataHolder) Set options in gven mutable data hoer
DataHolder	toImmutable()
MutableDataHolder	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, countAncestorsOfType, countDirectAncestorsOfType, delimitedSegmentSpan, delimitedSegmentSpanChars, deNullify, extractChainTo, extractToFirstInChain, getAncestorOfType, getAstExtra, getBlankLineSibling, getChars, getCharsFromSegments, getChildChars, getChildIterator, getChildOfType, getChildren, getDescendants, getDocument, getEndLineNumber, getEndOffset, getExactChildChars, getFirstChild, getFirstChildAny, getFirstChildAnyNot, getFirstInChain, getLastBlankLineChild, getLastChild, getLastChildAny, getLastChildAnyNot, getLastInChain, getLeadSegment, getLineNumber, getNext, getNextAny, getNextAnyNot, getNodeName, getNodeOfTypeIndex, getNodeOfTypeIndex, getOldestAncestorOfTypeAfter, getPrevious, getPreviousAny, getPreviousAnyNot, getReversedChildIterator, getReversedChildren, getReversedDescendants, getSegmentsForChars, getStartLineNumber, getStartOffset, getTextLength, getTrailSegment, hasChildren, hasOrMoreChildren, insertAfter, insertBefore, insertChainAfter, insertChainBefore, isOrDescendantOfType, moveTrailingBlankLines, prependChild, removeChildren, segmentSpan, segmentSpan, segmentSpanChars, segmentSpanChars, segmentSpanChars, setChars, setCharsFromContent, setCharsFromContentOnly, setCharsFromSegments, spanningChars, takeChildren, toAstString, toSegmentSpan, toString, toStringAttributes, unlink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document(DataHolder options,
                BasedSequence chars)

Method Detail

getSegments

public BasedSequence[] getSegments()

Specified by:

getSegments in class Node

getAll

public Map<DataKey,Object> getAll()

Specified by:

getAll in interface DataHolder

keySet

public Collection<DataKey> keySet()

Specified by:

keySet in interface DataHolder

contains

public boolean contains(DataKey key)

Specified by:

contains in interface DataHolder

get

public <T> T get(DataKey<T> key)

Description copied from interface: MutableDataHolder

Get the given key, if it does not exist then use the key's factory to create a new value and put it into the collection so that the following get of the same key will find a value

Specified by:

get in interface DataHolder

Specified by:

get in interface MutableDataHolder

Parameters:

key - data key

Returns:

return stored value or newly created value

setIn

public MutableDataHolder setIn(MutableDataHolder dataHolder)

Description copied from interface: MutableDataHolder

Set options in gven mutable data hoer

Specified by:

setIn in interface MutableDataHolder

Specified by:

setIn in interface MutableDataSetter

Parameters:

dataHolder - data holder where to copy options from this data holder

Returns:

dataHolder

getLineCount

public int getLineCount()

Specified by:

getLineCount in interface Content

Overrides:

getLineCount in class ContentNode

getLineNumber

public int getLineNumber(int offset)

getOrCompute

public <T> T getOrCompute(DataKey<T> key,
                          DataValueFactory<T> factory)

Description copied from interface: MutableDataHolder

Will return the value previously set or generate a new value using the given factory. NOTE: if a new value is generated it will be stored for the given key so that subsequent calls with the same parameters will return the same value as the first call that generated the new value.

Specified by:

getOrCompute in interface MutableDataHolder

Type Parameters:

T - data type of the data referred by the key

Parameters:

key - data key identifying the data

factory - data value factory to use if the data referred by the key is not set

Returns:

data stored for the key or a value generated by the value factory.

remove

public <T> MutableDataHolder remove(DataKey<T> key)

Description copied from interface: MutableDataHolder

Remove the stored value for the key, used to force to default or to force recompute

Specified by:

remove in interface MutableDataHolder

Type Parameters:

T - data type of the data referred by the key

Parameters:

key - data key to remove

Returns:

mutable data holder for chained calls

set

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

Description copied from interface: MutableDataHolder

Store the given value for the key

Specified by:

set in interface MutableDataHolder

Type Parameters:

T - data type of the data referred by the key

Parameters:

key - data key

value - value to store

Returns:

mutable data holder for chained calls

setFrom

public MutableDataHolder setFrom(MutableDataSetter dataSetter)

Description copied from interface: MutableDataHolder

Store the given value for the key

Specified by:

setFrom in interface MutableDataHolder

Parameters:

dataSetter - data setter which will set values

Returns:

mutable data holder for chained calls

setAll

public MutableDataHolder setAll(DataHolder other)

Description copied from interface: MutableDataHolder

Copy all values from one data holder to this data holder

Specified by:

setAll in interface MutableDataHolder

Parameters:

other - data holder from which to copy all values

Returns:

mutable data holder for chained calls

toMutable

public MutableDataHolder toMutable()

Specified by:

toMutable in interface DataHolder

toImmutable

public DataHolder toImmutable()

Specified by:

toImmutable in interface DataHolder

clear

public MutableDataHolder clear()

Description copied from interface: MutableDataHolder

clear all options out of the data set

Specified by:

clear in interface MutableDataHolder

Returns:

mutable data holder for chained calls