org.apache.maven.plugin.ear

Class AbstractEarModule

public abstract class AbstractEarModule extends Object implements EarModule

A base implementation of an EarModule.

Version: $Id: AbstractEarModule.java 332974 2005-11-13 12:42:44Z snicoll $

Author: Stephane Nicoll

Field Summary
protected StringbundleDir
protected StringbundleFileName
protected Booleanexcluded
protected static StringMODULE_ELEMENT
Constructor Summary
AbstractEarModule()
Empty constructor to be used when the module is built based on the configuration.
AbstractEarModule(Artifact a)
Creates an ear module from the artifact.
Method Summary
ArtifactgetArtifact()
StringgetArtifactId()
Returns the artifact's Id.
StringgetBundleDir()
Returns the bundle directory.
StringgetBundleFileName()
Returns the bundle file name.
StringgetGroupId()
Returns the artifact's groupId.
protected abstract StringgetType()
Returns the type associated to the module.
StringgetUri()
booleanisExcluded()
Specify whether this module should be excluded or not.
voidresolveArtifact(Set artifacts, String defaultJavaBundleDir)
StringtoString()

Field Detail

bundleDir

protected String bundleDir

bundleFileName

protected String bundleFileName

excluded

protected Boolean excluded

MODULE_ELEMENT

protected static final String MODULE_ELEMENT

Constructor Detail

AbstractEarModule

public AbstractEarModule()
Empty constructor to be used when the module is built based on the configuration.

AbstractEarModule

public AbstractEarModule(Artifact a)
Creates an ear module from the artifact.

Parameters: a the artifact

Method Detail

getArtifact

public Artifact getArtifact()

getArtifactId

public String getArtifactId()
Returns the artifact's Id.

Returns: the artifact Id

getBundleDir

public String getBundleDir()
Returns the bundle directory. If null, the module is bundled in the root of the EAR.

Returns: the custom bundle directory

getBundleFileName

public String getBundleFileName()
Returns the bundle file name. If null, the artifact's file name is returned.

Returns: the bundle file name

getGroupId

public String getGroupId()
Returns the artifact's groupId.

Returns: the group Id

getType

protected abstract String getType()
Returns the type associated to the module.

Returns: the artifact's type of the module

getUri

public String getUri()

isExcluded

public boolean isExcluded()
Specify whether this module should be excluded or not.

Returns: true if this module should be skipped, false otherwise

resolveArtifact

public void resolveArtifact(Set artifacts, String defaultJavaBundleDir)

toString

public String toString()
Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.