spoon.support

Class JavaOutputProcessor

java.lang.Object

spoon.processing.AbstractProcessor<CtNamedElement>

spoon.support.JavaOutputProcessor

All Implemented Interfaces:

FactoryAccessor, FileGenerator<CtNamedElement>, Processor<CtNamedElement>

public class JavaOutputProcessor
extends AbstractProcessor<CtNamedElement>
implements FileGenerator<CtNamedElement>

A processor that generates compilable Java source files from the meta-model.

Constructor Summary

Constructors

Constructor and Description
JavaOutputProcessor() usedful for testing
JavaOutputProcessor(File outputDirectory, PrettyPrinter printer) Deprecated. The outputDirectory should be get from the environment given to the pretty printer (see Environment.setSourceOutputDirectory(File). You should use the constructor with only one parameter.
JavaOutputProcessor(PrettyPrinter printer)

Method Summary

Modifier and Type	Method and Description
void	createJavaFile(CtType<?> element) Creates the Java file associated to the given element.
List<File>	getCreatedFiles() Gets the created files.
Environment	getEnvironment() Gets the environment of this processor.
Map<String,Map<Integer,Integer>>	getLineNumberMappings()
File	getOutputDirectory() Gets the root directory where files are created.
PrettyPrinter	getPrinter()
TraversalStrategy	getTraversalStrategy() Gets the model's traversal strategy for this processor (default is TraversalStrategy.POST_ORDER).
void	init() This method is upcalled to initialize the processor before each processing round.
boolean	isToBeProcessed(CtNamedElement candidate) Tells if this element is to be processed (returns true in the default implementation).
void	process(CtNamedElement nameElement) Creates a source file for each processed top-level type and pretty prints its contents.
void	setOutputDirectory(File directory) Sets the root directory where files should be created.

Methods inherited from class spoon.processing.AbstractProcessor

addProcessedElementType, clearProcessedElementType, getFactory, getProcessedElementTypes, initProperties, interrupt, loadProperties, process, processingDone, removeProcessedElementType, setFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface spoon.processing.Processor

getProcessedElementTypes, initProperties, interrupt, process, processingDone

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Constructor Detail

JavaOutputProcessor

public JavaOutputProcessor(PrettyPrinter printer)

Parameters:

printer - the PrettyPrinter to use for written the files

JavaOutputProcessor

@Deprecated
public JavaOutputProcessor(File outputDirectory,
                                       PrettyPrinter printer)

Deprecated. The outputDirectory should be get from the environment given to the pretty printer (see Environment.setSourceOutputDirectory(File). You should use the constructor with only one parameter.

Creates a new processor for generating Java source files.

Parameters:

outputDirectory - the root output directory

printer - the PrettyPrinter to use for written the files

JavaOutputProcessor

public JavaOutputProcessor()

usedful for testing

Method Detail

getEnvironment

public Environment getEnvironment()

Description copied from interface: Processor

Gets the environment of this processor.

Specified by:

getEnvironment in interface Processor<CtNamedElement>

Overrides:

getEnvironment in class AbstractProcessor<CtNamedElement>

getPrinter

public PrettyPrinter getPrinter()

getCreatedFiles

public List<File> getCreatedFiles()

Description copied from interface: FileGenerator

Gets the created files.

Specified by:

getCreatedFiles in interface FileGenerator<CtNamedElement>

getOutputDirectory

public File getOutputDirectory()

Description copied from interface: FileGenerator

Gets the root directory where files are created.

Specified by:

getOutputDirectory in interface FileGenerator<CtNamedElement>

init

public void init()

Description copied from interface: Processor

This method is upcalled to initialize the processor before each processing round. It is convenient to override this method rather than using a default constructor to initialize the processor, since the factory is not initialized at construction time. When overriding, do not forget to call super.init() first so that all the initializations performed by superclasses are also applied.

Specified by:

init in interface Processor<CtNamedElement>

Overrides:

init in class AbstractProcessor<CtNamedElement>

createJavaFile

public void createJavaFile(CtType<?> element)

Creates the Java file associated to the given element. Splits top-level classes in different files (even if they are in the same file in the original sources).

isToBeProcessed

public boolean isToBeProcessed(CtNamedElement candidate)

Description copied from interface: Processor

Tells if this element is to be processed (returns true in the default implementation).

Specified by:

isToBeProcessed in interface Processor<CtNamedElement>

Overrides:

isToBeProcessed in class AbstractProcessor<CtNamedElement>

Parameters:

candidate - the candidate

Returns:

true if the candidate is to be processed by the Processor.process(CtElement)

process

public void process(CtNamedElement nameElement)

Creates a source file for each processed top-level type and pretty prints its contents.

Specified by:

process in interface Processor<CtNamedElement>

Parameters:

nameElement - the element that is currently being scanned

setOutputDirectory

public void setOutputDirectory(File directory)

Description copied from interface: FileGenerator

Sets the root directory where files should be created.

Specified by:

setOutputDirectory in interface FileGenerator<CtNamedElement>

getLineNumberMappings

public Map<String,Map<Integer,Integer>> getLineNumberMappings()

getTraversalStrategy

public TraversalStrategy getTraversalStrategy()

Description copied from interface: Processor

Gets the model's traversal strategy for this processor (default is TraversalStrategy.POST_ORDER). Programmers should override this method to return another strategy if needed.

Specified by:

getTraversalStrategy in interface Processor<CtNamedElement>

Overrides:

getTraversalStrategy in class AbstractProcessor<CtNamedElement>