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 import org.apache.maven.doxia.parser.module.ParserModule;
23
24 /**
25 * Provides definitions for a Doxia module. This is used by the doxia site tools.
26 *
27 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
28 * @version $Id: SiteModule.java 1546011 2013-11-27 12:18:20Z hboutemy $
29 * @since 1.0
30 * @deprecated use ParserModule
31 * @see ParserModule
32 */
33 public interface SiteModule
34 {
35 /** The Plexus lookup role. */
36 String ROLE = SiteModule.class.getName();
37
38 /**
39 * Returns the directory that contains source files for a given module.
40 *
41 * @return The source directory.
42 */
43 String getSourceDirectory();
44
45 /**
46 * Returns the default file extension for a given module.
47 *
48 * @return The default file extension.
49 */
50 String getExtension();
51
52 /**
53 * Returns the parser id for a given module.
54 *
55 * @return The parser id.
56 */
57 String getParserId();
58 }