Package org.apache.ivy.core.report

Class ResolveReport

java.lang.Object
org.apache.ivy.core.report.ResolveReport
public class ResolveReport extends Object
Represents a whole resolution report for a module

  • Field Details

    • md

      private ModuleDescriptor md

    • confReports

      private Map<String,ConfigurationResolveReport> confReports

    • problemMessages

      private List<String> problemMessages

    • dependencies

      private List<IvyNode> dependencies
      the list of all dependencies resolved, ordered from the more dependent to the less dependent

    • artifacts

      private List<Artifact> artifacts

    • resolveTime

      private long resolveTime

    • downloadTime

      private long downloadTime

    • resolveId

      private String resolveId

    • downloadSize

      private long downloadSize

  • Constructor Details

  • Method Details

    • addReport

      public void addReport(String conf, ConfigurationResolveReport report)

    • getConfigurationReport

      public ConfigurationResolveReport getConfigurationReport(String conf)

    • getConfigurations

      public String[] getConfigurations()

    • hasError

      public boolean hasError()

    • output

      public void output(ReportOutputter[] outputters, ResolutionCacheManager cacheMgr, ResolveOptions options) throws IOException
      Throws:
      IOException

    • getModuleDescriptor

      public ModuleDescriptor getModuleDescriptor()

    • getEvictedNodes

      public IvyNode[] getEvictedNodes()

    • getUnresolvedDependencies

      public IvyNode[] getUnresolvedDependencies()

    • getFailedArtifactsReports

      public ArtifactDownloadReport[] getFailedArtifactsReports()
      Get every report on the download requests.
      Returns:
      the list of reports, never null

    • getAllArtifactsReports

      public ArtifactDownloadReport[] getAllArtifactsReports()
      Get every report on the download requests.
      Returns:
      the list of reports, never null

    • getArtifactsReports

      public ArtifactDownloadReport[] getArtifactsReports(DownloadStatus downloadStatus, boolean withEvicted)
      Get the report on the download requests. The list of download report can be restricted to a specific download status, and also remove the download report for the evicted modules.
      Parameters:
      downloadStatus - the status of download to retrieve. Set it to null for no restriction on the download status
      withEvicted - set it to true if the report for the evicted modules have to be retrieved, false to exclude reports from modules evicted in all configurations.
      Returns:
      the list of reports, never null
      See Also:

    • getArtifactsReports

      public ArtifactDownloadReport[] getArtifactsReports(ModuleRevisionId mrid)

    • checkIfChanged

      public void checkIfChanged()

    • hasChanged

      public boolean hasChanged()
      Can only be called if checkIfChanged has been called
      Returns:
      boolean

    • setProblemMessages

      public void setProblemMessages(List<String> problems)

    • getProblemMessages

      public List<String> getProblemMessages()

    • getAllProblemMessages

      public List<String> getAllProblemMessages()

    • setDependencies

      public void setDependencies(List<IvyNode> dependencies, Filter<Artifact> artifactFilter)

    • getDependencies

      public List<IvyNode> getDependencies()
      Returns the list of all dependencies concerned by this report as a List of IvyNode ordered from the more dependent to the least one
      Returns:
      The list of all dependencies.

    • getArtifacts

      public List<Artifact> getArtifacts()
      Returns the list of all artifacts which should be downloaded per this resolve To know if the artifact have actually been downloaded use information found in ConfigurationResolveReport.
      Returns:
      The list of all artifacts.

    • getModuleIds

      public List<ModuleId> getModuleIds()
      gives all the modules ids concerned by this report, from the most dependent to the least one
      Returns:
      a list of ModuleId

    • setResolveTime

      public void setResolveTime(long elapsedTime)

    • getResolveTime

      public long getResolveTime()

    • setDownloadTime

      public void setDownloadTime(long elapsedTime)

    • getDownloadTime

      public long getDownloadTime()

    • setDownloadSize

      public void setDownloadSize(long size)

    • getDownloadSize

      public long getDownloadSize()
      The total size of downloaded artifacts, in bytes.

      This only includes artifacts actually downloaded to cache (DownloadStatus.SUCCESSFUL), and not artifacts already in cache or used at their original location.

      Returns:
      The total size of downloaded artifacts, in bytes.

    • getResolveId

      public String getResolveId()

    • getExtendingConfs

      private Set<String> getExtendingConfs(String extended)
      Get every configuration which extends the specified one. The returned list also includes the specified one.
      Parameters:
      extended - String
      Returns:
      Set of String

    • gatherExtendingConfs

      private boolean gatherExtendingConfs(Set<String> extendingConfs, String conf, String extended)

    • toFixedModuleDescriptor

      public ModuleDescriptor toFixedModuleDescriptor(IvySettings settings, List<ModuleId> midToKeep)