org.apache.maven.doxia.module.site.manager
Interface SiteModuleManager

All Known Implementing Classes:

DefaultSiteModuleManager

public interface SiteModuleManager

Handles SiteModule lookups.

Since:

1.0

Version:

$Id: SiteModuleManager.java 746978 2009-02-23 12:20:33Z vsiveton $

Author:

Jason van Zyl

Field Summary

static java.lang.String

ROLE The Plexus lookup role.

Method Summary

SiteModule	getSiteModule(java.lang.String id) Returns the SiteModule that corresponds to the given id.
java.util.Collection	getSiteModules() Returns a collection of SiteModules.

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus lookup role.

Method Detail

getSiteModules

java.util.Collection getSiteModules()

Returns a collection of SiteModules.

Returns:

The SiteModules.

getSiteModule

SiteModule getSiteModule(java.lang.String id)
                         throws SiteModuleNotFoundException

Returns the SiteModule that corresponds to the given id.

Parameters:

id - The identifier.

Returns:

The corresponding SiteModule.

Throws:

SiteModuleNotFoundException - if no SiteModule could be found for the given id.