xsbti.compile

Interface ClassFileManager

All Known Implementing Classes:

WrappedClassFileManager

public interface ClassFileManager

Represent the interface to manage the generated class files by the Scala or Java compilers. The class file manager is responsible for providing operations to users to allow them to have a fine-grained control over the generated class files and how they are generated/deleted. This class is meant to be used once per compilation run.

Method Summary

Modifier and Type	Method and Description
void	complete(boolean success) Informs the class file manager whether the compilation run has succeeded.
void	delete(java.io.File[] classes) Handler of classes that deletes them prior to every compilation step.
void	generated(java.io.File[] classes) Handler of classes that decides where certain class files should be stored after every compilation step.
java.io.File[]	invalidatedClassFiles() Tells the caller what class files have been invalidated and should not be used to compile the next incremental compiler run.

Method Detail

delete

void delete(java.io.File[] classes)

Handler of classes that deletes them prior to every compilation step.

Parameters:

classes - The generated class files must not exist if the method returns normally, as well as any empty ancestor directories of deleted files.

invalidatedClassFiles

java.io.File[] invalidatedClassFiles()

Tells the caller what class files have been invalidated and should not be used to compile the next incremental compiler run. This method is necessary in case the class file manager does not delete class files in the classes directory.

Returns:

classes An array of all class files that were associated to invalidated symbols.

generated

void generated(java.io.File[] classes)

Handler of classes that decides where certain class files should be stored after every compilation step. This method is called once per compilation run with the class files generated by that concrete run.

Parameters:

classes - The generated class files by the immediate compilation run.

complete

void complete(boolean success)

Informs the class file manager whether the compilation run has succeeded. If it has not succeeded, the class file manager will handle the current generated and the previous class files as per the underlying algorithm.

Parameters:

success - Whether the compilation run has succeeded or not.