Class OverlayManager

java.lang.Object

org.apache.maven.plugins.war.overlay.OverlayManager

public class OverlayManager
extends Object

Manages the overlays.

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor	Description
OverlayManager(List<Overlay> overlays, org.apache.maven.project.MavenProject project, String[] defaultIncludes, String[] defaultExcludes, Overlay currentProjectOverlay)	Creates a manager with the specified overlays.

Method Summary

Modifier and Type	Method	Description
List<String>	getOverlayIds()	Returns the id of the resolved overlays.
List<Overlay>	getOverlays()	Returns the resolved overlays.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OverlayManager

public OverlayManager(List<Overlay> overlays,
 org.apache.maven.project.MavenProject project,
 String[] defaultIncludes,
 String[] defaultExcludes,
 Overlay currentProjectOverlay)
               throws InvalidOverlayConfigurationException

Creates a manager with the specified overlays. Note that the list is potentially updated by the manager so a new list is created based on the overlays.

Parameters:

overlays - the overlays

project - the maven project

defaultIncludes - the default includes to use

defaultExcludes - the default excludes to use

currentProjectOverlay - the overlay for the current project

Throws:

InvalidOverlayConfigurationException - if the config is invalid

Method Details

getOverlays

public List<Overlay> getOverlays()

Returns the resolved overlays.

Returns:

the overlays

getOverlayIds

public List<String> getOverlayIds()

Returns the id of the resolved overlays.

Returns:

the overlay ids