Class AbstractParserModule
- java.lang.Object
-
- org.apache.maven.doxia.parser.module.AbstractParserModule
-
- All Implemented Interfaces:
ParserModule
public abstract class AbstractParserModule extends java.lang.Object implements ParserModule
An abstract base class that implements the ParserModule interface.- Since:
- 1.6
-
-
Constructor Summary
Constructors Modifier Constructor Description AbstractParserModule()
Constructor with null.AbstractParserModule(java.lang.String parserId)
Constructor with same value for everything: source directory and file extension equal parserId.AbstractParserModule(java.lang.String parserId, java.lang.String extension)
Constructor with same value for parser id and source directory.protected
AbstractParserModule(java.lang.String sourceDirectory, java.lang.String parserId, java.lang.String... extensions)
Constructor for AbstractParserModule.
-
Method Summary
All Methods Instance Methods Concrete 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.
-
-
-
Constructor Detail
-
AbstractParserModule
public AbstractParserModule()
Constructor with null.
-
AbstractParserModule
public AbstractParserModule(java.lang.String parserId)
Constructor with same value for everything: source directory and file extension equal parserId.- Parameters:
parserId
- the parser id
-
AbstractParserModule
public AbstractParserModule(java.lang.String parserId, java.lang.String extension)
Constructor with same value for parser id and source directory.- Parameters:
parserId
- the parser idextension
- the file extension
-
AbstractParserModule
protected AbstractParserModule(java.lang.String sourceDirectory, java.lang.String parserId, java.lang.String... extensions)
Constructor for AbstractParserModule.
- Parameters:
sourceDirectory
- not nullparserId
- not null (usually equals sourceDirectory)extensions
- not null- Since:
- 1.7
-
-
Method Detail
-
getSourceDirectory
public java.lang.String getSourceDirectory()
Returns the directory that contains source files for a given module.- Specified by:
getSourceDirectory
in interfaceParserModule
- Returns:
- a
String
object.
-
getExtensions
public java.lang.String[] getExtensions()
Returns the supported file extensions for a given module.- Specified by:
getExtensions
in interfaceParserModule
- Returns:
- an array of
String
objects.
-
getParserId
public java.lang.String getParserId()
Returns the parser id for a given module.- Specified by:
getParserId
in interfaceParserModule
- Returns:
- a
String
object.
-
-