com.java2html

Class Java2HTML

java.lang.Object

com.java2html.Java2HTML

public class Java2HTML
extends java.lang.Object

Generates Java2HTML output

Constructor Summary

Constructors

Constructor and Description
Java2HTML()

Method Summary

Modifier and Type	Method and Description
boolean	buildJava2HTML() Builds the Java2HTML returns true if there where no failures detected
boolean	isQuiet()
static void	main(java.lang.String[] options) Called by Command Line Wrappers
void	setDestination(java.lang.String destination) Sets the output directory that the generated HTML will be placed into.
void	setFooter(boolean footer) Determines if a footer should be generated when buildJava2HTML() is called.
void	setHeader(boolean header) Determines if a header should be generated when buildJava2HTML() is called.
void	setJavaDirectorySource(java.lang.String[] directories) Set the Java Source directories that will be converted into HTML.
void	setJavaDoc(JavaDoc[] javaDocOptions) Set the Java Doc directories.
void	setJavaFileSource(java.lang.String[] files) Sets a list of java source files that will be converted into HTML.
void	setMarginSize(int marginSize) Set the margin size that should be generated when buildJava2HTML() is called.
void	setQuiet(boolean quiet) Determines whether operation is in quiet mode (= not verbose).
void	setSimple(boolean simple) Determines if only the java source and stylesheet files will be output
void	setTabSize(int tabSize) Set the number of spaces that tabs will be converted to when buildJava2HTML() is called.
void	setTitle(java.lang.String title) Set the title that will be used when buildJava2HTML() is called.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Java2HTML

public Java2HTML()

Method Detail

buildJava2HTML

public boolean buildJava2HTML()
                       throws java.lang.Exception

Builds the Java2HTML returns true if there where no failures detected

Throws:

java.lang.Exception

isQuiet

public final boolean isQuiet()

main

public static void main(java.lang.String[] options)

Called by Command Line Wrappers

Parameters:

options -

setDestination

public void setDestination(java.lang.String destination)

Sets the output directory that the generated HTML will be placed into.

Parameters:

destination - Directory where output will be directed to

setFooter

public void setFooter(boolean footer)

Determines if a footer should be generated when buildJava2HTML() is called.

Parameters:

footer - set to true if a header is required

setHeader

public void setHeader(boolean header)

Determines if a header should be generated when buildJava2HTML() is called.

Parameters:

header - set to true if a header is required

setJavaDirectorySource

public void setJavaDirectorySource(java.lang.String[] directories)
                            throws BadOptionException

Set the Java Source directories that will be converted into HTML. This has replaced setJavaSorce(String[]) Overwrite any setting used by setJavaFileSource

Parameters:

directories - List of Java Source Directories

Throws:

BadOptionException

setJavaDoc

public void setJavaDoc(JavaDoc[] javaDocOptions)

Set the Java Doc directories.

Parameters:

javaDocOptions - List of JavaDocOptions

setJavaFileSource

public void setJavaFileSource(java.lang.String[] files)

Sets a list of java source files that will be converted into HTML. Use instead of setJavaDirectorySource() if a file lisy is availabe

Parameters:

files - List of Java Files

setMarginSize

public void setMarginSize(int marginSize)

Set the margin size that should be generated when buildJava2HTML() is called.

Parameters:

marginSize - Margin Size

setQuiet

public final void setQuiet(boolean quiet)

Determines whether operation is in quiet mode (= not verbose).

Parameters:

quiet - true to be quiet, false to be verbose. default is verbose.

setSimple

public void setSimple(boolean simple)

Determines if only the java source and stylesheet files will be output

Parameters:

simple - set to true for simple output

setTabSize

public void setTabSize(int tabSize)

Set the number of spaces that tabs will be converted to when buildJava2HTML() is called.

Parameters:

tabSize - Number of spaces tabs should be converted to.

setTitle

public void setTitle(java.lang.String title)

Set the title that will be used when buildJava2HTML() is called.

Parameters:

title - The title that will be displayed in the generated HTML