xsbti.compile

Class CompileOptions

java.lang.Object

xsbti.compile.CompileOptions

All Implemented Interfaces:

java.io.Serializable

public final class CompileOptions
extends java.lang.Object
implements java.io.Serializable

Compilation options

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompileOptions()
protected	CompileOptions(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order)
protected	CompileOptions(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory)
protected	CompileOptions(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory, java.util.Optional<FileConverter> _converter, java.util.Optional<ReadStamps> _stamper, java.util.Optional<Output> _earlyOutput)
protected	CompileOptions(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.nio.file.Path _temporaryClassesDirectory)
protected	CompileOptions(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.nio.file.Path _temporaryClassesDirectory, FileConverter _converter, ReadStamps _stamper, Output _earlyOutput)

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	classesDirectory()
VirtualFile[]	classpath() The classpath to use for compilation.
java.util.Optional<FileConverter>	converter() FileConverter to convert between Path and VirtualFileRef.
static CompileOptions	create()
static CompileOptions	create(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order)
static CompileOptions	create(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory)
static CompileOptions	create(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory, java.util.Optional<FileConverter> _converter, java.util.Optional<ReadStamps> _stamper, java.util.Optional<Output> _earlyOutput)
static CompileOptions	create(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.nio.file.Path _temporaryClassesDirectory)
static CompileOptions	create(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.nio.file.Path _temporaryClassesDirectory, FileConverter _converter, ReadStamps _stamper, Output _earlyOutput)
java.util.Optional<Output>	earlyOutput() Output for pickle JAR used for build pipelining
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String[]	javacOptions() The options to pass to the Java compiler other than the sources and classpath to use.
int	maxErrors()
static CompileOptions	of()
static CompileOptions	of(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order)
static CompileOptions	of(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory)
static CompileOptions	of(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory, java.util.Optional<FileConverter> _converter, java.util.Optional<ReadStamps> _stamper, java.util.Optional<Output> _earlyOutput)
static CompileOptions	of(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.nio.file.Path _temporaryClassesDirectory)
static CompileOptions	of(VirtualFile[] _classpath, VirtualFile[] _sources, java.nio.file.Path _classesDirectory, java.lang.String[] _scalacOptions, java.lang.String[] _javacOptions, int _maxErrors, java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper, CompileOrder _order, java.nio.file.Path _temporaryClassesDirectory, FileConverter _converter, ReadStamps _stamper, Output _earlyOutput)
CompileOrder	order() Controls the order in which Java and Scala sources are compiled.
java.lang.String[]	scalacOptions() The options to pass to the Scala compiler other than the sources and classpath to use.
java.util.function.Function<xsbti.Position,xsbti.Position>	sourcePositionMapper()
VirtualFile[]	sources() All sources that should be recompiled.
java.util.Optional<ReadStamps>	stamper() ReadStamps to calculate timestamp or hash.
java.util.Optional<java.nio.file.Path>	temporaryClassesDirectory() Points to a temporary classes directory where the compiler can put compilation products of any kind.
java.lang.String	toString()
CompileOptions	withClassesDirectory(java.nio.file.Path classesDirectory)
CompileOptions	withClasspath(VirtualFile[] classpath)
CompileOptions	withConverter(FileConverter converter)
CompileOptions	withConverter(java.util.Optional<FileConverter> converter)
CompileOptions	withEarlyOutput(java.util.Optional<Output> earlyOutput)
CompileOptions	withEarlyOutput(Output earlyOutput)
CompileOptions	withJavacOptions(java.lang.String[] javacOptions)
CompileOptions	withMaxErrors(int maxErrors)
CompileOptions	withOrder(CompileOrder order)
CompileOptions	withScalacOptions(java.lang.String[] scalacOptions)
CompileOptions	withSourcePositionMapper(java.util.function.Function<xsbti.Position,xsbti.Position> sourcePositionMapper)
CompileOptions	withSources(VirtualFile[] sources)
CompileOptions	withStamper(java.util.Optional<ReadStamps> stamper)
CompileOptions	withStamper(ReadStamps stamper)
CompileOptions	withTemporaryClassesDirectory(java.util.Optional<java.nio.file.Path> temporaryClassesDirectory)
CompileOptions	withTemporaryClassesDirectory(java.nio.file.Path temporaryClassesDirectory)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompileOptions

protected CompileOptions()

CompileOptions

protected CompileOptions(VirtualFile[] _classpath,
                         VirtualFile[] _sources,
                         java.nio.file.Path _classesDirectory,
                         java.lang.String[] _scalacOptions,
                         java.lang.String[] _javacOptions,
                         int _maxErrors,
                         java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                         CompileOrder _order)

