de.java2html.anttasks
Class Java2HtmlTask

java.lang.Object
  MatchingTask
      de.java2html.anttasks.Java2HtmlTask

public class Java2HtmlTask
extends MatchingTask

Runs the java2html converter as a task inside the well known build tool "ant" (see ant.apache.org). Thanks to Markus Gebhard, the author of java2html itself. I contribute this code to the project under the same license as java2html. For an example for a build.xml containing this task have a look at the docs/anttask/ folder.

Author:

Matthias Bohlen, Markus Gebhard

Constructor Summary

Java2HtmlTask()

Method Summary

void	execute()
void	setAddLineAnchors(boolean addLineAnchors)
void	setCharset(java.lang.String charset) Sets the charset of output file.
void	setDestDir(java.io.File destDir) Sets the directory where the output is written.
void	setHorizontalAlignment(java.lang.String horizontalAlignment)
void	setIncludeDocumentFooter(boolean includeDocumentFooter)
void	setIncludeDocumentHeader(boolean includeDocumentHeader)
void	setLineAnchorPrefix(java.lang.String string)
void	setOutputFormat(java.lang.String outputFormat) Sets the output format.
void	setOverwrite(boolean overwrite)
void	setShowDefaultTitle(boolean showDefaultTitle)
void	setShowFileName(boolean showFileName)
void	setShowLineNumbers(boolean showLineNumbers)
void	setShowTableBorder(boolean showTableBorder)
void	setSrcDir(java.io.File srcDir) Sets the directory where the Java sources are stored.
void	setStyle(java.lang.String style) Sets the table name for the output style, e.g.
void	setTabs(int tabs) Sets the number of spaces per tab.
void	setUseShortFileName(boolean useShortFileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

Java2HtmlTask

public Java2HtmlTask()

Method Detail

setCharset

public void setCharset(java.lang.String charset)

Sets the charset of output file.

Parameters:

charset -

setSrcDir

public void setSrcDir(java.io.File srcDir)

Sets the directory where the Java sources are stored.

Parameters:

srcDir - directory name

setDestDir

public void setDestDir(java.io.File destDir)

Sets the directory where the output is written.

Parameters:

destDir - directory name

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)

Sets the output format.

Parameters:

outputFormat - the output format identifier ("html", "xhtml", "latex")

execute

public void execute()
             throws BuildException

Throws:

BuildException

See Also:

org.apache.tools.ant.Task#execute()

setTabs

public void setTabs(int tabs)

Sets the number of spaces per tab.

Parameters:

tabs -

setStyle

public void setStyle(java.lang.String style)

Sets the table name for the output style, e.g. "kawa" or "eclipse".

See Also:

JavaSourceStyleTable

setShowFileName

public void setShowFileName(boolean showFileName)

setShowLineNumbers

public void setShowLineNumbers(boolean showLineNumbers)

setShowDefaultTitle

public void setShowDefaultTitle(boolean showDefaultTitle)

setShowTableBorder

public void setShowTableBorder(boolean showTableBorder)

setIncludeDocumentFooter

public void setIncludeDocumentFooter(boolean includeDocumentFooter)

setIncludeDocumentHeader

public void setIncludeDocumentHeader(boolean includeDocumentHeader)

setAddLineAnchors

public void setAddLineAnchors(boolean addLineAnchors)

setLineAnchorPrefix

public void setLineAnchorPrefix(java.lang.String string)

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String horizontalAlignment)

setUseShortFileName

public void setUseShortFileName(boolean useShortFileName)

setOverwrite

public void setOverwrite(boolean overwrite)