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 1090706 2011-04-09 23:15:28Z hboutemy $

Author:

Jason van Zyl

Field Summary

static String

ROLE The Plexus lookup role.

Method Summary

SiteModule	getSiteModule(String id) Returns the SiteModule that corresponds to the given id.
Collection<SiteModule>	getSiteModules() Returns a collection of SiteModules.

Field Detail

ROLE

static final String ROLE

The Plexus lookup role.

Method Detail

getSiteModules

Collection<SiteModule> getSiteModules()

Returns a collection of SiteModules.

Returns:

The SiteModules.

getSiteModule

SiteModule getSiteModule(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.