com.github.rjeschke.txtmark

Class CleaningProcessor

java.lang.Object

com.github.rjeschke.txtmark.CleaningProcessor

public class CleaningProcessor
extends Object

Markdown processor class.

Example usage:

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

Author:

René Jeschke <rene_jeschke@yahoo.de>

Method Summary

Methods

Modifier and Type	Method and Description
static String	process(File file) Transforms an input file into HTML using the default Configuration.
static String	process(File file, boolean safeMode) Transforms an input file into HTML.
static String	process(File file, Configuration configuration) Transforms an input file into HTML using the given Configuration.
static String	process(File file, Decorator decorator) Transforms an input file into HTML.
static String	process(File file, Decorator decorator, boolean safeMode) Transforms an input file into HTML.
static String	process(File file, String encoding) Transforms an input file into HTML.
static String	process(File file, String encoding, boolean safeMode) Transforms an input file into HTML.
static String	process(File file, String encoding, Decorator decorator) Transforms an input file into HTML.
static String	process(File file, String encoding, Decorator decorator, boolean safeMode) Transforms an input file into HTML.
static String	process(InputStream input) Transforms an input stream into HTML.
static String	process(InputStream input, boolean safeMode) Transforms an input stream into HTML.
static String	process(InputStream input, Configuration configuration) Transforms an input stream into HTML using the given Configuration.
static String	process(InputStream input, Decorator decorator) Transforms an input stream into HTML.
static String	process(InputStream input, Decorator decorator, boolean safeMode) Transforms an input stream into HTML.
static String	process(InputStream input, String encoding) Transforms an input stream into HTML.
static String	process(InputStream input, String encoding, boolean safeMode) Transforms an input stream into HTML.
static String	process(InputStream input, String encoding, Decorator decorator) Transforms an input stream into HTML.
static String	process(InputStream input, String encoding, Decorator decorator, boolean safeMode) Transforms an input stream into HTML.
static String	process(Reader reader) Transforms an input stream into HTML using the default Configuration.
static String	process(Reader reader, boolean safeMode) Transforms an input stream into HTML.
static String	process(Reader reader, Configuration configuration) Transforms an input stream into HTML using the given Configuration.
static String	process(Reader reader, Decorator decorator) Transforms an input stream into HTML.
static String	process(Reader reader, Decorator decorator, boolean safeMode) Transforms an input stream into HTML.
static String	process(String input) Transforms an input String into HTML using the default Configuration.
static String	process(String input, boolean safeMode) Transforms an input String into HTML.
static String	process(String input, Configuration configuration) Transforms an input String into HTML using the given Configuration.
static String	process(String input, Decorator decorator) Transforms an input String into HTML.
static String	process(String input, Decorator decorator, boolean safeMode) Transforms an input String into HTML.

Methods inherited from class java.lang.Object

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

Method Detail

process

public static final String process(Reader reader,
             Configuration configuration)
                            throws IOException

Transforms an input stream into HTML using the given Configuration.

Parameters:

reader - The Reader to process.

configuration - The Configuration.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

Since:

0.7

See Also:

Configuration

process

public static final String process(String input,
             Configuration configuration)

Transforms an input String into HTML using the given Configuration.

Parameters:

input - The String to process.

configuration - The Configuration.

Returns:

The processed String.

Since:

0.7

See Also:

Configuration

process

public static final String process(File file,
             Configuration configuration)
                            throws IOException

Transforms an input file into HTML using the given Configuration.

Parameters:

file - The File to process.

configuration - the Configuration

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

Since:

0.7

See Also:

Configuration

process

public static final String process(InputStream input,
             Configuration configuration)
                            throws IOException

Transforms an input stream into HTML using the given Configuration.

Parameters:

input - The InputStream to process.

configuration - The Configuration.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

Since:

0.7

See Also:

Configuration

process

public static final String process(String input)

Transforms an input String into HTML using the default Configuration.

Parameters:

input - The String to process.

Returns:

The processed String.

See Also:

Configuration.DEFAULT

process

public static final String process(String input,
             boolean safeMode)

Transforms an input String into HTML.

Parameters:

input - The String to process.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

See Also:

Configuration.DEFAULT

process

public static final String process(String input,
             Decorator decorator)

Transforms an input String into HTML.

Parameters:

input - The String to process.

decorator - The decorator to use.

Returns:

The processed String.

See Also:

Configuration.DEFAULT

process

public static final String process(String input,
             Decorator decorator,
             boolean safeMode)

Transforms an input String into HTML.

Parameters:

input - The String to process.

decorator - The decorator to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

See Also:

Configuration.DEFAULT

process

public static final String process(File file)
                            throws IOException

Transforms an input file into HTML using the default Configuration.

Parameters:

file - The File to process.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             boolean safeMode)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             Decorator decorator)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

decorator - The decorator to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             Decorator decorator,
             boolean safeMode)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

decorator - The decorator to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             String encoding)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

encoding - The encoding to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             String encoding,
             boolean safeMode)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

encoding - The encoding to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             String encoding,
             Decorator decorator)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

encoding - The encoding to use.

decorator - The decorator to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(File file,
             String encoding,
             Decorator decorator,
             boolean safeMode)
                            throws IOException

Transforms an input file into HTML.

Parameters:

file - The File to process.

encoding - The encoding to use.

decorator - The decorator to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             boolean safeMode)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             Decorator decorator)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

decorator - The decorator to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             Decorator decorator,
             boolean safeMode)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

decorator - The decorator to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             String encoding)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

encoding - The encoding to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             String encoding,
             boolean safeMode)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

encoding - The encoding to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             String encoding,
             Decorator decorator)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

encoding - The encoding to use.

decorator - The decorator to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(InputStream input,
             String encoding,
             Decorator decorator,
             boolean safeMode)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

input - The InputStream to process.

encoding - The encoding to use.

decorator - The decorator to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(Reader reader)
                            throws IOException

Transforms an input stream into HTML using the default Configuration.

Parameters:

reader - The Reader to process.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(Reader reader,
             boolean safeMode)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

reader - The Reader to process.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(Reader reader,
             Decorator decorator)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

reader - The Reader to process.

decorator - The decorator to use.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT

process

public static final String process(Reader reader,
             Decorator decorator,
             boolean safeMode)
                            throws IOException

Transforms an input stream into HTML.

Parameters:

reader - The Reader to process.

decorator - The decorator to use.

safeMode - Set to true to escape unsafe HTML tags.

Returns:

The processed String.

Throws:

IOException - if an IO error occurs

See Also:

Configuration.DEFAULT