Package com.uwyn.jhighlight.renderer
Interface Renderer
- All Known Implementing Classes:
CppXhtmlRenderer
,GroovyXhtmlRenderer
,JavaXhtmlRenderer
,XhtmlRenderer
,XmlXhtmlRenderer
public interface Renderer
Provides interface to render the source code highlighting.
- Since:
- 1.0
- Version:
- $Revision: 3108 $
-
Method Summary
Modifier and TypeMethodDescriptionvoid
highlight
(String name, InputStream in, OutputStream out, String encoding, boolean fragment) Transforms source code that's provided through anInputStream
to highlighted syntax and writes it back to anOutputStream
.Transforms source code that's provided through aString
to highlighted syntax and returns it as aString
.
-
Method Details
-
highlight
void highlight(String name, InputStream in, OutputStream out, String encoding, boolean fragment) throws IOException Transforms source code that's provided through anInputStream
to highlighted syntax and writes it back to anOutputStream
.- Parameters:
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; orfalse
if it should be a complete document- Throws:
IOException
- Since:
- 1.0
- See Also:
-
highlight
Transforms source code that's provided through aString
to highlighted syntax and returns it as aString
.- Parameters:
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; orfalse
if it should be a complete document- Returns:
- the highlighted source code as a string
- Throws:
IOException
- Since:
- 1.0
- See Also:
-