org.apache.ivy.core.module.descriptor
Interface DependencyDescriptor

All Superinterfaces:
ExtendableItem
All Known Implementing Classes:
DefaultDependencyDescriptor

public interface DependencyDescriptor
extends ExtendableItem

Author:
x.hanin

Method Summary
 DependencyDescriptor asSystem()
           
 boolean canExclude()
          Returns true if this descriptor contains any exclusion rule
 boolean doesExclude(java.lang.String[] moduleConfigurations, ArtifactId artifactId)
          Returns true if
 DependencyArtifactDescriptor[] getAllDependencyArtifacts()
           
 ExcludeRule[] getAllExcludeRules()
           
 IncludeRule[] getAllIncludeRules()
           
 DependencyArtifactDescriptor[] getDependencyArtifacts(java.lang.String moduleConfigurations)
           
 DependencyArtifactDescriptor[] getDependencyArtifacts(java.lang.String[] moduleConfigurations)
           
 java.lang.String[] getDependencyConfigurations(java.lang.String moduleConfiguration)
           
 java.lang.String[] getDependencyConfigurations(java.lang.String[] moduleConfigurations)
           
 java.lang.String[] getDependencyConfigurations(java.lang.String moduleConfiguration, java.lang.String requestedConfiguration)
           
 ModuleId getDependencyId()
           
 ModuleRevisionId getDependencyRevisionId()
           
 ExcludeRule[] getExcludeRules(java.lang.String moduleConfigurations)
           
 ExcludeRule[] getExcludeRules(java.lang.String[] moduleConfigurations)
           
 IncludeRule[] getIncludeRules(java.lang.String moduleConfigurations)
           
 IncludeRule[] getIncludeRules(java.lang.String[] moduleConfigurations)
           
 java.lang.String[] getModuleConfigurations()
           
 Namespace getNamespace()
           
 ModuleRevisionId getParentRevisionId()
           
 boolean isChanging()
          Used to indicate that this dependency is a changing one.
 boolean isForce()
          Used to indicate that this revision must be used in case of conflicts, independently of conflicts manager.
 boolean isTransitive()
           
 
Methods inherited from interface org.apache.ivy.util.extendable.ExtendableItem
getAttribute, getAttributes, getExtraAttribute, getExtraAttributes, getStandardAttribute, getStandardAttributes
 

Method Detail

getDependencyId

ModuleId getDependencyId()

isForce

boolean isForce()
Used to indicate that this revision must be used in case of conflicts, independently of conflicts manager. This only works for direct dependencies, and not transitive ones.

Returns:
true if this dependency should be used, false if conflicts manager can do its work.

isChanging

boolean isChanging()
Used to indicate that this dependency is a changing one. A changing dependency in ivy means that the revision may have its artifacts modified without revision change. When new artifacts are published a new ivy file should also be published with a new publication date to indicate to ivy that artifacts have changed and that they should be downloaded again.

Returns:
true if this dependency is a changing one

isTransitive

boolean isTransitive()

getParentRevisionId

ModuleRevisionId getParentRevisionId()

getDependencyRevisionId

ModuleRevisionId getDependencyRevisionId()

getModuleConfigurations

java.lang.String[] getModuleConfigurations()

getDependencyConfigurations

java.lang.String[] getDependencyConfigurations(java.lang.String moduleConfiguration,
                                               java.lang.String requestedConfiguration)

getDependencyConfigurations

java.lang.String[] getDependencyConfigurations(java.lang.String moduleConfiguration)

getDependencyConfigurations

java.lang.String[] getDependencyConfigurations(java.lang.String[] moduleConfigurations)

getNamespace

Namespace getNamespace()

getAllDependencyArtifacts

DependencyArtifactDescriptor[] getAllDependencyArtifacts()

getDependencyArtifacts

DependencyArtifactDescriptor[] getDependencyArtifacts(java.lang.String moduleConfigurations)

getDependencyArtifacts

DependencyArtifactDescriptor[] getDependencyArtifacts(java.lang.String[] moduleConfigurations)

getAllIncludeRules

IncludeRule[] getAllIncludeRules()

getIncludeRules

IncludeRule[] getIncludeRules(java.lang.String moduleConfigurations)

getIncludeRules

IncludeRule[] getIncludeRules(java.lang.String[] moduleConfigurations)

getAllExcludeRules

ExcludeRule[] getAllExcludeRules()

getExcludeRules

ExcludeRule[] getExcludeRules(java.lang.String moduleConfigurations)

getExcludeRules

ExcludeRule[] getExcludeRules(java.lang.String[] moduleConfigurations)

doesExclude

boolean doesExclude(java.lang.String[] moduleConfigurations,
                    ArtifactId artifactId)
Returns true if

Parameters:
moduleConfigurations -
artifactId -
Returns:

canExclude

boolean canExclude()
Returns true if this descriptor contains any exclusion rule

Returns:
true if this descriptor contains any exclusion rule

asSystem

DependencyDescriptor asSystem()