|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object de.java2html.converter.AbstractJavaSourceConverter
public abstract class AbstractJavaSourceConverter
Abstract superclass for all converters for converting a TypedSource
object to anything else.
For questions, suggestions, bug-reports, enhancement-requests etc.
I may be contacted at:
markus@jave.de
The Java2html home page is located at:
http://www.java2html.de
Constructor Summary | |
---|---|
AbstractJavaSourceConverter(ConverterMetaData metaData)
|
Method Summary | |
---|---|
abstract void |
convert(TypedSource source,
JavaSourceConversionOptions options,
java.io.BufferedWriter writer)
|
void |
convert(TypedSource source,
JavaSourceConversionOptions options,
java.io.Writer writer)
Is called to convert the object 'source' to the destination format. |
abstract java.lang.String |
getBlockSeparator(JavaSourceConversionOptions options)
Returns the code that has to be placed between two blocks of converted code. |
java.lang.String |
getDefaultFileExtension()
Returns the default filename extension for the output format of this converter, e.g. |
abstract java.lang.String |
getDocumentFooter(JavaSourceConversionOptions options)
Returns a footer for the result document. |
abstract java.lang.String |
getDocumentHeader(JavaSourceConversionOptions options,
java.lang.String title)
Returns a header for the result document. |
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)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractJavaSourceConverter(ConverterMetaData metaData)
Method Detail |
---|
public final void convert(TypedSource source, JavaSourceConversionOptions options, java.io.Writer writer) throws java.io.IOException
convert
in interface IJavaSourceConverter
source
- The source code to be converted to the output format specified
by this converter.options
- the options to be used for conversion.writer
- The writer to write the output to.
java.io.IOException
- if an output error occures while writing to the given writer.public abstract void convert(TypedSource source, JavaSourceConversionOptions options, java.io.BufferedWriter writer) throws java.io.IOException
java.io.IOException
public abstract java.lang.String getDocumentHeader(JavaSourceConversionOptions options, java.lang.String title)
title
- public abstract java.lang.String getDocumentFooter(JavaSourceConversionOptions options)
public abstract java.lang.String getBlockSeparator(JavaSourceConversionOptions options)
public void writeDocumentHeader(java.io.Writer writer, JavaSourceConversionOptions options, java.lang.String title) throws java.io.IOException
writeDocumentHeader
in interface IJavaSourceConverter
title
- An optional title (e.g. for the html title tag) or an empty string or null
if none.
java.io.IOException
public void writeDocumentFooter(java.io.Writer writer, JavaSourceConversionOptions options) throws java.io.IOException
writeDocumentFooter
in interface IJavaSourceConverter
java.io.IOException
public void writeBlockSeparator(java.io.Writer writer, JavaSourceConversionOptions options) throws java.io.IOException
writeBlockSeparator
in interface IJavaSourceConverter
java.io.IOException
public final java.lang.String getDefaultFileExtension()
IJavaSourceConverter
getDefaultFileExtension
in interface IJavaSourceConverter
public final ConverterMetaData getMetaData()
getMetaData
in interface IJavaSourceConverter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |