Package com.helger.html.markdown

Class MarkdownProcessor

java.lang.Object

com.helger.html.markdown.MarkdownProcessor

public class MarkdownProcessor
extends Object

Markdown processor class.

Example usage:

 String result = MarkdownProcessor.process("This is ***TXTMARK***");
 
 

Author:

René Jeschke <rene_jeschke@yahoo.de>

Constructor Summary

Constructors

Constructor	Description
MarkdownProcessor()
MarkdownProcessor(MarkdownConfiguration aConfig)	Constructor.

Method Summary

Modifier and Type	Method	Description
MarkdownProcessingResult	process(com.helger.commons.io.resource.IReadableResource aRes)
MarkdownProcessingResult	process(InputStream aIS)
MarkdownProcessingResult	process(Reader aReader)	Does all the processing.
MarkdownProcessingResult	process(String sText)

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownProcessor

public MarkdownProcessor()

MarkdownProcessor

public MarkdownProcessor(@Nonnull
                         MarkdownConfiguration aConfig)

Constructor.

Parameters:

aConfig - The configuration to use. May not be null.

Method Detail

process

@Nonnull
public MarkdownProcessingResult process(@Nonnull
                                        com.helger.commons.io.resource.IReadableResource aRes)
                                 throws IOException

Throws:

IOException

process

@Nonnull
public MarkdownProcessingResult process(@Nonnull
                                        InputStream aIS)
                                 throws IOException

Throws:

IOException

process

@Nonnull
public MarkdownProcessingResult process(@Nullable
                                        String sText)
                                 throws IOException

Throws:

IOException

process

@Nonnull
public MarkdownProcessingResult process(@Nonnull @WillClose
                                        Reader aReader)
                                 throws IOException

Does all the processing.

Parameters:

aReader - The reader to read from

Returns:

The processing result.

Throws:

IOException - If an IO error occurred.