View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.javadoc;
20  
21  import javax.inject.Inject;
22  
23  import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
24  import org.apache.maven.doxia.tools.SiteTool;
25  import org.apache.maven.plugins.annotations.Execute;
26  import org.apache.maven.plugins.annotations.LifecyclePhase;
27  import org.apache.maven.plugins.annotations.Mojo;
28  import org.apache.maven.plugins.annotations.ResolutionScope;
29  import org.apache.maven.plugins.javadoc.resolver.ResourceResolver;
30  import org.apache.maven.project.MavenProjectHelper;
31  import org.apache.maven.project.ProjectBuilder;
32  import org.apache.maven.toolchain.ToolchainManager;
33  import org.codehaus.plexus.archiver.jar.JarArchiver;
34  import org.codehaus.plexus.archiver.manager.ArchiverManager;
35  import org.eclipse.aether.RepositorySystem;
36  
37  /**
38   * <p>Bundles the Javadoc documentation for main <code>Java code</code> in an <b>aggregator</b> project into a jar
39   * using the standard <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html">Javadoc Tool</a>.
40   * </p>
41   *
42   * <p>Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.</p>
43   *
44   * @since 2.6
45   */
46  @Mojo(
47          name = "aggregate-jar",
48          defaultPhase = LifecyclePhase.PACKAGE,
49          aggregator = true,
50          requiresDependencyResolution = ResolutionScope.COMPILE)
51  @Execute(phase = LifecyclePhase.COMPILE)
52  public class AggregatorJavadocJarMojo extends JavadocJarMojo {
53  
54      // CHECKSTYLE_OFF: ParameterNumber
55      @Inject
56      public AggregatorJavadocJarMojo(
57              MavenProjectHelper projectHelper,
58              JarArchiver jarArchiver,
59              SiteTool siteTool,
60              ArchiverManager archiverManager,
61              ResourceResolver resourceResolver,
62              RepositorySystem repoSystem,
63              ArtifactHandlerManager artifactHandlerManager,
64              ProjectBuilder mavenProjectBuilder,
65              ToolchainManager toolchainManager) {
66          super(
67                  projectHelper,
68                  jarArchiver,
69                  siteTool,
70                  archiverManager,
71                  resourceResolver,
72                  repoSystem,
73                  artifactHandlerManager,
74                  mavenProjectBuilder,
75                  toolchainManager);
76      }
77      // CHECKSTYLE_ON: ParameterNumber
78  
79      @Override
80      protected boolean isAggregator() {
81          return true;
82      }
83  }