Package org.sonarsource.scanner.lib

Interface ScannerEngineBootstrapResult

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
FailedBootstrap, SuccessfulBootstrap
public interface ScannerEngineBootstrapResult extends AutoCloseable
Closing this will automatically close the ScannerEngineFacade that it contains, if any.

  • Method Summary

    Modifier and Type
    Method
    Description
    ScannerEngineFacade
    getEngineFacade()
    Get the facade to interact with the engine.
    boolean
    isSuccessful()
    Allow to test if the bootstrapping has been successful.

    Methods inherited from interface java.lang.AutoCloseable

    close

  • Method Details

    • isSuccessful

      boolean isSuccessful()
      Allow to test if the bootstrapping has been successful. If not, the ScannerEngineFacade should not be used. A log message should have been emitted in case of failure.
      Returns:
      true if the bootstrapping has been successful, false otherwise

    • getEngineFacade

      ScannerEngineFacade getEngineFacade()
      Get the facade to interact with the engine. Only call this method if isSuccessful() returns true.
      Returns:
      the facade to interact with the engine