Package lib

Interface ProjectAnalyzer

All Known Implementing Classes:
ReactiveProjectAnalyzer
public interface ProjectAnalyzer
Interface of a project analyzer. It contains methods to get async reports using Observable
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    io.reactivex.rxjava3.core.Observable<ProjectDTO>
    analyzeProject(String srcProjectFolderName)
    Async function that analyze a project given the full path of the project folder.
    io.reactivex.rxjava3.core.Observable<ClassReport>
    getClassReport(String... srcClassPath)
    Async method to retrieve the report about a variable number of class, given the full path of the class source file
    io.reactivex.rxjava3.core.Observable<InterfaceReport>
    getInterfaceReport(String... srcInterfacePath)
    Async method to retrieve the report about a variable number of interface, given the full path of the interface source file
    io.reactivex.rxjava3.core.Observable<PackageReport>
    getPackageReport(String... srcPackagePath)
    Async method to retrieve the report about a variable number of package, given the full path of the package folder
    io.reactivex.rxjava3.core.Observable<ProjectReport>
    getProjectReport(String srcProjectFolderPath)
    Async method to retrieve the report about a project given the full path of the project folder

  • Method Details

    • getInterfaceReport

      io.reactivex.rxjava3.core.Observable<InterfaceReport> getInterfaceReport(String... srcInterfacePath)
      Async method to retrieve the report about a variable number of interface, given the full path of the interface source file
      Parameters:
      srcInterfacePath - variable argument for file paths
      Returns:
      InterfaceReport observable

    • getClassReport

      io.reactivex.rxjava3.core.Observable<ClassReport> getClassReport(String... srcClassPath)
      Async method to retrieve the report about a variable number of class, given the full path of the class source file
      Parameters:
      srcClassPath - variable argument for file paths
      Returns:
      ClassReport observable

    • getPackageReport

      io.reactivex.rxjava3.core.Observable<PackageReport> getPackageReport(String... srcPackagePath)
      Async method to retrieve the report about a variable number of package, given the full path of the package folder
      Parameters:
      srcPackagePath - variable argument for folder paths
      Returns:
      PackageReport observable

    • getProjectReport

      io.reactivex.rxjava3.core.Observable<ProjectReport> getProjectReport(String srcProjectFolderPath)
      Async method to retrieve the report about a project given the full path of the project folder
      Parameters:
      srcProjectFolderPath - path to project
      Returns:
      ProjectReport observable

    • analyzeProject

      io.reactivex.rxjava3.core.Observable<ProjectDTO> analyzeProject(String srcProjectFolderName)
      Async function that analyze a project given the full path of the project folder.
      Parameters:
      srcProjectFolderName - path to project
      Returns:
      an observable