Package net.sourceforge.pmd.lang.apex.multifile

Class ApexMultifileAnalysis

  • All Implemented Interfaces:
    
public final class ApexMultifileAnalysis

    Stores multi-file analysis data. The 'Org' here is the primary ApexLink structure for maintaining information about the Salesforce metadata. We load 'Packages' into it to perform analysis. Once constructed you can get 'Issue' information from it on what was found. The 'Org' holds mutable state for IDE use that can get quite large (a few hundred MB on very large projects). An alternative way to use this would be to cache the issues after packages are loaded and throw away the 'Org'. That would be a better model if all you wanted was the issues but more complex rules will need the ability to traverse the internal graph of the 'Org'.

    Note: This is used by net.sourceforge.pmd.lang.apex.rule.design.UnusedMethodRule.

    Author:

    Kevin Jones

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean isFailed() Returns true if this is analysis index is in a failed state.
      List<Issue> getFileIssues(String filename)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • isFailed

         boolean isFailed()

        Returns true if this is analysis index is in a failed state. This object is then useless. The failed instance is returned from getMultiFileState if loading the org failed, maybe because of malformed configuration.