spoon.compiler

Interface SpoonCompiler

All Superinterfaces:

FactoryAccessor

All Known Implementing Classes:

JDTBasedSpoonCompiler, JDTSnippetCompiler

public interface SpoonCompiler
extends FactoryAccessor

This interface defines the Spoon Java compiler and code processor.

The Spoon model (see Factory is built from input sources given as files. Use build() to create the Spoon model. Once the model is built and stored in the factory, it can be processed by using a ProcessingManager.

Create an instance of the default implementation of the Spoon compiler by using Launcher.createCompiler(). For example:

 SpoonCompiler compiler = Spoon.createCompiler();
 Factory factory = Spoon.createFactory();
 List<SpoonFile> files = SpoonResourceHelper.files("myFile.java");
 compiler.build(factory, files);
 

See Also:

Launcher.createCompiler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInputSource(File source) Adds a file/directory to be built.
void	addInputSource(SpoonResource source) Adds a file/directory (as a CtResource) to be built.
void	addInputSources(List<SpoonResource> resources)
void	addTemplateSource(File source) Adds a file/directory to be used to build templates.
void	addTemplateSource(SpoonResource source) Adds a file/directory (as a CtResource) to be used to build templates.
void	addTemplateSources(List<SpoonResource> resources)
boolean	build() Builds the program's model with this compiler's factory and stores the result into this factory.
boolean	compile() Generates the bytecode associated to the classes stored in this compiler's factory.
boolean	compileInputSources() Generates the bytecode by compiling the input sources.
void	forceBuild(SpoonResource source) When setBuildOnlyOutdatedFiles(boolean) is true, adds a resource to the forced-to-be-built list.
void	generateProcessedSourceFiles(OutputType outputType) Generates the source code associated to the classes stored in this compiler's factory.
File	getDestinationDirectory() Gets the output directory of this compiler.
String	getEncoding() Gets the encoding used by this compiler.
Set<File>	getInputSources() Gets all the files/directories given as input sources to this builder (see addInputSource(File)).
File	getOutputDirectory() Gets the output directory of this compiler.
String[]	getSourceClasspath() Gets the classpath that is used to build/compile the input sources.
String[]	getTemplateClasspath() Gets the classpath that is used to build the template sources.
Set<File>	getTemplateSources() Gets all the files/directories given as template sources to this builder (see addTemplateSource(File)).
void	process(List<String> processorTypes) Processes the Java model with the given processors.
void	setBuildOnlyOutdatedFiles(boolean buildOnlyOutdatedFiles) Sets this compiler to optimize the model building process by ignoring files that has not be modified since the latest source code generation.
void	setDestinationDirectory(File destinationDirectory) Sets the destination directory for the class files.
void	setEncoding(String encoding) Sets the encoding to use when different from the system encoding.
void	setOutputDirectory(File outputDirectory) Sets the output directory for the source files.
void	setSourceClasspath(String... classpath) Sets the classpath that is used to build/compile the input sources.
void	setTemplateClasspath(String... classpath) Sets the classpath that is used to build the template sources.

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Method Detail

addInputSource

void addInputSource(File source)
                    throws IOException

Adds a file/directory to be built. By default, the files could be Java source files or Jar files. Directories are processed recursively.

Parameters:

source - file or directory to add

Throws:

IOException

setDestinationDirectory

void setDestinationDirectory(File destinationDirectory)
                             throws IOException

Sets the destination directory for the class files.

Parameters:

destinationDirectory - destination directory

Throws:

IOException

getDestinationDirectory

File getDestinationDirectory()

Gets the output directory of this compiler.

setOutputDirectory

void setOutputDirectory(File outputDirectory)
                        throws IOException

Sets the output directory for the source files.

Parameters:

outputDirectory - output directory

Throws:

IOException

getOutputDirectory

File getOutputDirectory()

Gets the output directory of this compiler.

addInputSource

void addInputSource(SpoonResource source)

Adds a file/directory (as a CtResource) to be built. By default, the files could be Java source files or Jar files. Directories are processed recursively.

Parameters:

source - file or directory to add

getInputSources

Set<File> getInputSources()

Gets all the files/directories given as input sources to this builder (see addInputSource(File)).

addTemplateSource

void addTemplateSource(File source)
                       throws IOException

Adds a file/directory to be used to build templates. By default, the files should be Java source files or Jar files containing the sources. Directories are processed recursively. Templates are set apart from the program to be processed for logical reasons. However, if a template was needed to be processed, it could be added as an input source.

Parameters:

source - file or directory to add

Throws:

IOException

addTemplateSource

void addTemplateSource(SpoonResource source)

Adds a file/directory (as a CtResource) to be used to build templates. By default, the files should be Java source files or Jar files containing the sources. Directories are processed recursively. Templates are set apart from the program to be processed for logical reasons. However, if a template was needed to be processed, it could be added as an input source.

Parameters:

source - file or directory to add

getTemplateSources

Set<File> getTemplateSources()

Gets all the files/directories given as template sources to this builder (see addTemplateSource(File)).

addInputSources

void addInputSources(List<SpoonResource> resources)

addTemplateSources

void addTemplateSources(List<SpoonResource> resources)

build

boolean build()
              throws Exception

Builds the program's model with this compiler's factory and stores the result into this factory. Note that this method should only be used once on a given factory.

Returns:

true if the Java was successfully compiled with the core Java compiler, false if some errors were encountered while compiling

Throws:

Exception - when a building problem occurs

See Also:

getSourceClasspath(), getTemplateClasspath()

generateProcessedSourceFiles

void generateProcessedSourceFiles(OutputType outputType)
                                  throws Exception

Generates the source code associated to the classes stored in this compiler's factory. The source code is generated in the directory given by getOutputDirectory().

Parameters:

outputType - the output method

Throws:

Exception

compile

boolean compile()

Generates the bytecode associated to the classes stored in this compiler's factory. The bytecode is generated in the directory given by getDestinationDirectory().

See Also:

getSourceClasspath()

compileInputSources

boolean compileInputSources()
                            throws Exception

Generates the bytecode by compiling the input sources. The bytecode is generated in the directory given by getDestinationDirectory().

Throws:

Exception

See Also:

getSourceClasspath()

getSourceClasspath

String[] getSourceClasspath()

Gets the classpath that is used to build/compile the input sources.

See Also:

compileInputSources(), build(), compile()

setSourceClasspath

void setSourceClasspath(String... classpath)

Sets the classpath that is used to build/compile the input sources. Each element of the array is either a jar file or a folder containing bytecode files.

getTemplateClasspath

String[] getTemplateClasspath()

Gets the classpath that is used to build the template sources. See setSourceClasspath(java.lang.String...) for the meaning of the returned string.

setTemplateClasspath

void setTemplateClasspath(String... classpath)

Sets the classpath that is used to build the template sources.

setBuildOnlyOutdatedFiles

void setBuildOnlyOutdatedFiles(boolean buildOnlyOutdatedFiles)

Sets this compiler to optimize the model building process by ignoring files that has not be modified since the latest source code generation.

forceBuild

void forceBuild(SpoonResource source)

When setBuildOnlyOutdatedFiles(boolean) is true, adds a resource to the forced-to-be-built list. All the files added here will be build even if no changes are detected on the file system. This list has no impacts if @link #setBuildOnlyOutdatedFiles(boolean)} is false.

setEncoding

void setEncoding(String encoding)

Sets the encoding to use when different from the system encoding.

getEncoding

String getEncoding()

Gets the encoding used by this compiler. Null means that it uses the system encoding.

process

void process(List<String> processorTypes)

Processes the Java model with the given processors.