Package com.vladsch.flexmark.util.ast
Interface IParse
-
- All Known Implementing Classes:
Parser
public interface IParse
Interface to generic parser for RenderingTestCase customizations
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DataHolder
getOptions()
Get Options for parsingNode
parse(BasedSequence input)
Parse the specified input text into a tree of nodes.Node
parse(java.lang.String input)
Parse the specified input text into a tree of nodes.Node
parseReader(java.io.Reader input)
Parse the specified reader into a tree of nodes.boolean
transferReferences(Document document, Document included, java.lang.Boolean onlyIfUndefined)
Transfer reference definition between documents
-
-
-
Method Detail
-
parse
@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
- the text to parse- Returns:
- the root node
-
parse
@NotNull Node parse(@NotNull java.lang.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
- the text to parse- Returns:
- the root node
-
parseReader
@NotNull Node parseReader(@NotNull java.io.Reader input) throws java.io.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
- the reader to parse- Returns:
- the root node
- Throws:
java.io.IOException
- when reading throws an exception
-
getOptions
@Nullable DataHolder getOptions()
Get Options for parsing- Returns:
- DataHolder for options
-
transferReferences
boolean transferReferences(@NotNull Document document, @NotNull Document included, @Nullable java.lang.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
-
-