CompileOptions

protected CompileOptions(VirtualFile[] _classpath,
                         VirtualFile[] _sources,
                         java.nio.file.Path _classesDirectory,
                         java.lang.String[] _scalacOptions,
                         java.lang.String[] _javacOptions,
                         int _maxErrors,
                         java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                         CompileOrder _order,
                         java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory)

CompileOptions

protected CompileOptions(VirtualFile[] _classpath,
                         VirtualFile[] _sources,
                         java.nio.file.Path _classesDirectory,
                         java.lang.String[] _scalacOptions,
                         java.lang.String[] _javacOptions,
                         int _maxErrors,
                         java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                         CompileOrder _order,
                         java.nio.file.Path _temporaryClassesDirectory)

CompileOptions

protected CompileOptions(VirtualFile[] _classpath,
                         VirtualFile[] _sources,
                         java.nio.file.Path _classesDirectory,
                         java.lang.String[] _scalacOptions,
                         java.lang.String[] _javacOptions,
                         int _maxErrors,
                         java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                         CompileOrder _order,
                         java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory,
                         java.util.Optional<FileConverter> _converter,
                         java.util.Optional<ReadStamps> _stamper,
                         java.util.Optional<Output> _earlyOutput)

CompileOptions

protected CompileOptions(VirtualFile[] _classpath,
                         VirtualFile[] _sources,
                         java.nio.file.Path _classesDirectory,
                         java.lang.String[] _scalacOptions,
                         java.lang.String[] _javacOptions,
                         int _maxErrors,
                         java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                         CompileOrder _order,
                         java.nio.file.Path _temporaryClassesDirectory,
                         FileConverter _converter,
                         ReadStamps _stamper,
                         Output _earlyOutput)

Method Detail

create

public static CompileOptions create()

of

public static CompileOptions of()

create

public static CompileOptions create(VirtualFile[] _classpath,
                                    VirtualFile[] _sources,
                                    java.nio.file.Path _classesDirectory,
                                    java.lang.String[] _scalacOptions,
                                    java.lang.String[] _javacOptions,
                                    int _maxErrors,
                                    java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                    CompileOrder _order)

of

public static CompileOptions of(VirtualFile[] _classpath,
                                VirtualFile[] _sources,
                                java.nio.file.Path _classesDirectory,
                                java.lang.String[] _scalacOptions,
                                java.lang.String[] _javacOptions,
                                int _maxErrors,
                                java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                CompileOrder _order)

create

public static CompileOptions create(VirtualFile[] _classpath,
                                    VirtualFile[] _sources,
                                    java.nio.file.Path _classesDirectory,
                                    java.lang.String[] _scalacOptions,
                                    java.lang.String[] _javacOptions,
                                    int _maxErrors,
                                    java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                    CompileOrder _order,
                                    java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory)

of

public static CompileOptions of(VirtualFile[] _classpath,
                                VirtualFile[] _sources,
                                java.nio.file.Path _classesDirectory,
                                java.lang.String[] _scalacOptions,
                                java.lang.String[] _javacOptions,
                                int _maxErrors,
                                java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                CompileOrder _order,
                                java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory)

create

public static CompileOptions create(VirtualFile[] _classpath,
                                    VirtualFile[] _sources,
                                    java.nio.file.Path _classesDirectory,
                                    java.lang.String[] _scalacOptions,
                                    java.lang.String[] _javacOptions,
                                    int _maxErrors,
                                    java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                    CompileOrder _order,
                                    java.nio.file.Path _temporaryClassesDirectory)

of

public static CompileOptions of(VirtualFile[] _classpath,
                                VirtualFile[] _sources,
                                java.nio.file.Path _classesDirectory,
                                java.lang.String[] _scalacOptions,
                                java.lang.String[] _javacOptions,
                                int _maxErrors,
                                java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                CompileOrder _order,
                                java.nio.file.Path _temporaryClassesDirectory)

create

public static CompileOptions create(VirtualFile[] _classpath,
                                    VirtualFile[] _sources,
                                    java.nio.file.Path _classesDirectory,
                                    java.lang.String[] _scalacOptions,
                                    java.lang.String[] _javacOptions,
                                    int _maxErrors,
                                    java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                    CompileOrder _order,
                                    java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory,
                                    java.util.Optional<FileConverter> _converter,
                                    java.util.Optional<ReadStamps> _stamper,
                                    java.util.Optional<Output> _earlyOutput)

of

