org.apache.maven.model
Class Dependency

java.lang.Object
  extended byorg.apache.maven.model.Dependency
All Implemented Interfaces:
java.io.Serializable

public class Dependency
extends java.lang.Object
implements java.io.Serializable

null

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Dependency()
           
 
Method Summary
 void addExclusion(Exclusion exclusion)
          Method addExclusion
 java.lang.String getArtifactId()
          Get The unique id for an artifact produced by the project group, e.g.
 java.lang.String getClassifier()
          Get The classifier of the dependency.
 java.util.List getExclusions()
          Method getExclusions
 java.lang.String getGroupId()
          Get The project group that produced the dependency, e.g.
 java.lang.String getManagementKey()
           
 java.lang.String getModelEncoding()
           
 java.lang.String getScope()
          Get The scope of the dependency - compile, runtime, test.
 java.lang.String getSystemPath()
          Get FOR SYSTEM SCOPE ONLY.
 java.lang.String getType()
          Get The type of dependency.
 java.lang.String getVersion()
          Get The version of the dependency, e.g.
 boolean isOptional()
          Get Indicates the dependency is optional for use of this library.
 void removeExclusion(Exclusion exclusion)
          Method removeExclusion
 void setArtifactId(java.lang.String artifactId)
          Set The unique id for an artifact produced by the project group, e.g.
 void setClassifier(java.lang.String classifier)
          Set The classifier of the dependency.
 void setExclusions(java.util.List exclusions)
          Set Lists a set of artifacts that should be excluded from this dependency's artifact list when it comes to calculating transitive dependencies.
 void setGroupId(java.lang.String groupId)
          Set The project group that produced the dependency, e.g.
 void setModelEncoding(java.lang.String modelEncoding)
           
 void setOptional(boolean optional)
          Set Indicates the dependency is optional for use of this library.
 void setScope(java.lang.String scope)
          Set The scope of the dependency - compile, runtime, test.
 void setSystemPath(java.lang.String systemPath)
          Set FOR SYSTEM SCOPE ONLY.
 void setType(java.lang.String type)
          Set The type of dependency.
 void setVersion(java.lang.String version)
          Set The version of the dependency, e.g.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Dependency

public Dependency()
Method Detail

addExclusion

public void addExclusion(Exclusion exclusion)
Method addExclusion

Parameters:
exclusion -

getArtifactId

public java.lang.String getArtifactId()
Get The unique id for an artifact produced by the project group, e.g. germonimo-jms


getClassifier

public java.lang.String getClassifier()
Get The classifier of the dependency. This allows distinguishing two artifacts that belong to the same POM but were built differently, and is appended to the filename after the version.


getExclusions

public java.util.List getExclusions()
Method getExclusions


getGroupId

public java.lang.String getGroupId()
Get The project group that produced the dependency, e.g. geronimo.


getScope

public java.lang.String getScope()
Get The scope of the dependency - compile, runtime, test. Used to calculate the various classpaths used for testing, etc. and for determining which artifacts to include in a distribution of this project. For more information, see Dependency Mechanism.


getSystemPath

public java.lang.String getSystemPath()
Get FOR SYSTEM SCOPE ONLY. This specifies the path on the filesystem for this dependency.


getType

public java.lang.String getType()
Get The type of dependency. This defaults to jar. Known recognised dependency types are:


getVersion

public java.lang.String getVersion()
Get The version of the dependency, e.g. 3.2.1


isOptional

public boolean isOptional()
Get Indicates the dependency is optional for use of this library. While the version of the dependency will be taken into account for dependency calculation if the library is used elsewhere, it will not be passed on transitively.


removeExclusion

public void removeExclusion(Exclusion exclusion)
Method removeExclusion

Parameters:
exclusion -

setArtifactId

public void setArtifactId(java.lang.String artifactId)
Set The unique id for an artifact produced by the project group, e.g. germonimo-jms

Parameters:
artifactId -

setClassifier

public void setClassifier(java.lang.String classifier)
Set The classifier of the dependency. This allows distinguishing two artifacts that belong to the same POM but were built differently, and is appended to the filename after the version.

Parameters:
classifier -

setExclusions

public void setExclusions(java.util.List exclusions)
Set Lists a set of artifacts that should be excluded from this dependency's artifact list when it comes to calculating transitive dependencies.

Parameters:
exclusions -

setGroupId

public void setGroupId(java.lang.String groupId)
Set The project group that produced the dependency, e.g. geronimo.

Parameters:
groupId -

setOptional

public void setOptional(boolean optional)
Set Indicates the dependency is optional for use of this library. While the version of the dependency will be taken into account for dependency calculation if the library is used elsewhere, it will not be passed on transitively.

Parameters:
optional -

setScope

public void setScope(java.lang.String scope)
Set The scope of the dependency - compile, runtime, test. Used to calculate the various classpaths used for testing, etc. and for determining which artifacts to include in a distribution of this project. For more information, see Dependency Mechanism.

Parameters:
scope -

setSystemPath

public void setSystemPath(java.lang.String systemPath)
Set FOR SYSTEM SCOPE ONLY. This specifies the path on the filesystem for this dependency.

Parameters:
systemPath -

setType

public void setType(java.lang.String type)
Set The type of dependency. This defaults to jar. Known recognised dependency types are:

Parameters:
type -

setVersion

public void setVersion(java.lang.String version)
Set The version of the dependency, e.g. 3.2.1

Parameters:
version -

toString

public java.lang.String toString()

getManagementKey

public java.lang.String getManagementKey()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


Copyright 2006 Apache Software Foundation. All Rights Reserved.