com.threecrickets.scripturian.formatter

Class PygmentsDocumentFormatter<D>

java.lang.Object

com.threecrickets.scripturian.formatter.PygmentsDocumentFormatter<D>

All Implemented Interfaces:

DocumentFormatter<D>

public class PygmentsDocumentFormatter<D>
extends Object
implements DocumentFormatter<D>

Use Pygments over Jython to format source code.

Author:

Tal Liron

Constructor Summary

Constructors

Constructor and Description
PygmentsDocumentFormatter() Constructor.
PygmentsDocumentFormatter(String theme) Constructor.

Method Summary

Modifier and Type	Method and Description
String	format(DocumentDescriptor<D> documentDescriptor, String title, int highlightLineNumber) Formats the document or its source code.

Methods inherited from class java.lang.Object

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

Constructor Detail

PygmentsDocumentFormatter

public PygmentsDocumentFormatter()

Constructor. The theme used is "vs".

PygmentsDocumentFormatter

public PygmentsDocumentFormatter(String theme)

Constructor.

Parameters:

theme - The theme to use

Method Detail

format

public String format(DocumentDescriptor<D> documentDescriptor,
                     String title,
                     int highlightLineNumber)

Description copied from interface: DocumentFormatter

Formats the document or its source code.

Specified by:

format in interface DocumentFormatter<D>

Parameters:

documentDescriptor - The document descriptor

title - The result title

highlightLineNumber - The line number to highlight

Returns:

The formatted document