Interface ParserModule

  • All Known Implementing Classes:
    AbstractParserModule

    public interface ParserModule
    Provides definitions for a Doxia Parser module. This is used by the Doxia Site Tools to find which Doxia modules can parse files, and where to find these files by default (directory and extension).
    Since:
    1.6
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] getExtensions()
      Returns the supported file extensions for a given module.
      java.lang.String getParserId()
      Returns the parser id for a given module.
      java.lang.String getSourceDirectory()
      Returns the directory that contains source files for a given module.
    • Method Detail

      • getSourceDirectory

        java.lang.String getSourceDirectory()
        Returns the directory that contains source files for a given module.
        Returns:
        The source directory.
      • getExtensions

        java.lang.String[] getExtensions()
        Returns the supported file extensions for a given module.
        Returns:
        The supported file extensions.
        Since:
        1.7 (was String getExtension() before)
      • getParserId

        java.lang.String getParserId()
        Returns the parser id for a given module.
        Returns:
        The parser id.