Fikin Ant Tasks

Description:

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) { ... }
          ...
      }
 

Class:

net.sf.fikin.ant.AntTasksDocHtmlDocletTask

Parameters:

Nested Elements:

Description:

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

      /**
       * This is example class
       * @antTaskName exampleTask
       * /
      public class Example extends Task {
          /**
           * setter method
           * @antTaskParamRequired true
           * /
          public void setName(String name) { ... }
          ...
      }
 

Class:

net.sf.fikin.ant.AntTasksDocTextDocletTask

Parameters:

Nested Elements:

Description:

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:

Nested Elements:

Description:

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 {
          ...
      }
 

would result in:

      ...
      <task name="exampleTask" class="Example" />
      ...
 

created on Sep 24, 2006

Class:

net.sf.fikin.ant.DocletAntlibTask

Parameters:

Nested Elements:

Description:

Ant task tailored at running JavaDoc Doclets

Example: Execute MyDoclet against some java sources

      <doclet name="net.sf.fikin.ant.MyDoclet" >
          <packageset dir="src" defaultexcludes="yes">
              <include name="net/sf/fikin/ant/**" />
          </packageset>
      </doclet>
 

Example: Pass current timestamp as extra Java System parameters used by MyDoclet

      <doclet name="net.sf.fikin.ant.MyDoclet" >
          <packageset dir="src" defaultexcludes="yes">
              <include name="net/sf/fikin/ant/**" />
          </packageset>
          <param name="-J-DDSTAMP=${DSTAMP}" />
      </doclet>
 

Class:

net.sf.fikin.ant.DocletTask

Parameters:

Nested Elements:

Description:

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>

Class:

net.sf.fikin.ant.StxTask

Parameters:

Nested Elements:

Description:

to-XHTML is backed by neckHTML parser

Example: Perform to-xhtml conversion only and print the file

      <toXhtml>
          <input file="in1.html" />
          <output property="p1" />
      </toXhtml>
      <echo>${p1}</echo>
 

created on Jan 5, 2007

Class:

net.sf.fikin.ant.ToXhtml

Parameters:

Nested Elements:

Description:

Dedicated Ant task for executing a Velocity Template via {@link net.sf.fikin.doclets.VelocityDoclet} doclet

Example: Execute a template against some java sources

      <velocityDoclet template="my-template.vm" file="my-output.txt" >
          <packageset dir="src" defaultexcludes="yes">
              <include name="net/sf/fikin/ant/**" />
          </packageset>
      </velocityDoclet>
 

Example: Pass current timestamp as extra Java System parameters read by the template

      <velocityDoclet template="my-template.vm" file="my-output.txt" >
          <packageset dir="src" defaultexcludes="yes">
              <include name="net/sf/fikin/ant/**" />
          </packageset>
          <param name="-J-DDSTAMP=${DSTAMP}" />
      </velocityDoclet>
 

Class:

net.sf.fikin.ant.VelocityDocletTask

Parameters:

Nested Elements:

Description:

Execute XPath expressions against input XML/HTML data and return result.

Support XML or HTML inputs

Support writing to Project properties or a file

Support for multiple xpath expressions per single input

Example:

      <xpath>
          <input file="bin/test/ant/test1/in1.xml" />
          <output property="p1" />
          <forEach select="/root/id" >
              <valueOf select="local-name(..)" />
              <valueOf select="'/'" />
              <valueOf select="local-name()" />
          </forEach>
          <forEach select="/root" >
              <valueOf select="local-name()" />
              <valueOf select="' count nested tags : '" />
              <valueOf select="count(.)" />
          </forEach>
      </xpath>
      <echo>${p1}</echo>
 

where for input file:

      <root><id/></root>
 

would set property p1 to: [echo] root/id root count nested tags : 1

Example:

      <xpath>
          <input>
              <![CDATA[ <root><tag id="1"/><tag id="2"/></root> ]]>
          </input>
          <forEach select="/root/tag" >
              <valueOf select="@id" />
          </forEach>
          <sequential>
              <echo>@{node}</echo>
          </sequential>
      </xpath>
 

would print out: [echo] 1 [echo] 2

created on Jan 3, 2007

Class:

net.sf.fikin.ant.XPathTask

Parameters:

Nested Elements:

Description:

Reworked version of Ant's STYLE/XSLT task

Main differences are:

• transformation is based on {@link net.sf.fikin.xml.Xslt} object
• one is capable of specifying location="..." instead of expression="..." for parameteres and attibutes. This allows for up-to-date dependency checking and also passing these values as URLs instead of simple file names. Last is required by Xalan when the xslt parameter is document location.
• one can specify nested <depend location="..."> elements. They serve to enrich the up-to-date dependency checking with files which could be typically referenced from the xswlt itself and thus Ant would otherwise have no ability to see them. This is a short version of using <dependset> task.

Class:

net.sf.fikin.ant.XsltTask

Parameters:

Nested Elements:

Description:

Perform HTTP DELETE method

Examples:

 
      <httpdelete url="..." />
 
      <httpdelete url="..." logLevel="all" />
 
      <httpdelete url="..." logLevel="content" >
          <userCredentials ... />
      </httpdelete>
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntDeleteMethod

Parameters:

Nested Elements:

Description:

Perform HTTP GET method

Examples:

 
      <httpget url="..." />
 
      <httpget url="..." logLevel="content" logFile="..." followRedirect="true" />
 
      <httpget url="..." >
          <userCredentials ... />
      </httpget>
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntGetMethod

Parameters:

Nested Elements:

Description:

Perform HTTP HEAD method

Examples:

 
      <httphead url="..." />
 
      <httphead url="..." logLevel="content" logFile="..." />
 
      <httphead url="..." >
          <userCredentials ... />
      </httphead>
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntHeadMethod

Parameters:

Nested Elements:

Description:

Perform HTTP POST method (multu-part message)

This is the only way to submit file(s) and plain text together in one http post call. File uploading is only possible via this method.

Examples:

 
      <httpmpost url="..." >
          <credentials ... />
          <postString>Here is my string to send</postString>
          <postFile name="..." type="text" />
      </httpmpost>
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntMultipartPostMethod

Parameters:

Nested Elements:

Description:

Perform HTTP OPTIONS method

Examples:

 
      <httpoptions url="..." />
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntOptionsMethod

Parameters:

Nested Elements:

Description:

Perform HTTP POST method

This method is same as html-form submit. It is suitable for submitting set of fields with their values.

Examples:

 
      <httppost url="..." >
          <post name="username" value="usr" />
          <post name="password" value="pswd" />
          <post name="submit"   value="" />
      </httppost>
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntPostMethod

Parameters:

Nested Elements:

Description:

Perform HTTP PUT method

No multupart body, single body and params are to be mentioned only in the query

Examples:

 
      <httpput url="..." >Put this text in the body</httpput>
 
      <httpput url="..." putFile="..." />
 
 

Class:

net.sf.fikin.ant.httpclientanttask.AntPutMethod

Parameters: