Package org.gradle.api.artifacts.dsl

Klasse DependencyModifier

java.lang.Object
org.gradle.api.artifacts.dsl.DependencyModifier
Bekannte direkte Unterklassen:
PlatformDependencyModifiers.EnforcedPlatformDependencyModifier, PlatformDependencyModifiers.PlatformDependencyModifier, TestFixturesDependencyModifiers.TestFixturesDependencyModifier
@NonExtensible public abstract class DependencyModifier extends Object
A DependencyModifier defines how to modify a dependency inside a custom dependencies block to select a different variant.
Seit:
8.0
API Note:
Gradle has specific extensions to make explicit calls to modify(...) unnecessary from the DSL.
  • For Groovy DSL, we create call(...) equivalents for all the modify(...) methods.
  • For Kotlin DSL, we create invoke(...) equivalents for all the modify(...) methods.
Implementation Requirements:
The only method that should be implemented is modifyImplementation(ModuleDependency). Other abstract methods are used to inject necessary services and should not be implemented.
Implementation Note:
All implementations of modify(...) delegate to modifyImplementation(ModuleDependency).

Changes to this interface may require changes to the extension module for Groovy DSL or extension functions for Kotlin DSL.

  • Konstruktordetails

    • DependencyModifier

      protected DependencyModifier()
      Creates a new instance.
      Seit:
      8.4

  • Methodendetails

    • getDependencyFactory

      @Inject protected abstract DependencyFactory getDependencyFactory()
      A dependency factory is used to convert supported dependency notations into Dependency instances.
      Gibt zurück:
      a dependency factory
      Siehe auch:
      Implementation Requirements:
      Do not implement this method. Gradle generates the implementation automatically.

    • modify

      public final ExternalModuleDependency modify(CharSequence dependencyNotation)
      Create an ExternalModuleDependency from the given notation and modifies it to select the variant of the given module as described in modify(ModuleDependency).
      Parameter:
      dependencyNotation - the dependency notation
      Gibt zurück:
      the modified dependency
      Siehe auch:

    • modify

      @Incubating public final Provider<? extends MinimalExternalModuleDependency> modify(ProviderConvertible<? extends MinimalExternalModuleDependency> providerConvertibleToDependency)
      Takes a given Provider to a MinimalExternalModuleDependency and modifies the dependency to select the variant of the given module as described in modify(ModuleDependency).
      Parameter:
      providerConvertibleToDependency - the provider
      Gibt zurück:
      a provider to the modified dependency

    • modify

      public final <D extends ModuleDependency> Provider<D> modify(Provider<D> providerToDependency)
      Takes a given Provider to a ExternalModuleDependency and modifies the dependency to select the variant of the given module as described in modify(ModuleDependency).
      Parameter:
      providerToDependency - the provider
      Gibt zurück:
      a provider to the modified dependency

    • modify

      public final <D extends ModuleDependency> D modify(D dependency)
      Takes a given ModuleDependency and modifies the dependency to select the variant of the given module. Dependency resolution may fail if the given module does not have a compatible variant.

      The dependency will be copied, so the original dependency will not be modified.

      Typparameter:
      D - the type of the ModuleDependency
      Parameter:
      dependency - the dependency to modify
      Gibt zurück:
      the modified dependency

    • modifyImplementation

      protected abstract void modifyImplementation(ModuleDependency dependency)
      Modify the given dependency.
      Parameter:
      dependency - the dependency to modify
      Seit:
      8.4
      Implementation Requirements:
      This method must be implemented.