de.java2html
Class Java2Html

java.lang.Object
  extended by de.java2html.Java2Html

public class Java2Html
extends java.lang.Object

A convenience class providing methods to use the Java2Html converter. By using this class you will not have the ability to benefit from all the features of the Java2Html converter library. However for most standard use cases the methods here will fit your needs.


Method Summary
static java.lang.String convertToHtml(java.lang.String javaSource)
          Converts the given String containing Java source code to HTML by using the standard options of the converter.
static java.lang.String convertToHtml(java.lang.String text, JavaSourceConversionOptions options)
           
static java.lang.String convertToHtml(java.lang.String javaSource, JavaSourceConversionSettings settings)
          Converts the given String containing Java source code to HTML by using the given options for the converter.
static java.lang.String convertToHtmlPage(java.lang.String javaSource)
          Converts the given String containing Java source code to a complete HTML page by using the standard options of the converter.
static java.lang.String convertToHtmlPage(java.lang.String text, JavaSourceConversionOptions options)
           
static java.lang.String convertToHtmlPage(java.lang.String javaSource, JavaSourceConversionSettings settings)
          Converts the given String containing Java source code to a complete HTML page by using the given options for the converter.
static void main(java.lang.String[] args)
          The commandline conversion from Java2HtmlCommandline can be invoked by running this class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

convertToHtml

public static java.lang.String convertToHtml(java.lang.String javaSource)
Converts the given String containing Java source code to HTML by using the standard options of the converter. Will return null if an error occures. The result itself does not have <html> and </html> tags and so can be embedded in any HTML page.

Parameters:
javaSource - The Java source code as plain text.
Returns:
A HTML representation of the Java source code or null if an error occures.
See Also:
convertToHtml(String, JavaSourceConversionOptions), convertToHtmlPage(String)

convertToHtml

public static java.lang.String convertToHtml(java.lang.String javaSource,
                                             JavaSourceConversionSettings settings)
Converts the given String containing Java source code to HTML by using the given options for the converter. Will return null if an error occures. The result itself does not have <html> and </html> tags and so can be embedded in any HTML page.

Parameters:
javaSource - The Java source code as plain text.
settings - conversion options or null to use the standard options
Returns:
A HTML representation of the Java source code or null if an error occures.
See Also:
convertToHtml(String), convertToHtmlPage(String, JavaSourceConversionSettings)

convertToHtmlPage

public static java.lang.String convertToHtmlPage(java.lang.String javaSource)
Converts the given String containing Java source code to a complete HTML page by using the standard options of the converter. Will return null if an error occures.

Parameters:
javaSource - The Java source code as plain text.
Returns:
A HTML representation of the Java source code or null if an error occures.
See Also:
convertToHtmlPage(String, JavaSourceConversionSettings), convertToHtml(String)

convertToHtmlPage

public static java.lang.String convertToHtmlPage(java.lang.String javaSource,
                                                 JavaSourceConversionSettings settings)
Converts the given String containing Java source code to a complete HTML page by using the given options for the converter. Will return null if an error occures.

Parameters:
javaSource - The Java source code as plain text.
settings - conversion options or null to use the standard options
Returns:
A HTML representation of the Java source code or null if an error occures.
See Also:
convertToHtmlPage(String), convertToHtmlPage(String, JavaSourceConversionSettings)

main

public static void main(java.lang.String[] args)
The commandline conversion from Java2HtmlCommandline can be invoked by running this class.


convertToHtml

public static java.lang.String convertToHtml(java.lang.String text,
                                             JavaSourceConversionOptions options)

convertToHtmlPage

public static java.lang.String convertToHtmlPage(java.lang.String text,
                                                 JavaSourceConversionOptions options)