org.knopflerfish.ant.taskdefs.bundle

Class BundleJavadocHelperTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.knopflerfish.ant.taskdefs.bundle.BundleJavadocHelperTask

All Implemented Interfaces:

java.lang.Cloneable

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

Task that helps building arguments to javadoc.

• Loads source paths from a file removes duplicates and adds them to a path structure.
• Loads export package definitions from a file removes duplicates and OSGi specific annotation, then adds them to a comma separated string that will be set as the value of a named property.

  Parameters

  Attribute	Description	Required
  srcRootsFile	The file to read source tree root directories from.	No. No default value.
  srcPropertyName	Name of property that the resulting java source roots are appended to.	No. No default value.
  srcPathId	Id of a path like structure to append the source root dirs to. The structure is created if needed.	No. No default value.
  exportPkgsFile	The file to read export package definitions from.	No. No default value.
  exportPkgsValue	A single Export-Package header value to convert.	No. No default value.
  pkgPropertyName	Name of property that the resulting java package list is appended to.	No. No default value.
  srcDir	Path to the root of a Java source tree. Used together with exportPkgsValue to check if there are source files availble for any of the exported packages. The result is assigned to the property named by pkgSrcAvailPropertyName.	No. No default value.
  pkgSrcAvailPropertyName	Name of property that will be set to true if any of the packages present in the value of exportPkgsValue has a source file (*.java or packages.html) in the Java source tree specified by srcDir.	No. No default value.
  pkgWithSourcePropertyName	Name of property that will be set to the sub-list of packages with source code of the java package list saved in pkgPropertyName.	No. No default value.

  Examples

  Create a comma separated list of package names (without attributes, and directives) and save the list as the value of the property with name javadoc.packages. The package names are read from the file that is the value of the property exported.file. This file contains the value of one Export-Package definition per line.

   <bundle_javadoc_helper exportPkgsFile="${exported.file}"
                             pkgPropertyName="javadoc.packages"/>
   

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

Constructors

Constructor and Description
BundleJavadocHelperTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
void	setExportPkgsFile(java.io.File f) Set property receiving the file to load export package definitions from.
void	setExportPkgsValue(java.lang.String s) Set property receiving the export package definition to handle.
void	setPkgPropertyName(java.lang.String s) Set property receiving the bundle class path pattern.
void	setPkgSrcAvailPropertyName(java.lang.String s) Set name of property to be set if there are javadoc source files for the packages selected by the value of pkgPropertyName available in srcDir.
void	setPkgWithSourcePropertyName(java.lang.String s) Set property receiving the filtered list of exported packages.
void	setSrcDir(java.io.File f) Property receiving the root of the source tree to check for availability of javadoc source files in when setting pkgSrcAvailPropertyName.
void	setSrcPathId(java.lang.String s) Set id of path like structure receiving to add source root directories to.
void	setSrcPropertyName(java.lang.String s) Set property receiving the comma separated string with source root directories.
void	setSrcRootsFile(java.io.File f) Set property receiving the file to load source root directory names from.

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

BundleJavadocHelperTask

public BundleJavadocHelperTask()

Method Detail

setExportPkgsFile

public void setExportPkgsFile(java.io.File f)

Set property receiving the file to load export package definitions from.

setExportPkgsValue

public void setExportPkgsValue(java.lang.String s)

Set property receiving the export package definition to handle.

setPkgPropertyName

public void setPkgPropertyName(java.lang.String s)

Set property receiving the bundle class path pattern.

setSrcDir

public void setSrcDir(java.io.File f)

Property receiving the root of the source tree to check for availability of javadoc source files in when setting pkgSrcAvailPropertyName.

setPkgSrcAvailPropertyName

public void setPkgSrcAvailPropertyName(java.lang.String s)

Set name of property to be set if there are javadoc source files for the packages selected by the value of pkgPropertyName available in srcDir.

setPkgWithSourcePropertyName

public void setPkgWithSourcePropertyName(java.lang.String s)

Set property receiving the filtered list of exported packages. I.e., the list of exported packages that has at least one source file.

setSrcRootsFile

public void setSrcRootsFile(java.io.File f)

Set property receiving the file to load source root directory names from.

setSrcPropertyName

public void setSrcPropertyName(java.lang.String s)

Set property receiving the comma separated string with source root directories.

setSrcPathId

public void setSrcPathId(java.lang.String s)

Set id of path like structure receiving to add source root directories to.

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