de.java2html.converter
Interface IJavaSourceConverter

All Known Implementing Classes:
AbstractJavaSourceConverter, AbstractJavaSourceToXmlConverter, JavaSource2HTMLConverter, JavaSource2RtfConverter, JavaSource2TeXConverter, JavaSource2Xhtml11Converter, JavaSource2XhtmlConverter, JavaSource2XmlConverter

public interface IJavaSourceConverter

Author:
Markus Gebhard

Method Summary
 void convert(TypedSource source, JavaSourceConversionOptions options, java.io.Writer writer)
          Converts the given source code to the giveen writer, using the specified conversion options.
 java.lang.String getDefaultFileExtension()
          Deprecated. As of 25.01.2006 (Markus Gebhard), replaced by getMetaData(), ConverterMetaData.getDefaultFileExtension()
 ConverterMetaData getMetaData()
           
 void writeBlockSeparator(java.io.Writer writer, JavaSourceConversionOptions options)
           
 void writeDocumentFooter(java.io.Writer writer, JavaSourceConversionOptions options)
           
 void writeDocumentHeader(java.io.Writer writer, JavaSourceConversionOptions options, java.lang.String title)
           
 

Method Detail

getMetaData

ConverterMetaData getMetaData()

getDefaultFileExtension

@Deprecated
java.lang.String getDefaultFileExtension()
Deprecated. As of 25.01.2006 (Markus Gebhard), replaced by getMetaData(), ConverterMetaData.getDefaultFileExtension()

Returns the default filename extension for the output format of this converter, e.g. "html" or "tex".


convert

void convert(TypedSource source,
             JavaSourceConversionOptions options,
             java.io.Writer writer)
             throws java.io.IOException
Converts the given source code to the giveen writer, using the specified conversion options.

Parameters:
source - The source code to be converted to the output format specified by this converter.
writer - The writer to write the output to.
options - the options to be used for conversion.
Throws:
java.io.IOException - if an output error occures while writing to the given writer.

writeDocumentHeader

void writeDocumentHeader(java.io.Writer writer,
                         JavaSourceConversionOptions options,
                         java.lang.String title)
                         throws java.io.IOException
Parameters:
title - An optional title (e.g. for the html title tag) or an empty string or null if none.
Throws:
java.io.IOException

writeDocumentFooter

void writeDocumentFooter(java.io.Writer writer,
                         JavaSourceConversionOptions options)
                         throws java.io.IOException
Throws:
java.io.IOException

writeBlockSeparator

void writeBlockSeparator(java.io.Writer writer,
                         JavaSourceConversionOptions options)
                         throws java.io.IOException
Throws:
java.io.IOException


Copyright 2003 - 2006