BundleHTMLExtractorTask

Overview

Package

Class

Tree

Deprecated

Index

Help

Knopflerfish OSGi 3.1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.knopflerfish.ant.taskdefs.bundle
Class BundleHTMLExtractorTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          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 direcotry, baseDir that is scanned for jar-files, e.g a jar file

  baseDir/log/log-api.jar

will result in an HTML-file

  outDir/log/log-api.html

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

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 "."
baseDir	Remove this part of the path from the specified jar-files and use the remainder as file name in the outDir.	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)

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

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)`
`void`	`setBaseDir(java.lang.String s)`
`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