Module md.grammar

Package io.fixprotocol.md.event

Class DocumentParser

java.lang.Object

io.fixprotocol.md.event.DocumentParser

public final class DocumentParser
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentParser.ParserErrorListener	Listens for parser errors

Constructor Summary

Constructors

Constructor	Description
DocumentParser()

Method Summary

Modifier and Type	Method	Description
boolean	parse(InputStream inputStream, Consumer<? super GraphContext> contextConsumer)	Parse a markdown document
boolean	parse(InputStream inputStream, Consumer<? super GraphContext> contextConsumer, DocumentParser.ParserErrorListener parserListener)	Parse a markdown document
boolean	validate(InputStream inputStream, DocumentParser.ParserErrorListener parserListener)	Validate a markdown document

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentParser

public DocumentParser()

Method Detail

parse

public boolean parse(InputStream inputStream,
                     Consumer<? super GraphContext> contextConsumer)
              throws IOException

Parse a markdown document

Parameters:

inputStream - input as markdown

contextConsumer - consumer of document events

Returns:

true if the document is fully parsed without errors

Throws:

IOException - if the document cannot be read

parse

public boolean parse(InputStream inputStream,
                     Consumer<? super GraphContext> contextConsumer,
                     DocumentParser.ParserErrorListener parserListener)
              throws IOException

Parse a markdown document

Parameters:

inputStream - input as markdown

contextConsumer - consumer of document events

parserListener - listens for parser errors. May be null.

Returns:

true if the document is fully parsed without errors

Throws:

IOException - if the document cannot be read

validate

public boolean validate(InputStream inputStream,
                        DocumentParser.ParserErrorListener parserListener)
                 throws IOException

Validate a markdown document

Parameters:

inputStream - input as markdown

parserListener - listens for parser errors.

Returns:

true if the document is fully parsed without errors

Throws:

IOException - if the document cannot be read