Package com.vladsch.flexmark.util.ast
Interface IParse
- All Known Implementing Classes:
IParseBase
,Parser
public interface IParse
Interface to generic parser for RenderingTestCase customizations
-
Method Summary
Modifier and TypeMethodDescription@Nullable DataHolder
Get Options for parsing@NotNull Node
parse
(@NotNull BasedSequence input) Parse the specified input text into a tree of nodes.@NotNull Node
Parse the specified input text into a tree of nodes.@NotNull Node
parseReader
(@NotNull Reader input) Parse the specified reader into a tree of nodes.boolean
transferReferences
(@NotNull Document document, @NotNull Document included, @Nullable Boolean onlyIfUndefined) Transfer reference definition between documents
-
Method Details
-
parse
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
- the text to parse- Returns:
- the root node
-
parse
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
- the text to parse- Returns:
- the root node
-
parseReader
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
- the reader to parse- Returns:
- the root node
- Throws:
IOException
- when reading throws an exception
-
getOptions
Get Options for parsing- Returns:
- DataHolder for options
-
transferReferences
boolean transferReferences(@NotNull @NotNull Document document, @NotNull @NotNull Document included, @Nullable @Nullable Boolean onlyIfUndefined) Transfer reference definition between documents- Parameters:
document
- destination documentincluded
- source documentonlyIfUndefined
- 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:
- true if any references were transferred
-