Interface DependencyDescriptor

All Superinterfaces:
ExtendableItem, InheritableItem
All Known Implementing Classes:
DefaultDependencyDescriptor, PomModuleDescriptorBuilder.PomDependencyDescriptor

public interface DependencyDescriptor extends ExtendableItem, InheritableItem
Describes a dependency from a depender to a dependee.

The main information this descriptor contains is the constraint on the dependency. There is actually two kind of dependency constraints: the default dependency constraint, which can be obtained with getDependencyRevisionId(), and corresponds to the rev attribute in Ivy files. This is the constraint as it should be honored by Ivy in default resolve mode.

Then there is the dynamic constraint, which can either be the same as the default constraint, or the original dependency constraint when an Ivy file is delivered an published to a repository. This dynamic constraint is returned by getDynamicConstraintDependencyRevisionId(), and corresponds to the revconstraint attribute in the Ivy file. In some resolve mode, this constraint can be used instead of the default dependency constraint when performing dependency resolution.

  • Method Details

    • getDependencyId

      ModuleId getDependencyId()
    • getModuleDescriptor

      default ModuleDescriptor getModuleDescriptor()
      Returns the ModuleDescriptor declaring this dependency descriptor. Returns null if this dependency descriptor is not declared in a ModuleDescriptor.
      Returns:
      the ModuleDescriptor of this dependency descriptor
    • 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()
      Returns the constraint on dependency this descriptor represents.
      Returns:
      the constraint on dependency.
    • getDynamicConstraintDependencyRevisionId

      ModuleRevisionId getDynamicConstraintDependencyRevisionId()
      Returns the dynamic constraint on dependency this descriptor represents.
      Returns:
      the dynamic constraint on dependency, or exact constraint if no dynamic constraint is specified.
    • getModuleConfigurations

      String[] getModuleConfigurations()
    • getDependencyConfigurations

      String[] getDependencyConfigurations(String moduleConfiguration, String requestedConfiguration)
    • getDependencyConfigurations

      String[] getDependencyConfigurations(String moduleConfiguration)
    • getDependencyConfigurations

      String[] getDependencyConfigurations(String[] moduleConfigurations)
    • getNamespace

      Namespace getNamespace()
    • getAllDependencyArtifacts

      DependencyArtifactDescriptor[] getAllDependencyArtifacts()
    • getDependencyArtifacts

      DependencyArtifactDescriptor[] getDependencyArtifacts(String moduleConfigurations)
    • getDependencyArtifacts

      DependencyArtifactDescriptor[] getDependencyArtifacts(String[] moduleConfigurations)
    • getAllIncludeRules

      IncludeRule[] getAllIncludeRules()
    • getIncludeRules

      IncludeRule[] getIncludeRules(String moduleConfigurations)
    • getIncludeRules

      IncludeRule[] getIncludeRules(String[] moduleConfigurations)
    • getAllExcludeRules

      ExcludeRule[] getAllExcludeRules()
    • getExcludeRules

      ExcludeRule[] getExcludeRules(String moduleConfigurations)
    • getExcludeRules

      ExcludeRule[] getExcludeRules(String[] moduleConfigurations)
    • doesExclude

      boolean doesExclude(String[] moduleConfigurations, ArtifactId artifactId)
      Returns true if
      Parameters:
      moduleConfigurations - ditto
      artifactId - ditto
      Returns:
      boolean
    • canExclude

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

    • clone

      Clones current dependency descriptor with another revision.
      Parameters:
      revision - the revision of the cloned dependency descriptor
      Returns:
      the cloned dependency descriptor
      Throws:
      IllegalArgumentException - if the given ModuleRevisionId has not the same ModuleId as the ModuleRevisionId of this descriptor.