Package org.apache.maven.plugins.war
Class Overlay
java.lang.Object
org.apache.maven.plugins.war.Overlay
- Direct Known Subclasses:
DefaultOverlay
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.maven.artifact.Artifact
private String
private String
static final String[]
The list of default excludes.static final String[]
The list of default includes.private String[]
private boolean
private String
private String
private String[]
private boolean
private String
private String
default overlay type is war -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Overlay
boolean
org.apache.maven.artifact.Artifact
String[]
getId()
String[]
getType()
int
hashCode()
boolean
Specify whether this overlay represents the current project or not.boolean
private String[]
void
setArtifact
(org.apache.maven.artifact.Artifact artifact) void
setArtifactId
(String artifactId) void
setClassifier
(String classifier) void
setExcludes
(String excludes) void
setExcludes
(String[] excludes) void
setFiltered
(boolean filtered) void
setGroupId
(String groupId) void
void
setIncludes
(String includes) void
setIncludes
(String[] includes) void
setSkip
(boolean skip) void
setTargetPath
(String targetPath) void
boolean
toString()
-
Field Details
-
DEFAULT_INCLUDES
The list of default includes. -
DEFAULT_EXCLUDES
The list of default excludes. -
id
-
groupId
-
artifactId
-
classifier
-
includes
-
excludes
-
filtered
private boolean filtered -
skip
private boolean skip -
artifact
private org.apache.maven.artifact.Artifact artifact -
targetPath
-
type
default overlay type is war
-
-
Constructor Details
-
Overlay
public Overlay()Create instance. -
Overlay
- Parameters:
groupId
-groupId
artifactId
-artifactId
-
-
Method Details
-
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
- Returns:
Overlay
instance.
-
getId
- Returns:
- The id.
-
setId
- Parameters:
id
- The id.
-
getGroupId
- Returns:
groupId
-
setGroupId
- Parameters:
groupId
-groupId
-
getArtifactId
- Returns:
artifactId
-
setArtifactId
- Parameters:
artifactId
-artifactId
-
getClassifier
- Returns:
classifier
-
setClassifier
- Parameters:
classifier
-classifier
-
getIncludes
- Returns:
includes
-
setIncludes
- Parameters:
includes
-includes
-
setIncludes
- Parameters:
includes
-includes
-
getExcludes
- Returns:
excludes
-
setExcludes
- Parameters:
excludes
-excludes
-
setExcludes
- Parameters:
excludes
-excludes
-
isFiltered
public boolean isFiltered()- Returns:
filtered
-
setFiltered
public void setFiltered(boolean filtered) - Parameters:
filtered
-filtered
-
shouldSkip
public boolean shouldSkip()- Returns:
skip
-
setSkip
public void setSkip(boolean skip) - Parameters:
skip
-skip
-
getArtifact
public org.apache.maven.artifact.Artifact getArtifact()- Returns:
artifact
-
setArtifact
public void setArtifact(org.apache.maven.artifact.Artifact artifact) - Parameters:
artifact
-artifact
-
getTargetPath
- Returns:
targetPath
-
setTargetPath
- Parameters:
targetPath
-targetPath
-
getType
- Returns:
type
-
setType
- Parameters:
type
-type
-
toString
-
equals
-
hashCode
public int hashCode() -
parse
-