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
An abstract base class that implements the ParserModule interface.
- Since:
- 1.6
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructor with null.AbstractParserModule
(String parserId) Constructor with same value for everything: source directory and file extension equal parserId.AbstractParserModule
(String parserId, String extension) Constructor with same value for parser id and source directory.protected
AbstractParserModule
(String sourceDirectory, String extension, String parserId) Deprecated.can cause confusion with constructor with multiple extensionsprotected
AbstractParserModule
(String sourceDirectory, String parserId, String... extensions) Constructor for AbstractParserModule. -
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the supported file extensions for a given module.Returns the parser id for a given module.Returns the directory that contains source files for a given module.
-
Field Details
-
sourceDirectory
The source directory. -
extensions
The supported file extensions. -
parserId
The default file extension.
-
-
Constructor Details
-
AbstractParserModule
public AbstractParserModule()Constructor with null. -
AbstractParserModule
Constructor with same value for everything: source directory and file extension equal parserId.- Parameters:
parserId
- the parser id
-
AbstractParserModule
Constructor with same value for parser id and source directory.- Parameters:
parserId
- the parser idextension
- the file extension
-
AbstractParserModule
Deprecated.can cause confusion with constructor with multiple extensionsConstructor for AbstractParserModule.
- Parameters:
sourceDirectory
- not nullextension
- not nullparserId
- not null- Since:
- 1.1.1
-
AbstractParserModule
Constructor for AbstractParserModule.
- Parameters:
sourceDirectory
- not nullparserId
- not null (usually equals sourceDirectory)extensions
- not null- Since:
- 1.7
-
-
Method Details
-
getSourceDirectory
Returns the directory that contains source files for a given module.- Specified by:
getSourceDirectory
in interfaceParserModule
- Returns:
- a
String
object.
-
getExtensions
Returns the supported file extensions for a given module.- Specified by:
getExtensions
in interfaceParserModule
- Returns:
- an array of
String
objects.
-
getParserId
Returns the parser id for a given module.- Specified by:
getParserId
in interfaceParserModule
- Returns:
- a
String
object.
-