net.sf.xframe.xsddoc

Class Task

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

net.sf.xframe.xsddoc.Task

All Implemented Interfaces:

java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer

public final class Task
extends org.apache.tools.ant.taskdefs.MatchingTask

Adapter for xsddoc processor to Apache Ant.

Generates XML Schema documentation using the xsddoc tool.

Parameters

Attribute	Description	Required
schemaLoaction	deprecated, see file parameter	Exactly one of the these or nested <fileset>
file	shortcut for specifying a single file fileset
dir	shortcut for specifying a single folder fileset
out	destination directory for output files	Yes
xml	If output should be XML instead of HTML. (yes | no). Default is no	No
css	provide external CSS file	&
title	deprecated, see doctitle parameter	No
doctitle	Include title for the package index(first) page (html-code)	No
header	Include header text for each page (html-code)	No
footer	Include footer text for each page (html-code)	No
bottom	Include bottom text for each page (html-code)	No
failonerror	Log a warning message, but do not stop the build, when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. (yes | no). Default is no	No
verbose	Output messages about what xsddoc is doing. (yes | no). Default is yes	No
quiet	Be quiet about what xsddoc is doing. (yes | no). Default is no	No
debug	Output internal messages about what xsddoc is doing. (yes | no). Default is no	No
hideSubTypes	hide sub types references. (yes | no). Default is no	No
hideLocalUsage	hide local usage references. (yes | no). Default is no	No
hideTypes	hide types in overview pages. (yes | no). Default is no	No
hideGroups	hide groups in overview pages. (yes | no). Default is no	No
hideAttributes	hide attributes in overview pages. (yes | no). Default is no	No

Parameters specified as nested elements

fileset

FileSets are used to select sets of files to process. To use a fileset, the todir attribute must be set.

doctitle

Same as the doctitle attribute, but you can nest text inside the element this way.

header

Similar to <doctitle>.

footer

Similar to <doctitle>.

bottom

Similar to <doctitle>.

Usage in Apache Ant build files:

<!--
  Define xsddoc task.
-->
<taskdef name="xsddoc" classname="net.sf.xframe.xsddoc.Task"/>

<!--
  Use xsddoc task.
-->
<xsddoc file="myschema.xsd"
         out="doc/schema/myschema">
  <doctitle><![CDATA[XML Schema for XML Schema]]></doctitle>
</xsddoc>
 

Author:

Kurt Riede

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Html An HTML fragment in a nested element of the xsddoc task.

Field Summary

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

fileset

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

Constructors

Constructor and Description
Task() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addBottom(Task.Html theBottom) Set the text to be placed at the bottom of each output file.
void	addDoctitle(Task.Html text) Add a document title to use for the overview page.
void	addFileset(org.apache.tools.ant.types.FileSet set) Adds a set of files to be deleted.
void	addFooter(Task.Html text) Set the footer text to be placed at the bottom of each output file.
void	addHeader(Task.Html theHeader) Set the header text to be placed at the top of each output file.
void	execute() Execute xsddoc task.
void	setBottom(java.lang.String theBottom) Set the text to be placed at the bottom of each output file.
protected void	setCreateFolder(boolean createFolder) Setter method for createFolder attribute.
void	setCss(java.lang.String css) Setter method for css property.
void	setDebug(boolean isDebug) Setter method for debug property.
void	setDir(java.lang.String theDir) Setter method for dir property.
void	setDoctitle(java.lang.String theDoctitle) Set the title of the generated overview page.
void	setFailonerror(boolean isFailonerror) Setter method for failonerror attribute.
void	setFile(java.lang.String theFile) Setter method for file property.
void	setFooter(java.lang.String theFooter) Set the footer text to be placed at the bottom of each output file.
void	setHeader(java.lang.String theHeader) Set the header text to be placed at the top of each output file.
void	setHideattributes(boolean hideAttributes) Setter method for hideAttributes property.
void	setHidegroups(boolean hideGroups) Setter method for hideGroups property.
void	setHidelocalusage(boolean hideLocalUsage) Setter method for hideLocalUsage property.
void	setHidesubtypes(boolean hideSubTypes) Setter method for hideSubTypes property.
void	setHidetypes(boolean hideTypes) Setter method for hideTypes property.
protected void	setLauch(boolean launch) Setter method for lauch attribute.
void	setOut(java.lang.String out) Setter method for out property.
void	setQuiet(boolean isQuiet) Setter method for quiet property.
void	setSchemalocation(java.lang.String schemaLocation) Deprecated. use setFile(java.lang.String) instead
void	setTitle(java.lang.String title) Deprecated. use setDoctitle(java.lang.String) instead
void	setVerbose(boolean isVerbose) Setter method for verbose property.
void	setXml(boolean isXml) Setter method for xml attribute.

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

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

