Fikin Ant Tasks
Generated on 20070312 at 2357 by niki
Summary of Ant Tasks:
--------------------------------------
antTasksDocHtmlDoclet
antTasksDocTextDoclet
antTasksPropertiesDoclet
antTasksAntlibDoclet
doclet
stx
toXhtml
velocityDoclet
xpath
xslt2
httpdelete
httpget
httphead
httpmpost
httpoptions
httppost
httpput
httptrace
antTasksDocHtmlDoclet
--------------------------------------
Generate single-page HTML documentation file for all Ant Tasks found
in the source
Recognized classes/tasks must qialify the following criteria:
They are public classes
Not abstract classes
Descendant (direct or indirect) of Ant's Task class
org.apache.tools.ant.Task
Having @antTaskName tag in their class comment, denoting the task name in Ant
Each mandatory setter method must have @antTaskParamRequired tag
in the method's comment
All setter methods are resolved automatically based on Ant specification
for methods introspection
This task is based on {@link VelocityDocletTask}. The Velocity file
ant-doc.html.vm used as HTML-page template is located in this
package folder and loaded via the classloader.
Example:
/**
* This is example class
* @antTaskName exampleTask
* /
public class Example extends Task {
/**
* setter method
* @antTaskParamRequired true
* /
public void setName(String name) { ... }
...
}
created on Sep 24, 2006
Class:
net.sf.fikin.ant.AntTasksDocHtmlDocletTask
Parameters:
bootClasspathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
bootclasspath : Set the boot classpath to use. : false
classpath : : false
classpathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
excludePackageNames : Set the list of packages to be excluded. : false
executable : Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. : false
failonerror : Should the build process fail if javadoc fails (as indicated by
a non zero return code)?
Default is false.
: false
file : set output file to be generated : true
linksource : Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false : false
packageList : The name of a file containing the packages to process. : false
packagenames : Set the package names to be processed. : false
source : Enables the -source switch, will be ignored if javadoc is not
the 1.4 version. : false
sourcepath : Specify where to find source file : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
sourcepathRef : Adds a reference to a CLASSPATH defined elsewhere. : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
velocityLog : if true indicate that a velocity.log is to be generated : false
verbose : Run javadoc in verbose mode : false
Nested Elements:
Adds a fileset.
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java" to the
fileset.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Add a single package to be processed.
If the package name ends with ".*" the Javadoc task
will find and process all subpackages.
false
Parameters:
name : :
Adds a packageset.
All included directories will be translated into package
names be converting the directory separator into dots.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Create a Path to be configured with the boot classpath
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a Path to be configured with the classpath to use
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a doclet parameter to be configured by Ant.
false
Parameters:
name : :
value : :
Nested Elements:
Create a path to be configured with the locations of the source
files.
At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
antTasksDocTextDoclet
--------------------------------------
Generate single-page TEXT documentation file for all Ant Tasks found
in the source
Recognized classes/tasks must qialify the following criteria:
They are public classes
Not abstract classes
Descendant (direct or indirect) of Ant's Task class
org.apache.tools.ant.Task
Having @antTaskName tag in their class comment, denoting the task name in Ant
Each mandatory setter method must have @antTaskParamRequired tag
in the method's comment
The setter method must not be deprecatated
All setter methods are resolved automatically based on Ant specification
for methods introspection
This task is based on {@link VelocityDocletTask}. The Velocity file
ant-doc.html.vm used as text-page template is located in this
package folder and loaded via the classloader.
Example:
/**
* This is example class
* @antTaskName exampleTask
* /
public class Example extends Task {
/**
* setter method
* @antTaskParamRequired true
* /
public void setName(String name) { ... }
...
}
created on Sep 24, 2006
Class:
net.sf.fikin.ant.AntTasksDocTextDocletTask
Parameters:
bootClasspathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
bootclasspath : Set the boot classpath to use. : false
classpath : : false
classpathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
excludePackageNames : Set the list of packages to be excluded. : false
executable : Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. : false
failonerror : Should the build process fail if javadoc fails (as indicated by
a non zero return code)?
Default is false.
: false
file : set output file to be generated : true
linksource : Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false : false
packageList : The name of a file containing the packages to process. : false
packagenames : Set the package names to be processed. : false
source : Enables the -source switch, will be ignored if javadoc is not
the 1.4 version. : false
sourcepath : Specify where to find source file : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
sourcepathRef : Adds a reference to a CLASSPATH defined elsewhere. : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
velocityLog : if true indicate that a velocity.log is to be generated : false
verbose : Run javadoc in verbose mode : false
Nested Elements:
Adds a fileset.
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java" to the
fileset.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Add a single package to be processed.
If the package name ends with ".*" the Javadoc task
will find and process all subpackages.
false
Parameters:
name : :
Adds a packageset.
All included directories will be translated into package
names be converting the directory separator into dots.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Create a Path to be configured with the boot classpath
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a Path to be configured with the classpath to use
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a doclet parameter to be configured by Ant.
false
Parameters:
name : :
value : :
Nested Elements:
Create a path to be configured with the locations of the source
files.
At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
antTasksPropertiesDoclet
--------------------------------------
Generate ant.properties file for all Ant Tasks found
in the source
Recognized classes/tasks must qialify the following criteria:
They are public classes
Not abstract classes
Descendant (direct or indirect) of Ant's Task class
org.apache.tools.ant.Task
Having @antTaskName tag in their class comment, denoting the task name in Ant
Example:
/**
* This is example class
* @antTaskName exampleTask
* /
public class Example extends Task {
...
}
would result in:
...
exampleTask=Example
...
created on Sep 24, 2006
Class:
net.sf.fikin.ant.DocletAntPropertiesTask
Parameters:
bootClasspathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
bootclasspath : Set the boot classpath to use. : false
classpath : : false
classpathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
excludePackageNames : Set the list of packages to be excluded. : false
executable : Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. : false
failonerror : Should the build process fail if javadoc fails (as indicated by
a non zero return code)?
Default is false.
: false
file : set output file to be generated : true
linksource : Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false : false
packageList : The name of a file containing the packages to process. : false
packagenames : Set the package names to be processed. : false
source : Enables the -source switch, will be ignored if javadoc is not
the 1.4 version. : false
sourcepath : Specify where to find source file : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
sourcepathRef : Adds a reference to a CLASSPATH defined elsewhere. : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
velocityLog : if true indicate that a velocity.log is to be generated : false
verbose : Run javadoc in verbose mode : false
Nested Elements:
Adds a fileset.
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java" to the
fileset.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Add a single package to be processed.
If the package name ends with ".*" the Javadoc task
will find and process all subpackages.
false
Parameters:
name : :
Adds a packageset.
All included directories will be translated into package
names be converting the directory separator into dots.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Create a Path to be configured with the boot classpath
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a Path to be configured with the classpath to use
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a doclet parameter to be configured by Ant.
false
Parameters:
name : :
value : :
Nested Elements:
Create a path to be configured with the locations of the source
files.
At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
antTasksAntlibDoclet
--------------------------------------
Generate antlib.xml file for all Ant Tasks found
in the source
Recognized classes/tasks must qialify the following criteria:
They are public classes
Not abstract classes
Descendant (direct or indirect) of Ant's Task class
org.apache.tools.ant.Task
Having @antTaskName tag in their class comment, denoting the task name in Ant
Example:
/**
* This is example class
* @antTaskName exampleTask
* /
public class Example extends Task {
...
}
created on Sep 24, 2006
Class:
net.sf.fikin.ant.DocletAntlibTask
Parameters:
bootClasspathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
bootclasspath : Set the boot classpath to use. : false
classpath : : false
classpathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
excludePackageNames : Set the list of packages to be excluded. : false
executable : Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. : false
failonerror : Should the build process fail if javadoc fails (as indicated by
a non zero return code)?
Default is false.
: false
file : set output file to be generated : true
linksource : Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false : false
packageList : The name of a file containing the packages to process. : false
packagenames : Set the package names to be processed. : false
source : Enables the -source switch, will be ignored if javadoc is not
the 1.4 version. : false
sourcepath : Specify where to find source file : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
sourcepathRef : Adds a reference to a CLASSPATH defined elsewhere. : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
velocityLog : if true indicate that a velocity.log is to be generated : false
verbose : Run javadoc in verbose mode : false
Nested Elements:
Adds a fileset.
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java" to the
fileset.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Add a single package to be processed.
If the package name ends with ".*" the Javadoc task
will find and process all subpackages.
false
Parameters:
name : :
Adds a packageset.
All included directories will be translated into package
names be converting the directory separator into dots.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Create a Path to be configured with the boot classpath
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a Path to be configured with the classpath to use
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a doclet parameter to be configured by Ant.
false
Parameters:
name : :
value : :
Nested Elements:
Create a path to be configured with the locations of the source
files.
At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
doclet
--------------------------------------
Ant task tailored at running JavaDoc Doclets
Example: Execute MyDoclet against some java sources
created on Sep 24, 2006
Class:
net.sf.fikin.ant.DocletTask
Parameters:
bootClasspathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
bootclasspath : Set the boot classpath to use. : false
classpath : : false
classpathRef : Adds a reference to a CLASSPATH defined elsewhere. : false
excludePackageNames : Set the list of packages to be excluded. : false
executable : Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. : false
failonerror : Should the build process fail if javadoc fails (as indicated by
a non zero return code)?
Default is false.
: false
linksource : Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false : false
name : set doclet's fully-qualified class name : true
packageList : The name of a file containing the packages to process. : false
packagenames : Set the package names to be processed. : false
source : Enables the -source switch, will be ignored if javadoc is not
the 1.4 version. : false
sourcepath : Specify where to find source file : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
sourcepathRef : Adds a reference to a CLASSPATH defined elsewhere. : At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
verbose : Run javadoc in verbose mode : false
Nested Elements:
Adds a fileset.
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java" to the
fileset.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Add a single package to be processed.
If the package name ends with ".*" the Javadoc task
will find and process all subpackages.
false
Parameters:
name : :
Adds a packageset.
All included directories will be translated into package
names be converting the directory separator into dots.
false
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Create a Path to be configured with the boot classpath
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a Path to be configured with the classpath to use
false
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Create a doclet parameter to be configured by Ant.
false
Parameters:
name : :
value : :
Nested Elements:
Create a path to be configured with the locations of the source
files.
At least one of the three or nested
<sourcepath>, <fileset> or <packageset>
Parameters:
description : :
location : :
path : :
refid : :
Nested Elements:
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
Nested Elements:
stx
--------------------------------------
STX transformations Ant task
Eseentially the same as {@link XsltTask} but providing Joost-based engine for
transformations
Recognize all parameters of {@link XsltTask} expect <factory>
created on Oct 11, 2006
Class:
net.sf.fikin.ant.StxTask
Parameters:
failOnError : Set whether to abort the execution in case of error during xslt,
by default is true : false
force : Set whether to check dependencies, or always generate;
optional, default is false. : false
in : specifies a single XML document to be styled. Should be used
with the out attribute : required if out is set, otherwise one
or more nested are expected
out : Specifies the output name for the styled result from the
in attribute; required if in is set : required if in is set, otherwise
a nested is expected
reloadStylesheet : Controls whether the stylesheet is reloaded for every transform.
Setting this to true may get around a bug in certain
Xalan-J versions, default is false.
: false
style : Name of the stylesheet to use - given either relative
to the project's basedir or as an absolute path : this or styleSystemId="mySystemId"
Nested Elements:
Adds a set of files to copy.
required if is set too, otherwise in
and out is expected
Parameters:
caseSensitive : :
defaultexcludes : :
description : :
dir : :
excludes : :
excludesfile : :
file : :
followSymlinks : :
includes : :
includesfile : :
refid : :
Create an instance of an XSL parameter type "depends" for configuration by Ant.
false
Parameters:
if : Set whether this param should be used. It will be
used if the property has been set, otherwise it won't. : false
location : set parameter's location : true
unless : Set whether this param should NOT be used. It
will not be used if the property has been set, otherwise it
will be used. : false
Nested Elements:
Create the factory element to configure a trax liaison.
Parameters:
if : Set whether this param should be used. It will be
used if the property has been set, otherwise it won't. : false
name : Set the name of the factory :
unless : Set whether this param should NOT be used. It
will not be used if the property has been set, otherwise it
will be used. : false
Nested Elements:
Create an instance of a factory attribute.
the newly created factory attribute
Parameters:
if : Set whether this param should be used. It will be
used if the property has been set, otherwise it won't. : false
name : name of the parameter : true
type : type of the parameter : false
unless : Set whether this param should NOT be used. It
will not be used if the property has been set, otherwise it
will be used. : false
value : value of the parameter : false
Defines the mapper to map source to destination files.
required if is used
Parameters:
classname : :
classpath : :
classpathRef : :
description : :
from : :
refid : :
to : :
type : :
Nested Elements:
Parameters:
classname : :
classpath : :
classpathRef : :
description : :
from : :
refid : :
to : :
type : :
Nested Elements:
Create an instance of an XSL parameter for configuration by Ant.
false
Parameters:
expression : parameter's expression : this or "location" must be specified
if : Set whether this param should be used. It will be
used if the property has been set, otherwise it won't. : false
location : set parameter's location : this or "expression" must be specified
name : name of the parameter : true
type : type of the parameter : false
unless : Set whether this param should NOT be used. It
will not be used if the property has been set, otherwise it
will be used. : false
value : value of the parameter : false
toXhtml
--------------------------------------
Perform to-XHTML conversion of an input document
to-XHTML is backed by neckHTML parser
Example: Perform to-xhtml conversion only and print the file
created on Jan 5, 2007
Class:
net.sf.fikin.ant.ToXhtml
Parameters:
failOnError : abort build whenever execution error : false
Nested Elements:
create xml/html/xhtml input tag
true
Parameters:
file : set input file : this or property or inner text must be given
namespaceAware : set if DOM factory to be namespace aware : false
property : set input property name : this or file or inner text must be given
saveXHTMLInto : save produced by toXHTML document into a file, useful for
troubleshooting purposes : false
toXHTML : perform to-XHTML transformation to the input document
This is backed by NeckoHTML parser and does few thinks:
fix all open-close tags according built-in logic
fix all HTML-only entities to be XML compliant (such as $nbsp;)
makes all tags upper case
places all tags into default namespace "http://www.w3.org/1999/xhtml"
by default true : false
Nested Elements:
set nested tag's text
this or property or file must be given
Nested Elements: