Class AbstractParserModule
java.lang.Object
org.apache.maven.doxia.parser.module.AbstractParserModule
- All Implemented Interfaces:
ParserModule
An abstract base class that implements the ParserModule interface.
- Since:
- 1.6
-
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.protectedAbstractParserModule(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.
-
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
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:
getSourceDirectoryin interfaceParserModule- Returns:
- a
Stringobject.
-
getExtensions
Returns the supported file extensions for a given module.- Specified by:
getExtensionsin interfaceParserModule- Returns:
- an array of
Stringobjects.
-
getParserId
Returns the parser id for a given module.- Specified by:
getParserIdin interfaceParserModule- Returns:
- a
Stringobject.
-