Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.plugins.javadoc;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugins.annotations.Execute;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.MavenReportException;
import org.codehaus.plexus.util.StringUtils;
import org.eclipse.aether.util.filter.ScopeDependencyFilter;
/**
* Generates documentation for the Java Test code in an NON aggregator project using the standard
* Javadoc Tool.
*
* @author Vincent Siveton
* @since 2.3
* @see Javadoc Tool
*/
@Mojo(name = "test-javadoc", requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true)
@Execute(phase = LifecyclePhase.GENERATE_TEST_SOURCES)
public class TestJavadocReport extends JavadocReport {
// ----------------------------------------------------------------------
// Javadoc Options (should be inline with options defined in TestJavadocJar)
// ----------------------------------------------------------------------
/**
* Specifies the Test title to be placed near the top of the overview summary file.
* @see Doclet option doctitle.
* @since 2.5
*/
@Parameter(
property = "testDoctitle",
alias = "doctitle",
defaultValue = "${project.name} ${project.version} Test API")
private String testDoctitle;
/**
* Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file
* specified by path/filename and place it on the Overview page (overview-summary.html).
* @see Doclet option overview.
* @since 2.5
*/
@Parameter(
property = "testOverview",
alias = "overview",
defaultValue = "${basedir}/src/test/javadoc/overview.html")
private File testOverview;
/**
* Specifies the Test title to be placed in the HTML title tag.
* @see Doclet option windowtitle.
* @since 2.5
*/
@Parameter(
property = "testWindowtitle",
alias = "windowtitle",
defaultValue = "${project.name} ${project.version} Test API")
private String testWindowtitle;
// ----------------------------------------------------------------------
// Mojo Parameters (should be inline with options defined in TestJavadocJar)
// ----------------------------------------------------------------------
/**
* Specifies the destination directory where test Javadoc saves the generated HTML files.
*/
@Parameter(
property = "reportTestOutputDirectory",
defaultValue = "${project.reporting.outputDirectory}/testapidocs",
required = true)
private File reportOutputDirectory;
/**
* The name of the destination directory.
*
*/
@Parameter(property = "destDir", defaultValue = "testapidocs")
private String destDir;
/**
* Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
*
* Could be used in addition of docfilessubdirs parameter.
*
* See docfilessubdirs.
*
* @since 2.5
*/
@Parameter(alias = "javadocDirectory", defaultValue = "${basedir}/src/test/javadoc")
private File testJavadocDirectory;
// ----------------------------------------------------------------------
// Report Mojo Parameters
// ----------------------------------------------------------------------
/**
* The name of the Test Javadoc report to be displayed in the Maven Generated Reports page
* (i.e. project-reports.html).
*
* @since 2.5
*/
@Parameter(property = "testName", alias = "name")
private String testName;
/**
* The description of the Test Javadoc report to be displayed in the Maven Generated Reports page
* (i.e. project-reports.html).
*
* @since 2.5
*/
@Parameter(property = "testDescription", alias = "description")
private String testDescription;
// ----------------------------------------------------------------------
// Report public methods
// ----------------------------------------------------------------------
@Override
protected void executeReport(Locale unusedLocale) throws MavenReportException {
addMainJavadocLink();
super.executeReport(unusedLocale);
}
@Override
public String getName(Locale locale) {
if (testName == null || testName.isEmpty()) {
return getBundle(locale).getString("report.test-javadoc.name");
}
return testName;
}
@Override
public String getDescription(Locale locale) {
if (testDescription == null || testDescription.isEmpty()) {
return getBundle(locale).getString("report.test-javadoc.description");
}
return testDescription;
}
@Override
public String getOutputName() {
return destDir + "/index";
}
@Override
public File getReportOutputDirectory() {
if (reportOutputDirectory == null) {
return outputDirectory;
}
return reportOutputDirectory;
}
/**
* Method to set the directory where the generated reports will be put
*
* @param reportOutputDirectory the directory file to be set
*/
@Override
public void setReportOutputDirectory(File reportOutputDirectory) {
updateReportOutputDirectory(reportOutputDirectory, destDir);
}
@Override
public void setDestDir(String destDir) {
this.destDir = destDir;
updateReportOutputDirectory(reportOutputDirectory, destDir);
}
private void updateReportOutputDirectory(File reportOutputDirectory, String destDir) {
if (reportOutputDirectory != null
&& destDir != null
&& !reportOutputDirectory.getAbsolutePath().endsWith(destDir)) {
this.reportOutputDirectory = new File(reportOutputDirectory, destDir);
} else {
this.reportOutputDirectory = reportOutputDirectory;
}
}
// ----------------------------------------------------------------------
// Protected methods
// Important Note: should be inline with methods defined in TestJavadocJar
// ----------------------------------------------------------------------
@Override
protected List getProjectBuildOutputDirs(MavenProject p) {
List dirs = new ArrayList<>();
if (StringUtils.isNotEmpty(p.getBuild().getOutputDirectory())) {
dirs.add(new File(p.getBuild().getOutputDirectory()));
}
if (StringUtils.isNotEmpty(p.getBuild().getTestOutputDirectory())) {
dirs.add(new File(p.getBuild().getTestOutputDirectory()));
}
return dirs;
}
@Override
protected List getProjectSourceRoots(MavenProject p) {
if ("pom".equals(p.getPackaging().toLowerCase())) {
return Collections.emptyList();
}
return p.getTestCompileSourceRoots() == null
? Collections.emptyList()
: new LinkedList<>(p.getTestCompileSourceRoots());
}
@Override
protected List getExecutionProjectSourceRoots(MavenProject p) {
if ("pom".equals(p.getExecutionProject().getPackaging().toLowerCase())) {
return Collections.emptyList();
}
return p.getExecutionProject().getTestCompileSourceRoots() == null
? Collections.emptyList()
: new LinkedList<>(p.getExecutionProject().getTestCompileSourceRoots());
}
@Override
protected File getJavadocDirectory() {
return testJavadocDirectory;
}
@Override
protected String getDoctitle() {
return testDoctitle;
}
@Override
protected File getOverview() {
return testOverview;
}
@Override
protected String getWindowtitle() {
return testWindowtitle;
}
@Override
protected ScopeDependencyFilter getDependencyScopeFilter() {
return new ScopeDependencyFilter(
Arrays.asList(
Artifact.SCOPE_COMPILE, Artifact.SCOPE_PROVIDED, Artifact.SCOPE_SYSTEM, Artifact.SCOPE_TEST),
null);
}
/**
* Gets the resource bundle for the specified locale.
*
* @param locale The locale of the currently generated report.
* @return The resource bundle for the requested locale.
*/
private ResourceBundle getBundle(Locale locale) {
return ResourceBundle.getBundle(
"test-javadoc-report", locale, getClass().getClassLoader());
}
/**
* Add the ../apidocs to the links parameter so Test report could be linked to the Main report.
*/
private void addMainJavadocLink() {
if (links == null) {
links = new ArrayList<>();
}
// TODO the prerequisite is that the main report is in apidocs
File apidocs = new File(getReportOutputDirectory().getParentFile(), "apidocs");
if (apidocs.isDirectory() && !links.contains("../apidocs")) {
links.add("../apidocs");
}
}
/**
* Overridden to enable the resolution of -test-sources jar files.
*
* {@inheritDoc}
*/
@Override
protected SourceResolverConfig configureDependencySourceResolution(final SourceResolverConfig config) {
return super.configureDependencySourceResolution(config)
.withoutCompileSources()
.withTestSources();
}
@Override
protected boolean isTest() {
return true;
}
}
