Module com.aoapps.ant.tasks

Package com.aoapps.ant.tasks

Class SeoJavadocFilter

java.lang.Object

com.aoapps.ant.tasks.SeoJavadocFilter

public final class SeoJavadocFilter
extends Object

Filters javadocs for search engine optimization. Performs the following transformations:

Note: This task should be performed before ZipTimestampMerge in order to have correct content to be able to maintain timestamps.

1. Adds Canonical URLs to each page.
2. Adds <meta name="robots" content="noindex, nofollow"> to selective pages. See getRobotsHeader(java.io.File, org.apache.commons.compress.archivers.zip.ZipArchiveEntry, org.apache.commons.io.function.IOSupplier, java.util.Map, java.lang.Iterable).
3. rel="nofollow" is added to all links matching the configured nofollow and follow prefixes. This defaults to Java SE, Java EE, and Jakarta EE apidocs.

All existing ZIP entry timestamps are preserved.

This does not have any direct Ant dependencies. If only using this class, it is permissible to exclude the ant dependencies.

See javadoc-cleanup GitHub Action.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_URL	The value used to match any URL for SeoJavadocFilterTask.setNofollow(java.lang.String) or SeoJavadocFilterTask.setFollow(java.lang.String).

Method Summary

Modifier and Type	Method	Description
static void	filterJavadocJar(File javadocJar, String apidocsUrl, Iterable<String> nofollow, Iterable<String> follow)	Filters a single JAR file with the transformations described in this class header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ANY_URL

public static final String ANY_URL

The value used to match any URL for SeoJavadocFilterTask.setNofollow(java.lang.String) or SeoJavadocFilterTask.setFollow(java.lang.String).

See Also:

• Constant Field Values

Method Details

filterJavadocJar

public static void filterJavadocJar(File javadocJar,
 String apidocsUrl,
 Iterable<String> nofollow,
 Iterable<String> follow)
                             throws IOException

Filters a single JAR file with the transformations described in this class header.

Parameters:

javadocJar - See SeoJavadocFilterTask.setBuildDirectory(java.lang.String)

apidocsUrl - See SeoJavadocFilterTask.setProjectUrl(java.lang.String) and SeoJavadocFilterTask.setSubprojectSubpath(java.lang.String)

nofollow - See SeoJavadocFilterTask.setNofollow(java.lang.String)

follow - See SeoJavadocFilterTask.setFollow(java.lang.String)

Throws:

IOException