org.apache.maven.plugin.ear

Interface EarModule

public interface EarModule

The ear module interface.

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

Author: Stephane Nicoll

Method Summary
voidappendModule(XMLWriter writer, String version)
Appends the XML representation of this module.
ArtifactgetArtifact()
Returns the {@link Artifact} representing this module.
StringgetUri()
Returns the URI for this module.
booleanisExcluded()
Specify whether this module should be excluded or not.
voidresolveArtifact(Set artifacts, String defaultJavaBundleDir)
Resolves the {@link Artifact} represented by the module with the specified execution configuration.

Method Detail

appendModule

public void appendModule(XMLWriter writer, String version)
Appends the XML representation of this module.

Parameters: writer the writer to use version the version of the application.xml file

getArtifact

public Artifact getArtifact()
Returns the {@link Artifact} representing this module.

Note that this might return null till the module has been resolved.

Returns: the artifact

See Also: EarModule

getUri

public String getUri()
Returns the URI for this module.

Returns: the URI

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)
Resolves the {@link Artifact} represented by the module with the specified execution configuration.

Parameters: artifacts the project's artifacts defaultJavaBundleDir the default bundle dir for {@link JavaModule}

Throws: EarPluginException if the artifact could not be resolved

Copyright © 2002-2007 Apache Software Foundation. All Rights Reserved.