ResolutionResult (Gradle API 9.5.0)
Description: declaration: package: org.gradle.api.artifacts.result, interface: ResolutionResult

Package org.gradle.api.artifacts.result

# Interface ResolutionResult

public interface ResolutionResult
Contains the information about the result of dependency resolution. You can use this type to determine all the component instances that are included in the resolved dependency graph, and the dependencies between them.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `allComponents(Closure closure)`
  Applies given closure for each component.
  `void`
  `allComponents(Action<? super ResolvedComponentResult> action)`
  Applies given action for each component.
  `void`
  `allDependencies(Closure closure)`
  Applies given closure for each dependency.
  `void`
  `allDependencies(Action<? super DependencyResult> action)`
  Applies given action for each dependency.
  `Set<ResolvedComponentResult>`
  `getAllComponents()`
  Retrieves all instances of `ResolvedComponentResult` from the graph, e.g.
  `Set<? extends DependencyResult>`
  `getAllDependencies()`
  Retrieves all dependencies, including unresolved dependencies.
  `AttributeContainer`
  `getRequestedAttributes()`
  The attributes that were requested.
  `ResolvedComponentResult`
  `getRoot()`
  Gives access to the root of resolved dependency graph.
  `Provider<ResolvedComponentResult>`
  `getRootComponent()`
  Returns the root of resolved dependency graph as a `Provider` of `ResolvedComponentResult`.
  `Provider<ResolvedVariantResult>`
  `getRootVariant()`
  The root variant of the dependency graph.

- ## Method Details

  - ### getRoot

    ResolvedComponentResult getRoot()
    Gives access to the root of resolved dependency graph. You can walk the graph recursively from the root to obtain information about resolved dependencies. For example, Gradle's built-in 'dependencies' task uses this to render the dependency tree.
    Returns:
      the root node of the resolved dependency graph

  - ### getRootComponent

    Provider<ResolvedComponentResult> getRootComponent()
    Returns the root of resolved dependency graph as a `Provider` of `ResolvedComponentResult`. The returned `Provider` is live, and tracks the producer tasks of this resolution result. The provider will resolve the component metadata as required. You can walk the graph recursively from the root to obtain information about resolved dependencies. For example, Gradle's built-in 'dependencies' task uses this to render the dependency tree.
    Returns:
      a provider for the root component of the resolved dependency graph
    Since:
      7.4

  - ### getRootVariant

    @Incubating Provider<ResolvedVariantResult> getRootVariant()
    The root variant of the dependency graph. This is a synthetic variant that represents the thing being resolved. All outgoing dependencies of this variant represent first-level declared dependencies of the resolution.
    Returns:
      a provider for the root variant of the dependency graph.
    Since:
      8.11

  - ### getAllDependencies

    Set<? extends DependencyResult> getAllDependencies()
    Retrieves all dependencies, including unresolved dependencies. Resolved dependencies are represented by instances of `ResolvedDependencyResult`, unresolved dependencies by `UnresolvedDependencyResult`. In dependency graph terminology, this method returns the edges of the graph.
    Returns:
      all dependencies, including unresolved dependencies.

  - ### allDependencies

    void allDependencies(Action<? super DependencyResult> action)
    Applies given action for each dependency. An instance of `DependencyResult` is passed as parameter to the action.
    Parameters:
      `action` - - action that is applied for each dependency

  - ### allDependencies

    void allDependencies(@DelegatesTo(DependencyResult.class) Closure closure)
    Applies given closure for each dependency. An instance of `DependencyResult` is passed as parameter to the closure.
    Parameters:
      `closure` - - closure that is applied for each dependency

  - ### getAllComponents

    Set<ResolvedComponentResult> getAllComponents()
    Retrieves all instances of `ResolvedComponentResult` from the graph, e.g. all nodes of the dependency graph.
    Returns:
      all nodes of the dependency graph.

  - ### allComponents

    void allComponents(Action<? super ResolvedComponentResult> action)
    Applies given action for each component. An instance of `ResolvedComponentResult` is passed as parameter to the action.
    Parameters:
      `action` - - action that is applied for each component

  - ### allComponents

    void allComponents(@DelegatesTo(ResolvedComponentResult.class) Closure closure)
    Applies given closure for each component. An instance of `ResolvedComponentResult` is passed as parameter to the closure.
    Parameters:
      `closure` - - closure that is applied for each component

  - ### getRequestedAttributes

    AttributeContainer getRequestedAttributes()
    The attributes that were requested. Those are the attributes which are used during variant aware resolution, to select the variants. Attributes returned by this method are desugared, meaning that they have lost their rich types and can only be of type Boolean or String.
    Since:
      5.6