Module com.aoapps.ant.tasks

Package com.aoapps.ant.tasks

Class GenerateJavadocSitemapTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.aoapps.ant.tasks.GenerateJavadocSitemapTask

All Implemented Interfaces:

Cloneable

public class GenerateJavadocSitemapTask
extends Task

Ant task that invokes GenerateJavadocSitemap.addSitemapToJavadocJar(java.io.File, java.lang.String).

Author:

AO Industries, Inc.

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	Description
GenerateJavadocSitemapTask()

Method Summary

Modifier and Type	Method	Description
void	execute()	Calls GenerateJavadocSitemap.addSitemapToJavadocJar(java.io.File, java.lang.String) for each file in setBuildDirectory(java.lang.String) that matches SeoJavadocFilterTask.javadocJarFilter while logging to Task.log(java.lang.String, int).
void	setBuildDirectory(String buildDirectory)	The current build directory.
void	setProjectUrl(String projectUrl)	The project url.
void	setSubprojectSubpath(String subprojectSubpath)	The sub-project sub-path used in the url.

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 Details

GenerateJavadocSitemapTask

public GenerateJavadocSitemapTask()

Method Details

setBuildDirectory

public void setBuildDirectory(String buildDirectory)

The current build directory. Must exist and be a directory.

Each file ending with ""-javadoc.jar"" (case-insensitive) will be processed.

Each file is a Javadoc JAR file to add sitemap to and must be a regular file.

setProjectUrl

public void setProjectUrl(String projectUrl)

The project url. The apidocs URLs will be based on this, depending on artifact classifier. Ending in "*-test-javadoc.jar" will be "${projectUrl}${subprojectSubpath}test/apidocs/". Otherwise will be "${projectUrl}${subprojectSubpath}apidocs/"

See Also:

• setSubprojectSubpath(java.lang.String)

setSubprojectSubpath

public void setSubprojectSubpath(String subprojectSubpath)

The sub-project sub-path used in the url.

See Also:

• setProjectUrl(java.lang.String)

execute

public void execute()
             throws BuildException

Calls GenerateJavadocSitemap.addSitemapToJavadocJar(java.io.File, java.lang.String) for each file in setBuildDirectory(java.lang.String) that matches SeoJavadocFilterTask.javadocJarFilter while logging to Task.log(java.lang.String, int).

Overrides:

execute in class Task

Throws:

BuildException