public static CompileOptions of(VirtualFile[] _classpath,
                                VirtualFile[] _sources,
                                java.nio.file.Path _classesDirectory,
                                java.lang.String[] _scalacOptions,
                                java.lang.String[] _javacOptions,
                                int _maxErrors,
                                java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                CompileOrder _order,
                                java.util.Optional<java.nio.file.Path> _temporaryClassesDirectory,
                                java.util.Optional<FileConverter> _converter,
                                java.util.Optional<ReadStamps> _stamper,
                                java.util.Optional<Output> _earlyOutput)

create

public static CompileOptions create(VirtualFile[] _classpath,
                                    VirtualFile[] _sources,
                                    java.nio.file.Path _classesDirectory,
                                    java.lang.String[] _scalacOptions,
                                    java.lang.String[] _javacOptions,
                                    int _maxErrors,
                                    java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                    CompileOrder _order,
                                    java.nio.file.Path _temporaryClassesDirectory,
                                    FileConverter _converter,
                                    ReadStamps _stamper,
                                    Output _earlyOutput)

of

public static CompileOptions of(VirtualFile[] _classpath,
                                VirtualFile[] _sources,
                                java.nio.file.Path _classesDirectory,
                                java.lang.String[] _scalacOptions,
                                java.lang.String[] _javacOptions,
                                int _maxErrors,
                                java.util.function.Function<xsbti.Position,xsbti.Position> _sourcePositionMapper,
                                CompileOrder _order,
                                java.nio.file.Path _temporaryClassesDirectory,
                                FileConverter _converter,
                                ReadStamps _stamper,
                                Output _earlyOutput)

classpath

public VirtualFile[] classpath()

The classpath to use for compilation. This will be modified according to the ClasspathOptions used to configure the ScalaCompiler.

sources

public VirtualFile[] sources()

All sources that should be recompiled. This should include Scala and Java sources, which are identified by their extension.

classesDirectory

public java.nio.file.Path classesDirectory()

scalacOptions

public java.lang.String[] scalacOptions()

The options to pass to the Scala compiler other than the sources and classpath to use.

javacOptions

public java.lang.String[] javacOptions()

The options to pass to the Java compiler other than the sources and classpath to use.

maxErrors

public int maxErrors()

sourcePositionMapper

public java.util.function.Function<xsbti.Position,xsbti.Position> sourcePositionMapper()

order

public CompileOrder order()

Controls the order in which Java and Scala sources are compiled.

temporaryClassesDirectory

public java.util.Optional<java.nio.file.Path> temporaryClassesDirectory()

Points to a temporary classes directory where the compiler can put compilation products of any kind. The lifetime of these compilation products is short and the temporary classes directory only needs to exist during one incremental compiler cycle.

converter

public java.util.Optional<FileConverter> converter()

FileConverter to convert between Path and VirtualFileRef.

stamper

public java.util.Optional<ReadStamps> stamper()

ReadStamps to calculate timestamp or hash.

earlyOutput

public java.util.Optional<Output> earlyOutput()

Output for pickle JAR used for build pipelining

withClasspath

public CompileOptions withClasspath(VirtualFile[] classpath)

withSources

public CompileOptions withSources(VirtualFile[] sources)

withClassesDirectory

public CompileOptions withClassesDirectory(java.nio.file.Path classesDirectory)

withScalacOptions

public CompileOptions withScalacOptions(java.lang.String[] scalacOptions)

withJavacOptions

public CompileOptions withJavacOptions(java.lang.String[] javacOptions)

withMaxErrors

public CompileOptions withMaxErrors(int maxErrors)

withSourcePositionMapper

public CompileOptions withSourcePositionMapper(java.util.function.Function<xsbti.Position,xsbti.Position> sourcePositionMapper)

withOrder

public CompileOptions withOrder(CompileOrder order)

withTemporaryClassesDirectory

public CompileOptions withTemporaryClassesDirectory(java.util.Optional<java.nio.file.Path> temporaryClassesDirectory)

withTemporaryClassesDirectory

public CompileOptions withTemporaryClassesDirectory(java.nio.file.Path temporaryClassesDirectory)

withConverter

public CompileOptions withConverter(java.util.Optional<FileConverter> converter)

withConverter

public CompileOptions withConverter(FileConverter converter)

withStamper

public CompileOptions withStamper(java.util.Optional<ReadStamps> stamper)

withStamper

public CompileOptions withStamper(ReadStamps stamper)

withEarlyOutput

public CompileOptions withEarlyOutput(java.util.Optional<Output> earlyOutput)

withEarlyOutput

public CompileOptions withEarlyOutput(Output earlyOutput)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object