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