Package pl.gdela.socomo.codemap

Class Codemap

java.lang.Object
pl.gdela.socomo.codemap.Codemap
public class Codemap
extends java.lang.Object
Map of the java code: what we have in it and what is dependant on what. Java code consists of methods, fields and classes, which are grouped into packages, we represent this organization as CodeMember objects that belong to CodePackage objects.

Note that here we follow java approach, that there's no such concept as subpackages. What by name seems like a subpackage is considered a completely separate entity, and classes in subpackage belong only to it, they do not belong transitively to the parent package. Although later, when we will transform codemap to level composition data, we will do exactly that, i.e. flatten subpackages from the same parent into one component.

  • Constructor Summary

    Constructors
    Constructor Description
    Codemap()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String formatted()
    Returns a human-friendly, textual multiline representation of the codemap.
    java.util.Collection<PackageDep> packageDeps()  
    java.util.Collection<CodePackage> packages()  
    Codemap select​(Selector selector)
    Returns a new codemap that contains only code elements selected by given selector.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Codemap

      public Codemap()

  • Method Details

    • packages

      public java.util.Collection<CodePackage> packages()

    • packageDeps

      public java.util.Collection<PackageDep> packageDeps()

    • select

      public Codemap select​(Selector selector)
      Returns a new codemap that contains only code elements selected by given selector.

    • formatted

      public java.lang.String formatted()
      Returns a human-friendly, textual multiline representation of the codemap.