Knopflerfish OSGi 1.3.3

org.knopflerfish.ant.taskdefs.bundle
Class BundleHTMLExtractorTask

java.lang.Object
  extended byorg.apache.tools.ant.ProjectComponent
      extended byorg.apache.tools.ant.Task
          extended byorg.knopflerfish.ant.taskdefs.bundle.BundleHTMLExtractorTask

public class BundleHTMLExtractorTask
extends org.apache.tools.ant.Task

Task that analyzes a set of bundle jar files and builds HTML documentation from these bundles. Also creates cross-references to bundle dependecies.

All generated HTML will be stored in the same directory stucture as the scanned jars, e.g a jar file

  jars/log/log-api.jar
 
will have a corresponding
  jars/log/log-api.html
 

Bundle jar files files are analyzed using the static manifest attributes.

Parameters

Attribute Description Required
javadocRelPath Relative path (from baseDir) to javadocs. No.
Default value is "."
baseDir Base directory for scanning for jar files. No.
Default value is "."
templateHTMLDir Directory containing HTML template files. This directory must contain the files:
    bundle_index.html
    bundle_list.html
    bundle_main.html
    style.css
   
No.
Default value is "."
systemPackageSet Comma-spearated set of packages which are system packages and thus globally available. These are not cross-referenced. No.
Default value is "javax.swing,javax.accessibility,javax.servlet,javax.xml,org.xml,org.w3c,java,com.sun"
skipAttribSet Comma-spearated set of manifest attributes which shouldn't be printed. No.
Default value is "Manifest-Version,Ant-Version,Bundle-Config,Created-By,Built-From"

Parameters specified as nested elements

fileset

(required)

All jar files must be specified as a fileset. No jar files are ignored.

Examples

 <bundlehtml templateHTMLDir    = "${ant.dir}/html_template"
                baseDir            = "${release.dir}/jars"
		  javadocRelPath     = "../javadoc"
   >

     <fileset dir="${release.dir}/jars">	   
       <include name = "**/*.jar"/>
     </fileset>
 


Field Summary
 
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
BundleHTMLExtractorTask()
           
 
Method Summary
 void addFileset(org.apache.tools.ant.types.FileSet set)
           
 void execute()
           
 void setAlwaysProps(java.lang.String s)
           
 void setBaseDir(java.lang.String s)
           
 void setCheckJavaDoc(java.lang.String s)
           
 void setJavadocRelPath(java.lang.String s)
           
 void setListProps(java.lang.String s)
           
 void setSkipAttribSet(java.lang.String s)
           
 void setSystemPackageSet(java.lang.String s)
           
 void setTemplateHTMLDir(java.lang.String s)
           
 
Methods inherited from class org.apache.tools.ant.Task
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, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BundleHTMLExtractorTask

public BundleHTMLExtractorTask()
Method Detail

setCheckJavaDoc

public void setCheckJavaDoc(java.lang.String s)

setTemplateHTMLDir

public void setTemplateHTMLDir(java.lang.String s)

setBaseDir

public void setBaseDir(java.lang.String s)

setJavadocRelPath

public void setJavadocRelPath(java.lang.String s)

addFileset

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

setListProps

public void setListProps(java.lang.String s)

setAlwaysProps

public void setAlwaysProps(java.lang.String s)

setSkipAttribSet

public void setSkipAttribSet(java.lang.String s)

setSystemPackageSet

public void setSystemPackageSet(java.lang.String s)

execute

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

Knopflerfish OSGi 1.3.3