1 package org.apache.maven.doxia.parser.module; 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 Parser module. This is used by the Doxia Site Tools to find which 24 * Doxia modules can parse files, and where to find these files by default (directory and extension). 25 * 26 * @since 1.6 27 */ 28 public interface ParserModule 29 { 30 /** 31 * Returns the directory that contains source files for a given module. 32 * 33 * @return The source directory. 34 */ 35 String getSourceDirectory(); 36 37 /** 38 * Returns the default file extension for a given module. 39 * 40 * @return The default file extension. 41 */ 42 String getExtension(); 43 44 /** 45 * Returns the parser id for a given module. 46 * 47 * @return The parser id. 48 */ 49 String getParserId(); 50 }