Module io.github.ascopes.jct
Package io.github.ascopes.jct.compilers

Interface JctCompilation

@API(since="0.0.1", status=STABLE) public interface JctCompilation
Interface representing the result of a compilation.
Since:
0.0.1
Author:
Ashley Scopes

  • Method Details

    • getArguments

      @API(since="0.5.0", status=STABLE) default List<String> getArguments()
      Get the command line arguments that were passed to the compiler.

      Note that this throws an unsupported operation exception by default to prevent breaking existing functionality. In v1.0.0, this will become required behaviour.

      Returns:
      the command line arguments.
      Since:
      0.5.0

    • isFailOnWarnings

      boolean isFailOnWarnings()
      Determine if warnings were treated as errors.
      Returns:
      true if warnings were treated as errors, or false otherwise.

    • isSuccessful

      boolean isSuccessful()
      Determine if the compilation was successful or not.
      Returns:
      true if successful, or false if not successful.

    • isFailure

      default boolean isFailure()
      Determine if the compilation was a failure or not.
      Returns:
      true if not successful, or false if successful.

    • getOutputLines

      List<String> getOutputLines()
      Get the lines of output produced by the compiler, if any were captured.

      This is separate to diagnostics.

      Returns:
      the lines of output.

    • getCompilationUnits

      Set<JavaFileObject> getCompilationUnits()
      Get the compilation units used in the compilation.
      Returns:
      the compilation units.

    • getDiagnostics

      List<TraceDiagnostic<JavaFileObject>> getDiagnostics()
      Get the diagnostics that were reported by the compilation.
      Returns:
      the diagnostics

    • getFileManager

      JctFileManager getFileManager()
      Get the file manager that was used to store and manage files.
      Returns:
      the file manager.

    • getClassOutputs

      default OutputContainerGroup getClassOutputs()
      Get the output container group for class outputs.
      Returns:
      the output container group, or null if it does not exist.

    • getSourceOutputs

      default OutputContainerGroup getSourceOutputs()
      Get the output container group for source outputs.
      Returns:
      the output container group, or null if it does not exist.

    • getClassPath

      default PackageContainerGroup getClassPath()
      Get the package container group for the class path.
      Returns:
      the package container group, or null if it does not exist.

    • getSourcePath

      default PackageContainerGroup getSourcePath()
      Get the package container group for the source path.
      Returns:
      the package container group, or null if it does not exist.

    • getAnnotationProcessorPath

      default PackageContainerGroup getAnnotationProcessorPath()
      Get the package container group for the annotation processor path.
      Returns:
      the package container group, or null if it does not exist.

    • getAnnotationProcessorModulePath

      default ModuleContainerGroup getAnnotationProcessorModulePath()
      Get the module container group for the annotation processor module path.
      Returns:
      the module container group, or null if it does not exist.

    • getPlatformClassPath

      default PackageContainerGroup getPlatformClassPath()
      Get the package container group for the platform class path (a.k.a. the bootstrap class path).
      Returns:
      the package container group, or null if it does not exist.

    • getNativeHeaderOutputs

      default OutputContainerGroup getNativeHeaderOutputs()
      Get the output container group for the native header file outputs.
      Returns:
      the output container group, or null if it does not exist.

    • getModuleSourcePath

      default ModuleContainerGroup getModuleSourcePath()
      Get the module container group for the module source path.
      Returns:
      the module container group, or null if it does not exist.

    • getUpgradeModulePath

      default ModuleContainerGroup getUpgradeModulePath()
      Get the module container group for the upgrade module path.
      Returns:
      the module container group, or null if it does not exist.

    • getSystemModules

      default ModuleContainerGroup getSystemModules()
      Get the module container group for all system modules that are part of the JDK distribution.
      Returns:
      the module container group, or null if it does not exist.

    • getModulePath

      default ModuleContainerGroup getModulePath()
      Get the module container group for the module path.
      Returns:
      the module container group, or null if it does not exist.

    • getPatchModulePath

      default ModuleContainerGroup getPatchModulePath()
      Get the module container group for the patch module path.
      Returns:
      the module container group, or null if it does not exist.