1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.maven.doxia.parser.module; 20 21 /** 22 * Provides definitions for a Doxia Parser module. This is used by the Doxia Site Tools to find which 23 * Doxia modules can parse files, and where to find these files by default (directory and extension). 24 * 25 * @since 1.6 26 */ 27 public interface ParserModule { 28 /** 29 * Returns the directory that contains source files for a given module. 30 * 31 * @return The source directory. 32 */ 33 String getSourceDirectory(); 34 35 /** 36 * Returns the supported file extensions for a given module. 37 * 38 * @return The supported file extensions. 39 * @since 1.7 (was String getExtension() before) 40 */ 41 String[] getExtensions(); 42 43 /** 44 * Returns the parser id for a given module. 45 * 46 * @return The parser id. 47 */ 48 String getParserId(); 49 }