JkJavaCompilerToolChain

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JkJavaCompilerToolChain.JkJdks

Nested Classes
Modifier and Type	Class and Description
`static class`	`JkJavaCompilerToolChain.JkJdks`

Field Summary

Fields
Modifier and Type Field and Description

static java.nio.file.PathMatcher JAVA_SOURCE_MATCHER
Filter to consider only Java source

Fields
Modifier and Type	Field and Description
`static java.nio.file.PathMatcher`	`JAVA_SOURCE_MATCHER` Filter to consider only Java source

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`compile(JkJavaCompileSpec compileSpec)`
`boolean`	`compile(JkJavaVersion targetVersion, JkJavaCompileSpec compileSpec)` Actually compile the source files to the output directory.
`boolean`	`isCompilationForked(JkJavaVersion javaVersion, JkJavaCompileSpec compileSpec)` Determines if the Java compilation process is forked into an external process.
`boolean`	`isToolOrProcessSpecified()`
`static JkJavaCompilerToolChain`	`of()` Creates a `JkJavaCompilerToolChain` without specifying a `JavaCompiler` instance or an external process.
`JkJavaCompilerToolChain`	`setCompileTool(javax.tools.JavaCompiler tool, java.lang.String... params)` Sets underlying java compiler tool to use.
`JkJavaCompilerToolChain`	`setForkCompiler(boolean forkCompiler)` Configures whether the Java compilation process should be forked into an external process.
`JkJavaCompilerToolChain`	`setJavacProcess(JkProcess compileProcess)` Sets the underlying compiler with the specified process.
`JkJavaCompilerToolChain`	`setJdkHints(JkJavaCompilerToolChain.JkJdks jdks, boolean preferInProcess)` Sets the JDK hints to specify the available JDKs and whether to prefer in-process tool for compilation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JAVA_SOURCE_MATCHER
```
public static final java.nio.file.PathMatcher JAVA_SOURCE_MATCHER
```
    Filter to consider only Java source
- Method Detail
  - of
```
public static JkJavaCompilerToolChain of()
```
    Creates a JkJavaCompilerToolChain without specifying a JavaCompiler instance or an external process. When nothing is specified, this compiler will try the default JavaCompiler instance provided by the running JDK.
  - setCompileTool
```
public JkJavaCompilerToolChain setCompileTool(javax.tools.JavaCompiler tool,
                                              java.lang.String... params)
```
    Sets underlying java compiler tool to use. Since in-process compilers cannot be run in forking process mode, this method disables any previous fork options that may have been set.
  - setJavacProcess
```
public JkJavaCompilerToolChain setJavacProcess(JkProcess compileProcess)
```
    Sets the underlying compiler with the specified process. The process is typically a 'javac' command.
  - setJdkHints
```
public JkJavaCompilerToolChain setJdkHints(JkJavaCompilerToolChain.JkJdks jdks,
                                           boolean preferInProcess)
```
    Sets the JDK hints to specify the available JDKs and whether to prefer in-process tool for compilation.
    
    Parameters:
    
    jdks - A JkJavaCompilerToolChain.JkJdks instance defining the JDKs to be considered during compilation.
    
    preferInProcess - If true, the compiler tool is preferred over process-based compilation; otherwise, the process is preferred.
    
    Returns:
    
    The current instance of JkJavaCompilerToolChain with updated JDK hints.
  - setForkCompiler
```
public JkJavaCompilerToolChain setForkCompiler(boolean forkCompiler)
```
    Configures whether the Java compilation process should be forked into an external process.
    
    Parameters:
    
    forkCompiler - If true, the compilation process will be forked into an external process. If false, the compilation will occur in-process.
    
    Returns:
    
    The current instance of JkJavaCompilerToolChain with the updated fork configuration.
  - isToolOrProcessSpecified
```
public boolean isToolOrProcessSpecified()
```
  - compile
```
public boolean compile(JkJavaVersion targetVersion,
                       JkJavaCompileSpec compileSpec)
```
    Actually compile the source files to the output directory.
    This toolchain will try to find the most suitable JDK for performing compilation.
    
    Parameters:
    
    targetVersion - Can be null. Provides the version of JDK to use for javac. If null, it will try to infer JDK version from #compileSpec.
    
    compileSpec - Contains options to pass to the Java compiler. It includes sources, versions, and other options specified for the compiler.
    
    Returns:
    
    false if a compilation error occurred.
    
    Throws:
    
    java.lang.IllegalStateException - if a compilation error occurred and the 'withFailOnError' flag is true.
  - compile
```
public boolean compile(JkJavaCompileSpec compileSpec)
```
    See Also:
    
    compile(JkJavaVersion, JkJavaCompileSpec)
  - isCompilationForked
```
public boolean isCompilationForked(JkJavaVersion javaVersion,
                                   JkJavaCompileSpec compileSpec)
```
    Determines if the Java compilation process is forked into an external process.
    
    Returns:
    
    true if the compilation process is forked into an external process, false otherwise.

Class JkJavaCompilerToolChain

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAVA_SOURCE_MATCHER

Method Detail

of

setCompileTool

setJavacProcess

setJdkHints

setForkCompiler

isToolOrProcessSpecified

compile

compile

isCompilationForked