xsbti.compile

Interface CompileProgress

public interface CompileProgress

An API for reporting when files are being compiled. This design is tied to the Scala compiler but it is used by the Java compiler too, check the docs of the methods.

Method Summary

Modifier and Type	Method and Description
default boolean	advance(int current, int total, java.lang.String prevPhase, java.lang.String nextPhase) Advance the progress of the current unit.
default void	afterEarlyOutput(boolean success) Called when early output is created mid-compilation, or was ready to be created but needed to bail out because macros were found.
default void	startUnit(java.lang.String phase, java.lang.String unitPath) Start the progress of a concrete phase for the path of a given compilation unit.

Method Detail

startUnit

default void startUnit(java.lang.String phase,
                       java.lang.String unitPath)

Start the progress of a concrete phase for the path of a given compilation unit.

Parameters:

phase - The phase of the compiler being run.

unitPath - The path of the compilation unit. It will be empty when a Java compiler is reporting the progress.

advance

default boolean advance(int current,
                        int total,
                        java.lang.String prevPhase,
                        java.lang.String nextPhase)

Advance the progress of the current unit.

Parameters:

current - The current progress.

total - The total of the progress that has to be achieved.

prevPhase - The name of the previous phase.

nextPhase - The name of the next phase.

Returns:

Whether the user has cancelled compilation or not.

afterEarlyOutput

default void afterEarlyOutput(boolean success)

Called when early output is created mid-compilation, or was ready to be created but needed to bail out because macros were found.

Parameters:

success - True if output is written; false otherwise.