net.sf.okapi.filters.markdown.parser

Class MarkdownParser

java.lang.Object

net.sf.okapi.filters.markdown.parser.MarkdownParser

public class MarkdownParser
extends Object

Constructor Summary

Constructors

Constructor and Description
MarkdownParser(Parameters params) Create a new MarkdownParser that uses the platform-specific newline.
MarkdownParser(Parameters params, String newline) Create a new MarkdownParser that uses the specified string as a newline.

Method Summary

Modifier and Type	Method and Description
String	dumpTokens() Dumps all tokens.
String	getNewline()
MarkdownToken	getNextToken() Returns the next available token.
boolean	hasNextToken()
void	parse(String markdownContent) Parse the given Markdown content into tokens that can be then retrieved with calls to getNextToken().
void	setNewline(String newline)
String	toString() Returns a string representation the AST generated by the parser from the last call to parse(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownParser

public MarkdownParser(Parameters params)

Create a new MarkdownParser that uses the platform-specific newline.

MarkdownParser

public MarkdownParser(Parameters params,
                      String newline)

Create a new MarkdownParser that uses the specified string as a newline.

Parameters:

newline - The newline type that this parser will use

Method Detail

parse

public void parse(String markdownContent)

Parse the given Markdown content into tokens that can be then retrieved with calls to getNextToken(). Any existing tokens from previous calls to parse(String) will be discarded.

Parameters:

markdownContent - The Markdown content to parse into tokens

hasNextToken

public boolean hasNextToken()

getNextToken

public MarkdownToken getNextToken()

Returns the next available token.

Returns:

The next token

Throws:

IllegalStateException - If no more tokens are remaining

getNewline

public String getNewline()

setNewline

public void setNewline(String newline)

dumpTokens

public String dumpTokens()

Dumps all tokens. This is for development.

Returns:

String representation of all MarkdownTokens generated.

toString

public String toString()

Returns a string representation the AST generated by the parser from the last call to parse(String).
System.out.println(markdownParser.toString())
is a convenient way to dump the parsed node tree during the development.

Overrides:

toString in class Object

Returns:

String representation of the AST