1 package org.apache.maven.doxia.module.site;
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 /**
23 * An abstract base class that implements the SiteModule interface.
24 *
25 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
26 * @version $Id: AbstractSiteModule.java 1546011 2013-11-27 12:18:20Z hboutemy $
27 * @since 1.0
28 * @deprecated replaced by AbstractParserModule
29 */
30 public abstract class AbstractSiteModule
31 implements SiteModule
32 {
33 /** The source directory. */
34 private final String sourceDirectory;
35
36 /** The default file extension. */
37 private final String extension;
38
39 /** The default file extension. */
40 private final String parserId;
41
42 /**
43 * Constructor with null.
44 */
45 public AbstractSiteModule()
46 {
47 this( null, null, null );
48 }
49
50 /**
51 * @param sourceDirectory not null
52 * @param extension not null
53 * @param parserId not null
54 * @since 1.1.1
55 */
56 protected AbstractSiteModule( String sourceDirectory, String extension, String parserId )
57 {
58 super();
59 this.sourceDirectory = sourceDirectory;
60 this.extension = extension;
61 this.parserId = parserId;
62 }
63
64 /** {@inheritDoc} */
65 public String getSourceDirectory()
66 {
67 return sourceDirectory;
68 }
69
70 /** {@inheritDoc} */
71 public String getExtension()
72 {
73 return extension;
74 }
75
76 /** {@inheritDoc} */
77 public String getParserId()
78 {
79 return parserId;
80 }
81 }