001package org.apache.maven.doxia.parser.module; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022/** 023 * Provides definitions for a Doxia Parser module. This is used by the Doxia Site Tools to find which 024 * Doxia modules can parse files, and where to find these files by default (directory and extension). 025 * 026 * @since 1.6 027 */ 028public interface ParserModule 029{ 030 /** 031 * Returns the directory that contains source files for a given module. 032 * 033 * @return The source directory. 034 */ 035 String getSourceDirectory(); 036 037 /** 038 * Returns the supported file extensions for a given module. 039 * 040 * @return The supported file extensions. 041 * @since 1.7 (was String getExtension() before) 042 */ 043 String[] getExtensions(); 044 045 /** 046 * Returns the parser id for a given module. 047 * 048 * @return The parser id. 049 */ 050 String getParserId(); 051}