org.apache.maven.plugin.war
Class Overlay

java.lang.Object
  org.apache.maven.plugin.war.Overlay

Direct Known Subclasses:

DefaultOverlay

public class Overlay
extends Object

An overlay is a skeleton WAR added to another WAR project in order to inject a functionality, resources or any other shared component.

Note that a particular WAR dependency can be added multiple times as an overlay with different includes/excludes filter; this allows building a fine grained overwriting policy.

The current project can also be described as an overlay and can not be specified twice. An overlay with no groupId and no artifactId represents the current project.

Version:

$Id: Overlay.html 868453 2013-07-05 11:25:41Z olamy $

Author:

Stephane Nicoll

DEFAULT_INCLUDES

public static final String[] DEFAULT_INCLUDES

DEFAULT_EXCLUDES

public static final String[] DEFAULT_EXCLUDES

Overlay

public Overlay()

Overlay

public Overlay(String groupId,
               String artifactId)

isCurrentProject

public boolean isCurrentProject()

Specify whether this overlay represents the current project or not.

Returns:

true if the overlay represents the current project, false otherwise

createInstance

public static Overlay createInstance()

getId

public String getId()

setId

public void setId(String id)

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

getArtifactId

public String getArtifactId()

setArtifactId

public void setArtifactId(String artifactId)

getClassifier

public String getClassifier()

setClassifier

public void setClassifier(String classifier)

getIncludes

public String[] getIncludes()

setIncludes

public void setIncludes(String includes)

setIncludes

public void setIncludes(String[] includes)

getExcludes

public String[] getExcludes()

setExcludes

public void setExcludes(String excludes)

setExcludes

public void setExcludes(String[] excludes)

isFiltered

public boolean isFiltered()

setFiltered

public void setFiltered(boolean filtered)

shouldSkip

public boolean shouldSkip()

setSkip

public void setSkip(boolean skip)

getArtifact

public Artifact getArtifact()

setArtifact

public void setArtifact(Artifact artifact)

getTargetPath

public String getTargetPath()

setTargetPath

public void setTargetPath(String targetPath)

getType

public String getType()

setType

public void setType(String type)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object