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 java.io.File;
22  import java.nio.file.Path;
23  import java.util.Collection;
24  
25  import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor;
26  import org.codehaus.plexus.languages.java.jpms.ModuleNameSource;
27  
28  /**
29   * Represents a unit of Javadoc referring to the binary and java source paths
30   *
31   * @since 3.3.0
32   */
33  public class JavadocModule {
34      private final String ga;
35  
36      private final File artifactFile;
37  
38      private final Collection<Path> sourcePaths;
39  
40      private final JavaModuleDescriptor moduleDescriptor;
41  
42      private final ModuleNameSource moduleNameSource;
43  
44      public JavadocModule(String ga, File artifactFile, Collection<Path> sourcePaths) {
45          this(ga, artifactFile, sourcePaths, null, null);
46      }
47  
48      public JavadocModule(
49              String ga,
50              File artifactFile,
51              Collection<Path> sourcePaths,
52              JavaModuleDescriptor moduleDescriptor,
53              ModuleNameSource moduleNameSource) {
54          this.ga = ga;
55          this.artifactFile = artifactFile;
56          this.sourcePaths = sourcePaths;
57          this.moduleDescriptor = moduleDescriptor;
58          this.moduleNameSource = moduleNameSource;
59      }
60  
61      public String getGa() {
62          return ga;
63      }
64  
65      public Collection<Path> getSourcePaths() {
66          return sourcePaths;
67      }
68  
69      public File getArtifactFile() {
70          return artifactFile;
71      }
72  
73      public JavaModuleDescriptor getModuleDescriptor() {
74          return moduleDescriptor;
75      }
76  
77      public ModuleNameSource getModuleNameSource() {
78          return moduleNameSource;
79      }
80  }