Top Description Methods
com.vladsch.flexmark.util.ast

public Interface IParse

Imports
com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.io.IOException, .Reader

Interface to generic parser for RenderingTestCase customizations

Method Summary

Modifier and TypeMethod and Description
public @Nullable DataHolder

Returns:

DataHolder for options
getOptions
()

Get Options for parsing

public @NotNull Node

Returns:

the root node
parse
(@NotNull BasedSequence
the text to parse
input
)

Parse the specified input text into a tree of nodes.

public @NotNull Node

Returns:

the root node
parse
(@NotNull String
the text to parse
input
)

Parse the specified input text into a tree of nodes.

public @NotNull Node

Returns:

the root node
parseReader
(@NotNull Reader
the reader to parse
input
)

Parse the specified reader into a tree of nodes.

public boolean

Returns:

true if any references were transferred
transferReferences
(@NotNull Document
destination document
document
,
@NotNull Document
source document
included
,
@Nullable Boolean
true if only should transfer references not already defined in the destination document, false to transfer all, null to use repository's KEEP_TYPE to make the determination (if KEEP_FIRST then only transfer if undefined,
onlyIfUndefined
)

Transfer reference definition between documents

Method Detail

getOptionsback to summary
public @Nullable DataHolder getOptions()

Get Options for parsing

Returns:@Nullable DataHolder

DataHolder for options

Annotations
@Nullable
parseback to summary
public @NotNull Node parse(@NotNull BasedSequence input)

Parse the specified input text into a tree of nodes.

Note that this method is thread-safe (a new parser state is used for each invocation).

Parameters
input:@NotNull BasedSequence

the text to parse

Returns:@NotNull Node

the root node

Annotations
@NotNull
parseback to summary
public @NotNull Node parse(@NotNull String input)

Parse the specified input text into a tree of nodes.

Note that this method is thread-safe (a new parser state is used for each invocation).

Parameters
input:@NotNull String

the text to parse

Returns:@NotNull Node

the root node

Annotations
@NotNull
parseReaderback to summary
public @NotNull Node parseReader(@NotNull Reader input) throws IOException

Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader.

Note that this method is thread-safe (a new parser state is used for each invocation).

Parameters
input:@NotNull Reader

the reader to parse

Returns:@NotNull Node

the root node

Annotations
@NotNull
Exceptions
IOException:
when reading throws an exception
transferReferencesback to summary
public boolean transferReferences(@NotNull Document document, @NotNull Document included, @Nullable Boolean onlyIfUndefined)

Transfer reference definition between documents

Parameters
document:@NotNull Document

destination document

included:@NotNull Document

source document

onlyIfUndefined:@Nullable Boolean

true if only should transfer references not already defined in the destination document, false to transfer all, null to use repository's KEEP_TYPE to make the determination (if KEEP_FIRST then only transfer if undefined,

Returns:boolean

true if any references were transferred