Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.taskdefs.optional

Class StyleBook

public class StyleBook
extends 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.

To do:
stop extending from Java.

Field Summary

protected File
m_book
protected String
m_loaderConfig
protected File
m_skinDirectory
protected File
m_targetDirectory

Fields inherited from class org.apache.tools.ant.taskdefs.Java

redirector, redirectorElement

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

StyleBook()
Sole constructor.

Method Summary

void
execute()
call the program
void
setBook(File book)
The book xml file that the documentation generation starts from; required.
void
setLoaderConfig(String loaderConfig)
A loader configuration to send to stylebook; optional.
void
setSkinDirectory(File skinDirectory)
the directory that contains the stylebook skin; required.
void
setTargetDirectory(File targetDirectory)
the destination directory where the documentation is generated; required.

Methods inherited from class org.apache.tools.ant.taskdefs.Java

addAssertions, addConfiguredRedirector, addEnv, addSysproperty, addSyspropertyset, clearArgs, createArg, createBootclasspath, createClasspath, createJvmarg, createPermissions, createWatchdog, execute, executeJava, getCommandLine, getSysProperties, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, maybeSetResultPropertyValue, run, setAppend, setArgs, setClassname, setClasspath, setClasspathRef, setDir, setError, setErrorProperty, setFailonerror, setFork, setInput, setInputString, setJVMVersion, setJar, setJvm, setJvmargs, setLogError, setMaxmemory, setNewenvironment, setOutput, setOutputproperty, setResultProperty, setSpawn, setTimeout, setupRedirector

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

m_book

protected File m_book

m_loaderConfig

protected String m_loaderConfig

m_skinDirectory

protected File m_skinDirectory

m_targetDirectory

protected File m_targetDirectory

Constructor Details

StyleBook

public StyleBook()
Sole constructor.

Method Details

execute

public void execute()
            throws BuildException
call the program
Overrides:
execute in interface Java

setBook

public void setBook(File book)
The book xml file that the documentation generation starts from; required.

setLoaderConfig

public void setLoaderConfig(String loaderConfig)
A loader configuration to send to stylebook; optional.

setSkinDirectory

public void setSkinDirectory(File skinDirectory)
the directory that contains the stylebook skin; required.

setTargetDirectory

public void setTargetDirectory(File targetDirectory)
the destination directory where the documentation is generated; required.

Overview Package Tree Index Deprecated About
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.