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 783285 2009-06-10 10:52:19Z vsiveton $
27 * @since 1.0
28 */
29 public abstract class AbstractSiteModule
30 implements SiteModule
31 {
32 /** The source directory. */
33 private final String sourceDirectory;
34
35 /** The default file extension. */
36 private final String extension;
37
38 /** The default file extension. */
39 private final String parserId;
40
41 /**
42 * Constructor with null.
43 */
44 public AbstractSiteModule()
45 {
46 this( null, null, null );
47 }
48
49 /**
50 * @param sourceDirectory not null
51 * @param extension not null
52 * @param parserId not null
53 * @since 1.1.1
54 */
55 protected AbstractSiteModule( String sourceDirectory, String extension, String parserId )
56 {
57 super();
58 this.sourceDirectory = sourceDirectory;
59 this.extension = extension;
60 this.parserId = parserId;
61 }
62
63 /** {@inheritDoc} */
64 public String getSourceDirectory()
65 {
66 return sourceDirectory;
67 }
68
69 /** {@inheritDoc} */
70 public String getExtension()
71 {
72 return extension;
73 }
74
75 /** {@inheritDoc} */
76 public String getParserId()
77 {
78 return parserId;
79 }
80 }