Package org.gradle.api.artifacts

Interface Dependency

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void because​(java.lang.String reason)
      Sets the reason why this dependency should be used.
      boolean contentEquals​(Dependency dependency)
      Returns whether two dependencies have identical values for their properties.
      Dependency copy()
      Creates and returns a new dependency with the property values of this one.
      java.lang.String getGroup()
      Returns the group of this dependency.
      java.lang.String getName()
      Returns the name of this dependency.
      java.lang.String getReason()
      Returns a reason why this dependency should be used, in particular with regards to its version.
      java.lang.String getVersion()
      Returns the version of this dependency.

    • Method Detail

      • getGroup

        @Nullable
java.lang.String getGroup()
        Returns the group of this dependency. The group is often required to find the artifacts of a dependency in a repository. For example, the group name corresponds to a directory name in a Maven like repository. Might return null.

      • getName

        java.lang.String getName()
        Returns the name of this dependency. The name is almost always required to find the artifacts of a dependency in a repository. Never returns null.

      • getVersion

        @Nullable
java.lang.String getVersion()
        Returns the version of this dependency. The version is often required to find the artifacts of a dependency in a repository. For example the version name corresponds to a directory name in a Maven like repository. Might return null.

      • contentEquals

        boolean contentEquals​(Dependency dependency)
        Returns whether two dependencies have identical values for their properties. A dependency is an entity with a key. Therefore dependencies might be equal and yet have different properties.
        Parameters:
        dependency - The dependency to compare this dependency with

      • copy

        Dependency copy()
        Creates and returns a new dependency with the property values of this one.
        Returns:
        The copy. Never returns null.

      • getReason

        @Nullable
java.lang.String getReason()
        Returns a reason why this dependency should be used, in particular with regards to its version. The dependency report will use it to explain why a specific dependency was selected, or why a specific dependency version was used.
        Returns:
        a reason to use this dependency
        Since:
        4.6

      • because

        void because​(@Nullable
             java.lang.String reason)
        Sets the reason why this dependency should be used.
        Since:
        4.6