|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.wst.validation.Validator
org.eclipse.wst.validation.Validator.V2
public static final class Validator.V2
A validator that uses version 2 of the validation framework.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.wst.validation.Validator |
---|
Validator.Level, Validator.V1, Validator.V2 |
Method Summary | |
---|---|
void |
add(org.eclipse.wst.validation.internal.model.FilterGroup fg)
|
IValidator |
asIValidator()
|
Validator.V2 |
asV2Validator()
If you are a version 2 validator, answer yourself as one, otherwise answer null. |
void |
bumpChangeCountGroups()
|
void |
clean(IProject project,
org.eclipse.wst.validation.internal.ValOperation operation,
IProgressMonitor monitor)
Let the validator know that a clean is about to happen. |
Validator |
copy(boolean includeChangeCounts)
|
java.lang.Object |
getAdapter(java.lang.Class adapter)
|
int |
getChangeCountGroups()
|
AbstractValidator |
getDelegatedValidator()
Answer the actual validator that is going to perform the validation. |
org.eclipse.wst.validation.internal.model.FilterGroup[] |
getGroups()
Answer the validator's filter groups. |
java.lang.String |
getId()
|
Validator.Level |
getLevel()
|
java.lang.String |
getName()
|
AbstractValidator |
getValidator()
|
java.lang.String |
getValidatorClassname()
Answer the name of the class that implements the validator. |
java.lang.String[] |
getValidatorGroups()
|
int |
hashCodeForConfig()
Answer a hash code for the configurable fields so that we can quickly determine if two validators are the same. |
boolean |
isChanged()
Has the validator changed since it was last created or copied? |
void |
remove(org.eclipse.wst.validation.internal.model.FilterGroup group)
|
void |
replaceFilterGroup(org.eclipse.wst.validation.internal.model.FilterGroup existing,
org.eclipse.wst.validation.internal.model.FilterGroup merged)
|
void |
resetChangeCounters()
|
void |
setDelegatingId(java.lang.String delegating)
Set the id of the "real" validator, that is the validator that will be called when this delegating validator is asked to validate something. |
void |
setGroups(java.util.List<org.eclipse.wst.validation.internal.model.FilterGroup> groups)
|
void |
setId(java.lang.String id)
|
void |
setLevel(Validator.Level level)
|
void |
setName(java.lang.String name)
|
boolean |
shouldClearMarkers(ValidationEvent event)
Should the validation framework first clear the markers that this validator has placed on this resource? |
ValidationResult |
validate(IResource resource,
int kind,
org.eclipse.wst.validation.internal.ValOperation operation,
IProgressMonitor monitor)
Validate the resource. |
ValidationResult |
validate(IResource resource,
int kind,
org.eclipse.wst.validation.internal.ValOperation operation,
IProgressMonitor monitor,
ValidationEvent event)
Validate the resource. |
void |
validationFinishing(IProject project,
ValidationState state,
IProgressMonitor monitor)
This method will be called when validation is complete. |
void |
validationStarting(IProject project,
ValidationState state,
IProgressMonitor monitor)
This method will be called before any validation takes place. |
Methods inherited from class org.eclipse.wst.validation.Validator |
---|
asV1Validator, bumpChangeCountGlobal, bumpChangeCountMessages, compareTo, copy, create, create, getChangeCountGlobal, getChangeCountMessages, getDelegatingId, getMarkerId, getMessage, getMessageSettings, getProject, getSourceId, getVersion, hasGlobalChanges, isBuildValidation, isManualValidation, sameConfig, setBuildValidation, setManualValidation, setMarkerId, setSourceId, setVersion, shouldValidate, shouldValidate, shouldValidateProject, shouldValidateProject, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public void add(org.eclipse.wst.validation.internal.model.FilterGroup fg)
public IValidator asIValidator()
asIValidator
in class Validator
public Validator.V2 asV2Validator()
Validator
asV2Validator
in class Validator
public void clean(IProject project, org.eclipse.wst.validation.internal.ValOperation operation, IProgressMonitor monitor)
clean
in class Validator
project
- the project that is being cleaned. This can be null which means that the workspace
is being cleaned (in which case a separate call will be made for each open project).monitor
- the monitor that should be used for reporting progress if the clean takes a long time.public Validator copy(boolean includeChangeCounts)
copy
in class Validator
public int getChangeCountGroups()
public void bumpChangeCountGroups()
public Validator.Level getLevel()
public void setLevel(Validator.Level level)
public AbstractValidator getDelegatedValidator()
public java.lang.String getId()
getId
in class Validator
public org.eclipse.wst.validation.internal.model.FilterGroup[] getGroups()
public java.lang.String getName()
getName
in class Validator
public AbstractValidator getValidator()
public java.lang.String getValidatorClassname()
Validator
getValidatorClassname
in class Validator
public java.lang.String[] getValidatorGroups()
public int hashCodeForConfig()
Validator
hashCodeForConfig
in class Validator
public boolean isChanged()
Validator
isChanged
in class Validator
public boolean shouldClearMarkers(ValidationEvent event)
Validator
shouldClearMarkers
in class Validator
event
- The validation event that triggered the validation.
public void setDelegatingId(java.lang.String delegating)
Validator
setDelegatingId
in class Validator
delegating
- the id of the validator that is actually going to perform the validation.public void setGroups(java.util.List<org.eclipse.wst.validation.internal.model.FilterGroup> groups)
public void setId(java.lang.String id)
public void setName(java.lang.String name)
public ValidationResult validate(IResource resource, int kind, org.eclipse.wst.validation.internal.ValOperation operation, IProgressMonitor monitor)
Validator
validate
in class Validator
resource
- The resource to be validated.kind
- The kind of resource change, see IResourceDelta for values.operation
- The operation that this validation is running under. This can
be null.monitor
- A way to report progress. This can be null.
public ValidationResult validate(IResource resource, int kind, org.eclipse.wst.validation.internal.ValOperation operation, IProgressMonitor monitor, ValidationEvent event)
Validator
validate
in class Validator
resource
- The resource to be validated.kind
- The kind of resource change, see IResourceDelta for values.operation
- The operation that this validation is running under. This can
be null.monitor
- A way to report progress. This can be null.event
- An event that describes in more detail what should be
validated and why it should be validated. This can be null.
public void validationStarting(IProject project, ValidationState state, IProgressMonitor monitor)
Validator
validationStarting
in class Validator
project
- the project that is being validated. For the very first call in the validation phase,
this will be null. That is the signal to the validator that a top level validation is starting.
Subsequently, the project will be set, as each of the individual projects are validated.state
- a way to pass arbitrary, validator specific, data from one invocation of a validator to
the next, during the validation phase.monitor
- the monitor that should be used for reporting progress if the clean takes a long time.public void validationFinishing(IProject project, ValidationState state, IProgressMonitor monitor)
Validator
validationFinishing
in class Validator
project
- the project that was validated. The very last call in the validation will set this to
null so that the validator knows that all the projects have now been validated.state
- a way to pass arbitrary, validator specific, data from one invocation of a validator to
the next, during the validation phase.monitor
- the monitor that should be used for reporting progress if the clean takes a long time.public java.lang.Object getAdapter(java.lang.Class adapter)
public void remove(org.eclipse.wst.validation.internal.model.FilterGroup group)
public void resetChangeCounters()
resetChangeCounters
in class Validator
public void replaceFilterGroup(org.eclipse.wst.validation.internal.model.FilterGroup existing, org.eclipse.wst.validation.internal.model.FilterGroup merged)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |