Knopflerfish OSGi 5.2.0

org.knopflerfish.ant.taskdefs.bundle
Class BundleHTMLExtractorTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.knopflerfish.ant.taskdefs.bundle.BundleHTMLExtractorTask
All Implemented Interfaces:
java.lang.Cloneable

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 dependencies.

All generated HTML will be stored in the directory specified with the attribute outDir preserving the directory structure underneath the files sets that are scanned for jar-files. E.g., a nested file set that selects

 log / log - api.jar
 
will result in an HTML-file
  outDir/log/log-api.html
 

The bundle analyzes is based on the attributes in the manifest.

Parameters

Attribute Description Required
javadocRelPath Relative path (from outDir) to javadocs. No.
Default value is "."
outDir Directory to place resulting files in. 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
    bundle_info.html
    package_list.html
    style.css
 
No.
Default value is "."
systemPackageSet Comma-separated 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-separated set of manifest attributes which shouldn't be printed. No.
Default value is Manifest-Version, Ant-Version, Bundle-Config, Created-By, Built-From
includeSourceFiles Controls if Java source files shall be copied and linked into the HTML structure. No.
Default value "False"
includeSourceFileRepositoryLinks Controls if links to the repository version of Java source files shall be added to the HTML structure. The link target will be created from local file names by replacing the path prefix that matches the property rootDir by repositoryURL. No.
Default value "False"
rootDir The prefix of the source file absolute path to remove when creating a repository URL for the source file. See includeSourceFileRepositoryLinks for details. No.
Default value ""
repositoryURL The base URL to source file repository. See includeSourceFileRepositoryLinks for details. No.
Default value ""
listHeader Heading to print at the top of the bundle list in the left frame of the page. No.
Default value is ""

Parameters specified as nested elements

fileset

(required)

Jar files to analyze must be selected by a nested file set. All jar file selected by a nested file set will be analyzed.

Examples

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

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


Field Summary
 
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
BundleHTMLExtractorTask()
           
 
Method Summary
 void addFileset(org.apache.tools.ant.types.FileSet set)
           
 void execute()
           
 void setAlwaysProps(java.lang.String s)
          Comma separated string with keys that shall have an empty default value.
 void setCheckJavaDoc(boolean b)
           
 void setIncludeSourceFileRepositoryLinks(boolean b)
           
 void setIncludeSourceFiles(boolean b)
           
 void setJavadocRelPath(java.lang.String s)
           
 void setListHeader(java.lang.String s)
           
 void setListProps(java.lang.String s)
           
 void setOutDir(java.lang.String s)
           
 void setRepositoryURL(java.net.URL url)
           
 void setRootDir(java.io.File f)
           
 void setSkipAttribSet(java.lang.String s)
           
 void setSystemPackageSet(java.lang.String s)
           
 void setTemplateHTMLDir(java.io.File f)
           
 
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, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BundleHTMLExtractorTask

public BundleHTMLExtractorTask()
Method Detail

setCheckJavaDoc

public void setCheckJavaDoc(boolean b)

setTemplateHTMLDir

public void setTemplateHTMLDir(java.io.File f)

setIncludeSourceFiles

public void setIncludeSourceFiles(boolean b)

setIncludeSourceFileRepositoryLinks

public void setIncludeSourceFileRepositoryLinks(boolean b)

setRootDir

public void setRootDir(java.io.File f)

setRepositoryURL

public void setRepositoryURL(java.net.URL url)

setOutDir

public void setOutDir(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)
Comma separated string with keys that shall have an empty default value.

Parameters:
s -

setSkipAttribSet

public void setSkipAttribSet(java.lang.String s)

setSystemPackageSet

public void setSystemPackageSet(java.lang.String s)

setListHeader

public void setListHeader(java.lang.String s)

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException

Knopflerfish OSGi 5.2.0