View Javadoc
1   package org.apache.maven.doxia.siterenderer;
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  
24  /**
25   * Holds an extra Doxia source module reference in the list of added modules to the site rendering context.
26   *
27   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
28   */
29  class ModuleReference
30  {
31      private final String parserId;
32  
33      private final File basedir;
34  
35      ModuleReference( String parserId, File basedir )
36      {
37          this.parserId = parserId;
38          this.basedir = basedir;
39      }
40  
41      /**
42       * <p>Getter for the field <code>parserId</code>.</p>
43       *
44       * @return Doxia parser id associated to this source module.
45       */
46      public String getParserId()
47      {
48          return parserId;
49      }
50  
51      /**
52       * <p>Getter for the field <code>basedir</code>.</p>
53       *
54       * @return The base directory for module's source files.
55       */
56      public File getBasedir()
57      {
58          return basedir;
59      }
60  }