Skip to content

Issue #378 Cleanup of code related to old non supported Java version #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2025
Merged

Issue #378 Cleanup of code related to old non supported Java version #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,7 +468,7 @@ protected String getArtifactType(MavenProject p) {
*/
protected List<String> getProjectSourceRoots(MavenProject p) {
return p.getCompileSourceRoots() == null
? Collections.<String>emptyList()
? Collections.emptyList()
: new LinkedList<>(p.getCompileSourceRoots());
}

Expand All @@ -480,7 +480,7 @@ protected List<String> getProjectSourceRoots(MavenProject p) {
*/
protected List<String> getCompileClasspathElements(MavenProject p) throws DependencyResolutionRequiredException {
return p.getCompileClasspathElements() == null
? Collections.<String>emptyList()
? Collections.emptyList()
: new LinkedList<>(p.getCompileClasspathElements());
}

Expand Down Expand Up @@ -855,7 +855,7 @@ private ClassLoader getProjectClassLoader() throws MojoExecutionException {
}
}

projectClassLoader = new URLClassLoader(urls.toArray(new URL[urls.size()]), parent);
projectClassLoader = new URLClassLoader(urls.toArray(new URL[0]), parent);
}

return projectClassLoader;
Expand Down Expand Up @@ -1724,7 +1724,7 @@ JavaEntityTags parseJavadocTags(

if (isJavaMethod) {
List<String> params = docletTag.getParameters();
if (params.size() < 1) {
if (params.isEmpty()) {
continue;
}

Expand Down Expand Up @@ -1769,7 +1769,7 @@ private void updateJavadocTags(
JavaExecutable javaExecutable = (JavaExecutable) entity;

List<String> params = docletTag.getParameters();
if (params.size() < 1) {
if (params.isEmpty()) {
continue;
}

Expand Down Expand Up @@ -2439,7 +2439,7 @@ private boolean isNewMethodFromLastRevision(JavaExecutable javaExecutable) throw
}
if (clirrMethod.contains(retrn + " ")
&& clirrMethod.contains(javaExecutable.getName() + "(")
&& clirrMethod.contains("(" + params.toString() + ")")) {
&& clirrMethod.contains("(" + params + ")")) {
return true;
}
}
Expand Down
152 changes: 38 additions & 114 deletions src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,44 +212,6 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
private static final String PACKAGE_LIST = "package-list";
private static final String ELEMENT_LIST = "element-list";

/**
* For Javadoc options appears since Java 1.4.
* See <a href="https://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.1.html#summary">
* What's New in Javadoc 1.4</a>
*
* @since 2.1
*/
private static final JavaVersion SINCE_JAVADOC_1_4 = JavaVersion.parse("1.4");

/**
* For Javadoc options appears since Java 1.4.2.
* See <a
* href="https://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.4.2.html#commandlineoptions">
* What's New in Javadoc 1.4.2</a>
*
* @since 2.1
*/
private static final JavaVersion SINCE_JAVADOC_1_4_2 = JavaVersion.parse("1.4.2");

/**
* For Javadoc options appears since Java 5.0.
* See <a
* href="https://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.5.0.html#commandlineoptions">
* What's New in Javadoc 5.0</a>
*
* @since 2.1
*/
private static final JavaVersion SINCE_JAVADOC_1_5 = JavaVersion.parse("1.5");

/**
* For Javadoc options appears since Java 6.0.
* See <a href="https://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html">
* Javadoc Technology</a>
*
* @since 2.4
*/
private static final JavaVersion SINCE_JAVADOC_1_6 = JavaVersion.parse("1.6");

/**
* For Javadoc options appears since Java 8.0.
* See <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/index.html">
Expand Down Expand Up @@ -1802,7 +1764,7 @@ protected List<String> getProjectSourceRoots(MavenProject p) {
}

return p.getCompileSourceRoots() == null
? Collections.<String>emptyList()
? Collections.emptyList()
: new LinkedList<>(p.getCompileSourceRoots());
}

Expand All @@ -1816,7 +1778,7 @@ protected List<String> getExecutionProjectSourceRoots(MavenProject p) {
}

return p.getExecutionProject().getCompileSourceRoots() == null
? Collections.<String>emptyList()
? Collections.emptyList()
: new LinkedList<>(p.getExecutionProject().getCompileSourceRoots());
}

Expand Down Expand Up @@ -3330,7 +3292,7 @@ private List<String> getArtifactsAbsolutePath(JavadocPathArtifact javadocArtifac
* @param javadocArtifact the {@link JavadocPathArtifact} to resolve
* @return a resolved {@link Artifact}
* @throws org.eclipse.aether.resolution.ArtifactResolutionException
* @throws ArtifactResolverException issue while resolving artifact
* @throws org.eclipse.aether.resolution.ArtifactResolutionException issue while resolving artifact
*/
private Artifact createAndResolveArtifact(JavadocPathArtifact javadocArtifact)
throws org.eclipse.aether.resolution.ArtifactResolutionException {
Expand Down Expand Up @@ -3861,7 +3823,6 @@ private void addLinkArguments(List<String> arguments) throws MavenReportExceptio
*
* @param javadocOutputDirectory not null
* @throws MavenReportException if any
* @see #copyDefaultStylesheet(File)
* @see #copyJavadocResources(File)
* @see #copyAdditionalJavadocResources(File)
*/
Expand Down Expand Up @@ -4234,13 +4195,8 @@ private void addCommandLineOptions(Commandline cmd, List<String> arguments, File
private void addCommandLineArgFile(Commandline cmd, File javadocOutputDirectory, List<String> files)
throws MavenReportException {
File argfileFile;
if (JAVA_VERSION.compareTo(SINCE_JAVADOC_1_4) >= 0) {
argfileFile = new File(javadocOutputDirectory, ARGFILE_FILE_NAME);
cmd.createArg().setValue("@" + ARGFILE_FILE_NAME);
} else {
argfileFile = new File(javadocOutputDirectory, FILES_FILE_NAME);
cmd.createArg().setValue("@" + FILES_FILE_NAME);
}
argfileFile = new File(javadocOutputDirectory, ARGFILE_FILE_NAME);
cmd.createArg().setValue("@" + ARGFILE_FILE_NAME);

List<String> quotedFiles = new ArrayList<>(files.size());
for (String file : files) {
Expand Down Expand Up @@ -4378,20 +4334,15 @@ private void addJavadocOptions(

// all options in alphabetical order

if (old && isJavaDocVersionAtLeast(SINCE_JAVADOC_1_4)) {
if (getLog().isWarnEnabled()) {
getLog().warn("Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option.");
}
} else {
addArgIf(arguments, old, "-1.1");
if (getLog().isWarnEnabled()) {
getLog().warn("Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option.");
}
Comment on lines +4337 to 4339
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @olamy

I was trying to track down where I have any of these options in my build as I started to see these warnigns in the logs 🙈 🙂

It seems that with this change the message is logged all the time, no matter if any option is set or not ..

maybe it should've been:

Suggested change
if (getLog().isWarnEnabled()) {
getLog().warn("Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option.");
}
if (old && getLog().isWarnEnabled()) {
getLog().warn("Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option.");
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure see there #1240

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice 🙂 thanks for pointing me to that PR 🎉!


addArgIfNotEmpty(arguments, "-bootclasspath", JavadocUtil.quotedPathArgument(getBootclassPath()));

if (isJavaDocVersionAtLeast(SINCE_JAVADOC_1_5)) {
addArgIf(arguments, breakiterator, "-breakiterator", SINCE_JAVADOC_1_5);
if (breakiterator) {
addArgIf(arguments, breakiterator, "-breakiterator");
}

List<MavenProject> aggregatedProjects = reactorProjects; // getAggregatedProjects();
Map<String, MavenProject> reactorKeys = new HashMap<>(aggregatedProjects.size());
for (MavenProject reactorProject : aggregatedProjects) {
Expand Down Expand Up @@ -4651,15 +4602,13 @@ private void addJavadocOptions(

arguments.add(getAccessLevel());

if (isJavaDocVersionAtLeast(SINCE_JAVADOC_1_5)) {
addArgIf(arguments, quiet, "-quiet", SINCE_JAVADOC_1_5);
}
addArgIf(arguments, quiet, "-quiet");

if (javadocRuntimeVersion.isAtLeast("9") && release != null) {
arguments.add("--release");
arguments.add(release);
} else {
addArgIfNotEmpty(arguments, "-source", JavadocUtil.quotedArgument(source), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-source", JavadocUtil.quotedArgument(source));
}

if ((sourcepath == null || sourcepath.isEmpty()) && (subpackages != null && !subpackages.isEmpty())) {
Expand All @@ -4682,12 +4631,10 @@ private void addJavadocOptions(
arguments, "--module-source-path", JavadocUtil.quotedPathArgument(moduleSourceDir.toString()));
}

if ((sourcepath != null && !sourcepath.isEmpty()) && isJavaDocVersionAtLeast(SINCE_JAVADOC_1_5)) {
addArgIfNotEmpty(arguments, "-subpackages", subpackages, SINCE_JAVADOC_1_5);
}
addArgIfNotEmpty(arguments, "-subpackages", subpackages);

// [MJAVADOC-497] must be after sourcepath is recalculated, since getExcludedPackages() depends on it
addArgIfNotEmpty(arguments, "-exclude", getExcludedPackages(sourcePaths), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-exclude", getExcludedPackages(sourcePaths));

addArgIf(arguments, verbose, "-verbose");

Expand Down Expand Up @@ -4757,28 +4704,23 @@ private void addStandardDocletOptions(

addArgIfNotEmpty(arguments, "-bottom", JavadocUtil.quotedArgument(getBottomText()), false, false);

if (!isJavaDocVersionAtLeast(SINCE_JAVADOC_1_5)) {
addArgIf(arguments, breakiterator, "-breakiterator", SINCE_JAVADOC_1_4);
}
addArgIf(arguments, breakiterator, "-breakiterator");

addArgIfNotEmpty(arguments, "-charset", JavadocUtil.quotedArgument(getCharset()));

addArgIfNotEmpty(arguments, "-d", JavadocUtil.quotedPathArgument(javadocOutputDirectory.toString()));

addArgIfNotEmpty(arguments, "-docencoding", JavadocUtil.quotedArgument(getDocencoding()));

addArgIf(arguments, docfilessubdirs, "-docfilessubdirs", SINCE_JAVADOC_1_4);
addArgIf(arguments, docfilessubdirs, "-docfilessubdirs");

addArgIf(arguments, (doclint != null && !doclint.isEmpty()), "-Xdoclint:" + getDoclint(), SINCE_JAVADOC_1_8);

addArgIfNotEmpty(arguments, "-doctitle", JavadocUtil.quotedArgument(getDoctitle()), false, false);

if (docfilessubdirs) {
addArgIfNotEmpty(
arguments,
"-excludedocfilessubdir",
JavadocUtil.quotedPathArgument(excludedocfilessubdir),
SINCE_JAVADOC_1_4);
arguments, "-excludedocfilessubdir", JavadocUtil.quotedPathArgument(excludedocfilessubdir));
}

addArgIfNotEmpty(arguments, "-footer", JavadocUtil.quotedArgument(footer), false, false);
Expand All @@ -4787,30 +4729,23 @@ private void addStandardDocletOptions(

addArgIfNotEmpty(arguments, "-header", JavadocUtil.quotedArgument(header), false, false);

Optional<File> helpFile = getHelpFile(javadocOutputDirectory);
if (helpFile.isPresent()) {
addArgIfNotEmpty(
arguments,
"-helpfile",
JavadocUtil.quotedPathArgument(helpFile.get().getAbsolutePath()));
}
getHelpFile(javadocOutputDirectory)
.ifPresent(file -> addArgIfNotEmpty(
arguments, "-helpfile", JavadocUtil.quotedPathArgument(file.getAbsolutePath())));

addArgIf(arguments, keywords, "-keywords", SINCE_JAVADOC_1_4_2);
addArgIf(arguments, keywords, "-keywords");

addLinkArguments(arguments);

addLinkofflineArguments(arguments, offlineLinks);

addArgIf(arguments, linksource, "-linksource", SINCE_JAVADOC_1_4);
addArgIf(arguments, linksource, "-linksource");

if (sourcetab > 0) {
if (javadocRuntimeVersion == SINCE_JAVADOC_1_4_2) {
addArgIfNotEmpty(arguments, "-linksourcetab", String.valueOf(sourcetab));
}
addArgIfNotEmpty(arguments, "-sourcetab", String.valueOf(sourcetab), SINCE_JAVADOC_1_5);
addArgIfNotEmpty(arguments, "-sourcetab", String.valueOf(sourcetab));
}

addArgIf(arguments, nocomment, "-nocomment", SINCE_JAVADOC_1_4);
addArgIf(arguments, nocomment, "-nocomment");

addArgIf(arguments, nodeprecated, "-nodeprecated");

Expand All @@ -4824,7 +4759,7 @@ private void addStandardDocletOptions(

addArgIf(arguments, nooverview, "-nooverview");

addArgIfNotEmpty(arguments, "-noqualifier", JavadocUtil.quotedArgument(noqualifier), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-noqualifier", JavadocUtil.quotedArgument(noqualifier));

addArgIf(arguments, nosince, "-nosince");

Expand All @@ -4834,44 +4769,34 @@ private void addStandardDocletOptions(
notimestamp = true;
}

addArgIf(arguments, notimestamp, "-notimestamp", SINCE_JAVADOC_1_5);
addArgIf(arguments, notimestamp, "-notimestamp");

addArgIf(arguments, notree, "-notree");

addArgIfNotEmpty(arguments, "-packagesheader", JavadocUtil.quotedArgument(packagesheader), SINCE_JAVADOC_1_4_2);
addArgIfNotEmpty(arguments, "-packagesheader", JavadocUtil.quotedArgument(packagesheader));

if (!isJavaDocVersionAtLeast(SINCE_JAVADOC_1_5)) // Sun bug: 4714350
{
addArgIf(arguments, quiet, "-quiet", SINCE_JAVADOC_1_4);
}
addArgIf(arguments, quiet, "-quiet");

addArgIf(arguments, serialwarn, "-serialwarn");

addArgIf(arguments, splitindex, "-splitindex");

Optional<File> stylesheetfile = getStylesheetFile(javadocOutputDirectory);

if (stylesheetfile.isPresent()) {
addArgIfNotEmpty(
arguments,
"-stylesheetfile",
JavadocUtil.quotedPathArgument(stylesheetfile.get().getAbsolutePath()));
}
getStylesheetFile(javadocOutputDirectory)
.ifPresent(file -> addArgIfNotEmpty(
arguments, "-stylesheetfile", JavadocUtil.quotedPathArgument(file.getAbsolutePath())));

addAddStyleSheets(arguments);

if ((sourcepath != null && !sourcepath.isEmpty()) && !isJavaDocVersionAtLeast(SINCE_JAVADOC_1_5)) {
addArgIfNotEmpty(arguments, "-subpackages", subpackages, SINCE_JAVADOC_1_4);
}
addArgIfNotEmpty(arguments, "-subpackages", subpackages);

addArgIfNotEmpty(arguments, "-taglet", JavadocUtil.quotedArgument(taglet), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-taglet", JavadocUtil.quotedArgument(taglet));
addTaglets(arguments);
addTagletsFromTagletArtifacts(arguments);
addArgIfNotEmpty(arguments, "-tagletpath", JavadocUtil.quotedPathArgument(getTagletPath()), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-tagletpath", JavadocUtil.quotedPathArgument(getTagletPath()));

addTags(arguments);

addArgIfNotEmpty(arguments, "-top", JavadocUtil.quotedArgument(top), false, false, SINCE_JAVADOC_1_6);
addArgIfNotEmpty(arguments, "-top", JavadocUtil.quotedArgument(top), false, false);

addArgIf(arguments, use, "-use");

Expand Down Expand Up @@ -4936,7 +4861,7 @@ private void addTags(List<String> arguments) throws MavenReportException {
}
}
value += "\"";
addArgIfNotEmpty(arguments, "-tag", value, SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-tag", value);
}
}
}
Expand All @@ -4957,8 +4882,7 @@ private void addTaglets(List<String> arguments) {
getLog().warn("A taglet option is empty. Ignore this option.");
}
} else {
addArgIfNotEmpty(
arguments, "-taglet", JavadocUtil.quotedArgument(taglet1.getTagletClass()), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-taglet", JavadocUtil.quotedArgument(taglet1.getTagletClass()));
}
}
}
Expand Down Expand Up @@ -5056,7 +4980,7 @@ private void addTagletsFromTagletArtifacts(List<String> arguments) throws MavenR

if (tagletClasses != null && !tagletClasses.isEmpty()) {
for (String tagletClass : tagletClasses) {
addArgIfNotEmpty(arguments, "-taglet", JavadocUtil.quotedArgument(tagletClass), SINCE_JAVADOC_1_4);
addArgIfNotEmpty(arguments, "-taglet", JavadocUtil.quotedArgument(tagletClass));
}
}
}
Expand Down Expand Up @@ -5603,7 +5527,7 @@ private List<String> getDependenciesLinks() {
url = getJavadocLink(artifactProject);
detected = true;
} catch (ProjectBuildingException e) {
logError("ProjectBuildingException for " + artifact.toString() + ": " + e.getMessage(), e);
logError("ProjectBuildingException for " + artifact + ": " + e.getMessage(), e);
continue;
}
}
Expand Down
Loading