IJavaSourceConverter


1   package de.java2html.converter;
2   
3   import java.io.IOException  ;
4   import java.io.Writer  ;
5   
6   import de.java2html.javasource.JavaSource;
7   import de.java2html.options.JavaSourceConversionOptions;
8   
9   /**
10   * @author Markus Gebhard
11   */
12  public interface IJavaSourceConverter {
13  
14    public ConverterMetaData getMetaData();
15  
16    /** Returns the default filename extension for the output format of this converter,
17     * e.g. "html" or "tex". 
18     * @deprecated As of 25.01.2006 (Markus Gebhard), replaced by {@link #getMetaData()}, {@link ConverterMetaData#getDefaultFileExtension()}
19     */
20    public String   getDefaultFileExtension();
21  
22    /**
23     * Converts the given source code to the giveen writer, using the specified conversion options.
24     * @param source The source code to be converted to the output format specified
25     *         by this converter.
26     * @param writer The writer to write the output to.
27     * @param options the options to be used for conversion.
28     * @throws IOException if an output error occures while writing to the given writer.
29     */
30    public void convert(JavaSource source, JavaSourceConversionOptions options, Writer   writer) throws IOException  ;
31  
32    /** 
33     * @param title An optional title (e.g. for the html title tag) or an empty string or <code>null</code> if none. 
34     */
35    public void writeDocumentHeader(Writer   writer, JavaSourceConversionOptions options, String   title)
36        throws IOException  ;
37  
38    public void writeDocumentFooter(Writer   writer, JavaSourceConversionOptions options) throws IOException  ;
39  
40    public void writeBlockSeparator(Writer   writer, JavaSourceConversionOptions options) throws IOException  ;
41  
42  }

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags