public abstract class ValidationParticipant
extends java.lang.Object
Clients wishing to participate in the validation process must subclass this class, and implement
isActive(IJavaScriptProject)
, aboutToBuild(IJavaScriptProject)
,
reconcile(ReconcileContext)
, etc.
This class is intended to be subclassed by clients.
Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.Modifier and Type | Field and Description |
---|---|
static int |
NEEDS_FULL_BUILD |
static int |
READY_FOR_BUILD |
Constructor and Description |
---|
ValidationParticipant() |
Modifier and Type | Method and Description |
---|---|
int |
aboutToBuild(IJavaScriptProject project)
Notifies this participant that a validation 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 validation operation is about to start and provides it the opportunity to
generate source files based on the source files about to be validated.
|
void |
cleanStarting(IJavaScriptProject project)
Notifies this participant that a clean is about to start and provides it the opportunity to
delete generated source files.
|
boolean |
isActive(IJavaScriptProject project)
Returns whether this participant is active for a given project.
|
void |
reconcile(ReconcileContext context)
Notifies this participant that a reconcile operation is happening.
|
public static int READY_FOR_BUILD
public static int NEEDS_FULL_BUILD
public int aboutToBuild(IJavaScriptProject project)
Default is to return READY_FOR_BUILD
.
project
- the project about to buildpublic void buildStarting(BuildContext[] files, boolean isBatch)
files
- is an array of BuildContextisBatch
- identifies when the build is a batch buildpublic void cleanStarting(IJavaScriptProject project)
project
- the project about to be cleanedpublic boolean isActive(IJavaScriptProject project)
Default is to return false
.
For efficiency, participants that are not interested in the
given project should return false
for that project.
project
- the project to participate inpublic void reconcile(ReconcileContext context)
Note that a participant should not modify the buffer of the working copy that is being reconciled.
Default is to do nothing.
context
- the reconcile context to act onCopyright (c) IBM Corp. and others 2000, 2016. All Rights Reserved.