nl.toolforge.karma.core.scm
Class ModuleDependency

java.lang.Object
  nl.toolforge.karma.core.scm.ModuleDependency

public final class ModuleDependency

extends java.lang.Object

Describes a dependency for a Module. This class is used by a Digester reading in a file called dependencies.xml which is located in the root for each module that need dependencies. Dependencies can be defined in three ways:

• <dependency module="<module-name>"/> defines a dependency to another module that is part of the same manifest. Those modules should be of the correct type (Java - Source Module).
• <dependency groupId="" artifactId="" version=""/> defines a dependency Maven-style. This means that the actual jar-file is found on a local disk in a Maven repository. Karma imposes a stronger definition of Maven dependencies than Maven does itself. Karma does not allow the following structure : id="" jar="".
• <dependency libmodule="" artifactId="" version=""/> defines that the <artifactId>-<version>.jar package is 'loaded' from the given lib module.

As an optional attribute package can be defined, with possible values true or false. false is the default. This defines whether or not the dependency should be packaged in the current module's package.

Version:

$Id: ModuleDependency.java,v 1.14 2004/10/19 19:57:00 hippe Exp $

Author:

D.A. Smedes

See Also:

DependencyException

Constructor Summary

ModuleDependency()

Method Summary

boolean	doPackage()
boolean	equals(java.lang.Object obj) Checks two ModuleDependency instances for equality.
java.lang.String	getArtifactId()
java.lang.String	getGroupId()
java.lang.String	getId()
java.lang.String	getJar()
java.lang.String	getJarDependency()
java.lang.String	getLibModule()
java.lang.String	getModule()
java.lang.String	getVersion()
int	hashCode() Returns the hash code for this instance.
boolean	isLibModuleDependency() true if the dependency identifies a jar in a module in the same manifest, otherwise false.
boolean	isModuleDependency() true if the dependency identifies a module in the same manifest, otherwise false.
void	setArtifactId(java.lang.String artifactId)
void	setGroupId(java.lang.String groupId)
void	setId(java.lang.String id)
void	setJar(java.lang.String jar)
void	setLibModule(java.lang.String libModule)
void	setModule(java.lang.String module)
void	setPackage(boolean b)
void	setVersion(java.lang.String version)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleDependency

public ModuleDependency()

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getGroupId

public java.lang.String getGroupId()

setGroupId

public void setGroupId(java.lang.String groupId)

getArtifactId

public java.lang.String getArtifactId()

setArtifactId

public void setArtifactId(java.lang.String artifactId)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getModule

public java.lang.String getModule()

setModule

public void setModule(java.lang.String module)

getLibModule

public java.lang.String getLibModule()

setLibModule

public void setLibModule(java.lang.String libModule)

getJar

public java.lang.String getJar()

setJar

public void setJar(java.lang.String jar)

setPackage

public void setPackage(boolean b)

doPackage

public boolean doPackage()

getJarDependency

public java.lang.String getJarDependency()

isModuleDependency

public boolean isModuleDependency()

true if the dependency identifies a module in the same manifest, otherwise false.

isLibModuleDependency

public boolean isLibModuleDependency()

true if the dependency identifies a jar in a module in the same manifest, otherwise false.

hashCode

public int hashCode()

Returns the hash code for this instance. The hash code is either module.hashCode() or artifactId.hashCode(); this follows the general structure

Returns:

equals

public boolean equals(java.lang.Object obj)

Checks two ModuleDependency instances for equality. If the dependency is a module dependency, their module names are checked for equality. Otherwise the artifactId attribute is used to determine equality.

Parameters:

obj - Another ModuleDependency.

toString

public java.lang.String toString()