Coverage Report

Coverage Report - org.apache.maven.doxia.module.site.SiteModule

Classes in this File

 package org.apache.maven.doxia.module.site;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 /**
  * Provides definitions for a Doxia module. This is used by the doxia site tools.
  *
  * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
  * @version $Id: SiteModule.java 746978 2009-02-23 12:20:33Z vsiveton $
  * @since 1.0
  */
 public interface SiteModule
 {
     /** The Plexus lookup role. */
     String ROLE = SiteModule.class.getName();
 
     /**
      * Returns the directory that contains source files for a given module.
      *
      * @return The source directory.
      */
     String getSourceDirectory();
 
     /**
      * Returns the default file extension for a given module.
      *
      * @return The default file extension.
      */
     String getExtension();
 
     /**
      * Returns the parser id for a given module.
      *
      * @return The parser id.
      */
     String getParserId();
 }

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