FileDocCategorySizeDatePackage
StyleBook.javaAPI DocApache Ant 1.703847Wed Dec 13 06:16:20 GMT 2006org.apache.tools.ant.taskdefs.optional

StyleBook

public class StyleBook extends org.apache.tools.ant.taskdefs.Java
Executes the Apache Stylebook documentation generator. Unlike the commandline version of this tool, all three arguments are required to run stylebook.

Being extended from <Java>, all the parent's attributes and options are available. Do not set any apart from the classpath as they are not guaranteed to be there in future.

todo
stop extending from Java.
deprecated
since 1.7. This task is considered unsupported by the Ant developers

Fields Summary
protected File
m_targetDirectory
protected File
m_skinDirectory
protected String
m_loaderConfig
protected File
m_book
Constructors Summary
public StyleBook()
Constructor

        setClassname("org.apache.stylebook.StyleBook");
        setFork(true);
        setFailonerror(true);
Methods Summary
public voidexecute()
call the program

throws
BuildException if there is a problem.


        if (null == m_targetDirectory) {
            throw new BuildException("TargetDirectory attribute not set.");
        }

        if (null == m_skinDirectory) {
            throw new BuildException("SkinDirectory attribute not set.");
        }

        if (null == m_book) {
            throw new BuildException("book attribute not set.");
        }

        createArg().setValue("targetDirectory=" + m_targetDirectory);
        createArg().setValue(m_book.toString());
        createArg().setValue(m_skinDirectory.toString());
        if (null != m_loaderConfig) {
            createArg().setValue("loaderConfig=" + m_loaderConfig);
        }

        super.execute();
public voidsetBook(java.io.File book)
Set the book xml file that the documentation generation starts from; required.

param
book the source file

        m_book = book;
public voidsetLoaderConfig(java.lang.String loaderConfig)
A loader configuration to send to stylebook; optional.

param
loaderConfig the configuration to use.

        m_loaderConfig = loaderConfig;
public voidsetSkinDirectory(java.io.File skinDirectory)
Set the directory that contains the stylebook skin; required.

param
skinDirectory the location of the stylebook skin

        m_skinDirectory = skinDirectory;
public voidsetTargetDirectory(java.io.File targetDirectory)
Set the destination directory where the documentation is generated; required.

param
targetDirectory the document output directory

        m_targetDirectory = targetDirectory;