com.uwyn.jhighlight.renderer

インタフェース Renderer

既知の実装クラスのリスト:

CppXhtmlRenderer, GroovyXhtmlRenderer, JavaScriptXhtmlRenderer, JavaXhtmlRenderer, XhtmlRenderer, XmlXhtmlRenderer

public interface Renderer

Provides interface to render the source code highlighting.

導入されたバージョン:

1.0

バージョン:

$Revision: 3108 $

作成者:

Geert Bevin (gbevin[remove] at uwyn dot com)

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	highlight(String name, InputStream in, OutputStream out, String encoding, boolean fragment) Transforms source code that's provided through an InputStream to highlighted syntax and writes it back to an OutputStream.
String	highlight(String name, String in, String encoding, boolean fragment) Transforms source code that's provided through a String to highlighted syntax and returns it as a String.

メソッドの詳細

highlight

void highlight(String name,
             InputStream in,
             OutputStream out,
             String encoding,
             boolean fragment)
               throws IOException

Transforms source code that's provided through an InputStream to highlighted syntax and writes it back to an OutputStream.

パラメータ:

name - The name of the source file.

in - The input stream that provides the source code that needs to be transformed.

out - The output stream to which to result should be written.

encoding - The encoding that will be used to read and write the text.

fragment - true if the result should be a fragment; or false if it should be a complete document

例外:

IOException

導入されたバージョン:

1.0

関連項目:

highlight(String, String, String, boolean)

highlight

String highlight(String name,
               String in,
               String encoding,
               boolean fragment)
                 throws IOException

Transforms source code that's provided through a String to highlighted syntax and returns it as a String.

パラメータ:

name - The name of the source file.

in - The input string that provides the source code that needs to be transformed.

encoding - The encoding that will be used to read and write the text.

fragment - true if the result should be a fragment; or false if it should be a complete document

戻り値:

the highlighted source code as a string

例外:

IOException

導入されたバージョン:

1.0

関連項目:

highlight(String, InputStream, OutputStream, String, boolean)