org.apache.maven.doxia.module.site
Class AbstractSiteModule

java.lang.Object
  org.apache.maven.doxia.module.site.AbstractSiteModule

All Implemented Interfaces:

SiteModule

Direct Known Subclasses:

AptSiteModule, ConfluenceSiteModule, DocBookSiteModule, FmlSiteModule, MarkdownSiteModule, TWikiSiteModule, XdocSiteModule, XhtmlSiteModule

public abstract class AbstractSiteModule
extends Object
implements SiteModule

An abstract base class that implements the SiteModule interface.

Since:

1.0

Version:

$Id: AbstractSiteModule.java 783285 2009-06-10 10:52:19Z vsiveton $

Author:

Jason van Zyl

AbstractSiteModule

public AbstractSiteModule()

Constructor with null.

AbstractSiteModule

protected AbstractSiteModule(String sourceDirectory,
                             String extension,
                             String parserId)

Parameters:

sourceDirectory - not null

extension - not null

parserId - not null

Since:

1.1.1

getSourceDirectory

public String getSourceDirectory()

Returns the directory that contains source files for a given module.

Specified by:

getSourceDirectory in interface SiteModule

Returns:

The source directory.

getExtension

public String getExtension()

Returns the default file extension for a given module.

Specified by:

getExtension in interface SiteModule

Returns:

The default file extension.

getParserId

public String getParserId()

Returns the parser id for a given module.

Specified by:

getParserId in interface SiteModule

Returns:

The parser id.