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