Package org.shredzone.commons.text.filter

Class TextileFilter

java.lang.Object

org.shredzone.commons.text.filter.TextileFilter

All Implemented Interfaces:

Function<CharSequence,CharSequence>, TextFilter

public class TextileFilter
extends Object
implements TextFilter

A filter that converts Textile markup to HTML.

Currently, Mylyn WikiText Textile (formerly known as Textile-J) is used for conversion. Future releases may come with an own, lightweight implementation.

Author:

Richard "Shred" Körber

See Also:

Mylyn WikiText

Constructor Summary

Constructors

Constructor	Description
TextileFilter()

Method Summary

Modifier and Type	Method	Description
CharSequence	apply(CharSequence text)	Applies the filter on a CharSequence and returns a new CharSequence with the modified text.
protected org.eclipse.mylyn.wikitext.parser.DocumentBuilder	createDocumentBuilder(Writer writer)	Creates a Textile-j DocumentBuilder to be used for writing.
void	setAnalyzer(LinkAnalyzer analyzer)	Sets a LinkAnalyzer to be used for converting links and image source URLs.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.shredzone.commons.text.TextFilter

toStringBuilder

Constructor Details

TextileFilter

public TextileFilter()

Method Details

setAnalyzer

public void setAnalyzer(@Nullable
 LinkAnalyzer analyzer)

Sets a LinkAnalyzer to be used for converting links and image source URLs.

Parameters:

analyzer - LinkAnalyzer to be used

createDocumentBuilder

protected org.eclipse.mylyn.wikitext.parser.DocumentBuilder createDocumentBuilder(Writer writer)

Creates a Textile-j DocumentBuilder to be used for writing.

Note that this method is Textile-j specific and might be removed in future versions.

Parameters:

writer - Writer to write the HTML output to

Returns:

DocumentBuilder to be used for the markup parser

apply

public CharSequence apply(CharSequence text)

Description copied from interface: TextFilter

Applies the filter on a CharSequence and returns a new CharSequence with the modified text.

Specified by:

apply in interface Function<CharSequence,CharSequence>

Specified by:

apply in interface TextFilter

Parameters:

text - CharSequence with the contents to be filtered. If this is a StringBuilder instance, its contents may have changed after invocation, and this instance should not be used any more.

Returns:

CharSequence with the filtered text.