OverlayManager (Apache Maven WAR Plugin 2.4 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.war.overlay
Class OverlayManager

java.lang.Object
  org.apache.maven.plugin.war.overlay.OverlayManager

public class OverlayManager
extends Object
extends Object

Manages the overlays.

Version:: $Id: OverlayManager.html 868453 2013-07-05 11:25:41Z olamy $
Author:: Stephane Nicoll

Constructor Summary
`OverlayManager(List<Overlay> overlays, MavenProject project, String defaultIncludes, String defaultExcludes, Overlay currentProjectOverlay)` Creates a manager with the specified overlays.

Method Summary
`List<String>`	`getOverlayIds()` Returns the id of the resolved overlays.
`List<Overlay>`	`getOverlays()` Returns the resolved overlays.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

OverlayManager

public OverlayManager(List<Overlay> overlays,
                      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 Detail

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