View Javadoc
1   package org.apache.maven.plugins.javadoc;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.File;
23  import java.nio.file.Path;
24  import java.util.Collection;
25  
26  import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor;
27  import org.codehaus.plexus.languages.java.jpms.ModuleNameSource;
28  
29  /**
30   * Represents a unit of Javadoc referring to the binary and java source paths  
31   * 
32   * @since 3.3.0
33   */
34  public class JavadocModule
35  {
36      private final String ga;
37  
38      private final File artifactFile;
39  
40      private final Collection<Path> sourcePaths;
41  
42      private final JavaModuleDescriptor moduleDescriptor;
43  
44      private final ModuleNameSource moduleNameSource;
45  
46      public JavadocModule( String ga, File artifactFile, Collection<Path> sourcePaths )
47      {
48          this( ga, artifactFile, sourcePaths, null, null );
49      }
50  
51      public JavadocModule( String ga, File artifactFile, Collection<Path> sourcePaths,
52                            JavaModuleDescriptor moduleDescriptor, ModuleNameSource moduleNameSource )
53      {
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      {
63          return ga;
64      }
65  
66      public Collection<Path> getSourcePaths()
67      {
68          return sourcePaths;
69      }
70  
71      public File getArtifactFile()
72      {
73          return artifactFile;
74      }
75  
76      public JavaModuleDescriptor getModuleDescriptor()
77      {
78          return moduleDescriptor;
79      }
80  
81      public ModuleNameSource getModuleNameSource()
82      {
83          return moduleNameSource;
84      }
85  }