org.jmlspecs.eclipse.jdt.ui
Class EscjavaCompilationParticipant

java.lang.Object
  org.eclipse.jdt.core.compiler.CompilationParticipant
      org.jmlspecs.eclipse.jdt.ui.EscjavaCompilationParticipant

public class EscjavaCompilationParticipant
extends CompilationParticipant

This class is intended as an Eclipse CompilationParticipant, but so far it does not work. There is some problem with loading this class in response to using the plugin extension.

Field Summary

Fields inherited from class org.eclipse.jdt.core.compiler.CompilationParticipant

NEEDS_FULL_BUILD, READY_FOR_BUILD

Constructor Summary

EscjavaCompilationParticipant()

Method Summary

int	aboutToBuild(IJavaProject project) Notifies this participant that a build is about to start and provides it the opportunity to create missing source folders for generated source files.
void	buildStarting(BuildContext[] files, boolean isBatch) Notifies this participant that a compile operation is about to start and provides it the opportunity to generate source files based on the source files about to be compiled.
void	cleanStarting(IJavaProject project) Notifies this participant that a clean is about to start and provides it the opportunity to delete generated source files.
boolean	isActive(IJavaProject project) Returns whether this participant is active for a given project.
boolean	isAnnotationProcessor() Returns whether this participant is interested in only Annotations.
void	processAnnotations(BuildContext[] files) Notifies this participant that a compile operation has found source files using Annotations.
void	reconcile(ReconcileContext context) Notifies this participant that a reconcile operation is happening.

Methods inherited from class org.eclipse.jdt.core.compiler.CompilationParticipant

buildFinished

Methods inherited from class java.lang.Object

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

Constructor Detail

EscjavaCompilationParticipant

public EscjavaCompilationParticipant()

Method Detail

aboutToBuild

public int aboutToBuild(IJavaProject project)

Description copied from class: CompilationParticipant

Notifies this participant that a build is about to start and provides it the opportunity to create missing source folders for generated source files. Additional source folders should be marked as optional so the project can be built when the folders do not exist. Only sent to participants interested in the project.

Default is to return READY_FOR_BUILD.

Overrides:

aboutToBuild in class CompilationParticipant

Parameters:

project - the project about to build

Returns:

READY_FOR_BUILD or NEEDS_FULL_BUILD

See Also:

CompilationParticipant.buildFinished(IJavaProject project)

buildStarting

public void buildStarting(BuildContext[] files,
                          boolean isBatch)

Description copied from class: CompilationParticipant

Notifies this participant that a compile operation is about to start and provides it the opportunity to generate source files based on the source files about to be compiled. When isBatchBuild is true, then files contains all source files in the project. Only sent to participants interested in the current build project.

Overrides:

buildStarting in class CompilationParticipant

Parameters:

files - is an array of BuildContext

isBatch - identifies when the build is a batch build

cleanStarting

public void cleanStarting(IJavaProject project)

Description copied from class: CompilationParticipant

Notifies this participant that a clean is about to start and provides it the opportunity to delete generated source files. Only sent to participants interested in the project.

Overrides:

cleanStarting in class CompilationParticipant

Parameters:

project - the project about to be cleaned

isActive

public boolean isActive(IJavaProject project)

Description copied from class: CompilationParticipant

Returns whether this participant is active for a given project.

Default is to return false.

For efficiency, participants that are not interested in the given project should return false for that project.

Overrides:

isActive in class CompilationParticipant

Parameters:

project - the project to participate in

Returns:

whether this participant is active for a given project

isAnnotationProcessor

public boolean isAnnotationProcessor()

Description copied from class: CompilationParticipant

Returns whether this participant is interested in only Annotations.

Default is to return false.

Overrides:

isAnnotationProcessor in class CompilationParticipant

Returns:

whether this participant is interested in only Annotations.

processAnnotations

public void processAnnotations(BuildContext[] files)

Description copied from class: CompilationParticipant

Notifies this participant that a compile operation has found source files using Annotations. Only sent to participants interested in the current build project that answer true to isAnnotationProcessor(). Each BuildContext was informed whether its source file currently hasAnnotations().

Overrides:

processAnnotations in class CompilationParticipant

Parameters:

files - is an array of BuildContext

reconcile

public void reconcile(ReconcileContext context)

Description copied from class: CompilationParticipant

Notifies this participant that a reconcile operation is happening. The participant can act on this reconcile operation by using the given context. Other participant can then see the result of this participation on this context.

Note that a participant should not modify the buffer of the working copy that is being reconciled.

Default is to do nothing.

Overrides:

reconcile in class CompilationParticipant

Parameters:

context - the reconcile context to act on