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

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.
pkgPropertyName	Name of property that the resulting java package list is appended to.	No. No default value.

Examples

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

BundleJavadocHelperTask()

Method Summary

void	execute()
void	setExportPkgsFile(java.io.File f) Set property receiving the file to load export package definitions from.
void	setPkgPropertyName(java.lang.String s) Set property receiving the bundle class path pattern.
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.

setPkgPropertyName

public void setPkgPropertyName(java.lang.String s)

Set property receiving the bundle class path pattern.

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

Throws:

org.apache.tools.ant.BuildException