Class AbstractParserModule

java.lang.Object
org.apache.maven.doxia.parser.module.AbstractParserModule
All Implemented Interfaces:
ParserModule
Direct Known Subclasses:
AptParserModule, ConfluenceParserModule, DocBookParserModule, FmlParserModule, TWikiParserModule, XdocParserModule, Xhtml5ParserModule, XhtmlParserModule

public abstract class AbstractParserModule extends Object implements ParserModule
An abstract base class that implements the ParserModule interface.
Since:
1.6
  • Field Details

    • sourceDirectory

      private final String sourceDirectory
      The source directory.
    • extensions

      private final String[] extensions
      The supported file extensions.
    • parserId

      private final String parserId
      The default file extension.
  • Constructor Details

    • AbstractParserModule

      public AbstractParserModule()
      Constructor with null.
    • AbstractParserModule

      public AbstractParserModule(String parserId)
      Constructor with same value for everything: source directory and file extension equal parserId.
      Parameters:
      parserId - the parser id
    • AbstractParserModule

      public AbstractParserModule(String parserId, String extension)
      Constructor with same value for parser id and source directory.
      Parameters:
      parserId - the parser id
      extension - the file extension
    • AbstractParserModule

      protected AbstractParserModule(String sourceDirectory, String extension, String parserId)
      Deprecated.
      can cause confusion with constructor with multiple extensions

      Constructor for AbstractParserModule.

      Parameters:
      sourceDirectory - not null
      extension - not null
      parserId - not null
      Since:
      1.1.1
    • AbstractParserModule

      protected AbstractParserModule(String sourceDirectory, String parserId, String... extensions)

      Constructor for AbstractParserModule.

      Parameters:
      sourceDirectory - not null
      parserId - not null (usually equals sourceDirectory)
      extensions - not null
      Since:
      1.7
  • Method Details

    • getSourceDirectory

      public String getSourceDirectory()
      Returns the directory that contains source files for a given module.
      Specified by:
      getSourceDirectory in interface ParserModule
      Returns:
      a String object.
    • getExtensions

      public String[] getExtensions()
      Returns the supported file extensions for a given module.
      Specified by:
      getExtensions in interface ParserModule
      Returns:
      an array of String objects.
    • getParserId

      public String getParserId()
      Returns the parser id for a given module.
      Specified by:
      getParserId in interface ParserModule
      Returns:
      a String object.