clone, getDescription, getLocation, getProject, setDescription, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Default constructor.

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Execute xsddoc task.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - if execution of xsddoc task failed

setDebug

public void setDebug(boolean isDebug)

Setter method for debug property.

Parameters:

isDebug - output debug information or not

setOut

public void setOut(java.lang.String out)

Setter method for out property.

Parameters:

out - output folder to use

setSchemalocation

public void setSchemalocation(java.lang.String schemaLocation)

Deprecated. use setFile(java.lang.String) instead

Setter method for schemaLocation property.

Parameters:

schemaLocation - location of XML schema to use

See Also:

setFile(java.lang.String)

setFile

public void setFile(java.lang.String theFile)

Setter method for file property.

Parameters:

theFile - location of XML schema

setDir

public void setDir(java.lang.String theDir)

Setter method for dir property.

Parameters:

theDir - folder to search for schemas

setTitle

public void setTitle(java.lang.String title)

Deprecated. use setDoctitle(java.lang.String) instead

Setter method for title property.

Parameters:

title - title to use

See Also:

setDoctitle(java.lang.String)

setCss

public void setCss(java.lang.String css)

Setter method for css property.

Parameters:

css - location of XML schema

setVerbose

public void setVerbose(boolean isVerbose)

Setter method for verbose property.

Parameters:

isVerbose - be verbose or not

setQuiet

public void setQuiet(boolean isQuiet)

Setter method for quiet property.

Parameters:

isQuiet - be quiet or not

setHidelocalusage

public void setHidelocalusage(boolean hideLocalUsage)

Setter method for hideLocalUsage property.

Parameters:

hideLocalUsage - if local usage should be hidden or not

setHidesubtypes

public void setHidesubtypes(boolean hideSubTypes)

Setter method for hideSubTypes property.

Parameters:

hideSubTypes - if sub types should be hidden or not

setHidetypes

public void setHidetypes(boolean hideTypes)

Setter method for hideTypes property.

Parameters:

hideTypes - if types should be hidden or not

setHideattributes

public void setHideattributes(boolean hideAttributes)

Setter method for hideAttributes property.

Parameters:

hideAttributes - if attributes should be hidden or not

setHidegroups

public void setHidegroups(boolean hideGroups)

Setter method for hideGroups property.

Parameters:

hideGroups - if groups should be hidden or not

setXml

public void setXml(boolean isXml)

Setter method for xml attribute.

Parameters:

isXml - boolean

setFailonerror

public void setFailonerror(boolean isFailonerror)

Setter method for failonerror attribute.

Parameters:

isFailonerror - if should fail on error or not

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)

Adds a set of files to be deleted.

Parameters:

set - the set of files to be deleted

addDoctitle

public void addDoctitle(Task.Html text)

Add a document title to use for the overview page.

Parameters:

text - the HTML element containing the document title.

setDoctitle

public void setDoctitle(java.lang.String theDoctitle)

Set the title of the generated overview page.

Parameters:

theDoctitle - the Document title.

setHeader

public void setHeader(java.lang.String theHeader)

Set the header text to be placed at the top of each output file.

Parameters:

theHeader - the header text

addHeader

public void addHeader(Task.Html theHeader)

Set the header text to be placed at the top of each output file.

Parameters:

theHeader - the header text

addFooter

public void addFooter(Task.Html text)

Set the footer text to be placed at the bottom of each output file.

Parameters:

text - the footer text.

setFooter

public void setFooter(java.lang.String theFooter)

Set the footer text to be placed at the bottom of each output file.

Parameters:

theFooter - the footer text.

setBottom

public void setBottom(java.lang.String theBottom)

Set the text to be placed at the bottom of each output file.

Parameters:

theBottom - the bottom text.

addBottom

public void addBottom(Task.Html theBottom)

Set the text to be placed at the bottom of each output file.

Parameters:

theBottom - the bottom text.

setCreateFolder

protected void setCreateFolder(boolean createFolder)

Setter method for createFolder attribute.

Parameters:

createFolder - if out folder should be created

setLauch

protected void setLauch(boolean launch)

Setter method for lauch attribute.

Parameters:

launch - if documentation should be launched in browser