ej.tool.addon

Interface AddonProcessor

public interface AddonProcessor

An addon processor is a tool that generates files (Java source files, resource files,...) for a specific project. Given project information and deltas, it can generates new files for this project.

Since there is no guarantee that processor caller will create an instance per project or a unique instance of a processor for all projects, processors must be stateless, thus only rely on given information and deltas.

See Also:

Delta, Marker, JavaProject

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AddonProcessor.ExecutionKind An enumeration of possible kind of processor execution.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDON_PROCESSOR_FILE_EXTENSION Addon Processor file extension.
static String	ADDON_PROCESSOR_IVY_CONF The name of the Ivy configuration to use to declare addon processors.

Method Summary

Modifier and Type	Method and Description
List<Marker>	execute(AddonProcessor.ExecutionKind kind, JavaProject project, List<Delta> deltas, File outputFolder) Runs this processor.
FilenameFilter	getDeltaFilter(JavaProject project) Given project information, gets a filter to evict project deltas that are not needed by this processor.
String	getId() Gets the ID of this processor.
FolderKind	getPreferredOutputFolderKind() Gets the preferred output folder kind of this processor.

Field Detail

ADDON_PROCESSOR_FILE_EXTENSION

static final String ADDON_PROCESSOR_FILE_EXTENSION

Addon Processor file extension.

See Also:

Constant Field Values

ADDON_PROCESSOR_IVY_CONF

static final String ADDON_PROCESSOR_IVY_CONF

The name of the Ivy configuration to use to declare addon processors.

See Also:

Constant Field Values

Method Detail

execute

List<Marker> execute(AddonProcessor.ExecutionKind kind,
                     JavaProject project,
                     List<Delta> deltas,
                     File outputFolder)

Runs this processor. Based on project information and deltas, files can be generated in the given output folder.

Note that deltas list cannot be empty nor null, and all of them match this processor delta filter. Furthermore, the given output folder respects the semantics of getPreferredOutputFolderKind().

Parameters:

kind - the kind of execution.

project - Java project information to rely on.

deltas - list of project deltas.

outputFolder - the output folder for generated files.

Returns:

the list of markers

getDeltaFilter

FilenameFilter getDeltaFilter(JavaProject project)

Given project information, gets a filter to evict project deltas that are not needed by this processor.

Parameters:

project - Java project information the filter can rely on.

Returns:

this processor delta filter.

getId

String getId()

Gets the ID of this processor.

IDs are used to create output source folders. Thus, they must not contain space or special characters.

Returns:

the id of this processor.

getPreferredOutputFolderKind

FolderKind getPreferredOutputFolderKind()

Gets the preferred output folder kind of this processor.

Note that FolderKind.Project is not a valid preferred output folder. If this value is returned, an exception will be thrown, thus processor will not be run.

In addition, if this method returns null, executors will automatically use Java main source folder as preferred output kind.

Returns:

the preferred output folder kind of this processor.

See Also:

FolderKind