Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Mail Systems
Eclipse Documentation

How To Guides
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Problem Solutions
Privacy Policy




Eclipse Web Tools Guide
Previous Page Home Next Page

Package org.eclipse.wst.validation

A framework for calling validators that are build based.


Interface Summary
IDependencyIndex This service is used to specify the resources that a particular resource depends on.
IMutableValidator A validator that has fields that can be updated.
IPerformanceMonitor A service that collects performance information on validation operations.
IValidatorGroupListener Validators may wish to join validator groups for performance or other reasons.

Class Summary
AbstractValidator The class that all Validators that wish to use version two of the validation framework must subclass.
DependentResource A resource that is dependent on another resource.
Friend This class is only to be called by the validation framework and it's test cases.
MessageSeveritySetting Associate a message severity with a message category.
MutableProjectSettings This class holds the overall project validation settings.
MutableWorkspaceSettings This class holds the overall workspace validation settings.
PerformanceCounters Some performance information for a validation invocation.
ReporterHelper This is a temporary class to ease the transition from the previous validation framework.
ValidationEvent An object that describes which object should be validated and what triggered its validation.
ValidationFramework The central class of the Validation Framework.
ValidationResult The result of running a validate operation.
ValidationResults The combined results of validating multiple resources.
ValidationState Keep track of arbitrary validation data, during the course of a validation.
Validator Represents a validator.
Validator.V1 A validator that uses version 1 of the validation framework.
Validator.V2 A validator that uses version 2 of the validation framework.
ValidatorMessage This class provides a way for a validator to return messages, that are easily converted into IMarkers.

Enum Summary
IPerformanceMonitor.CollectionLevel The level of information to collect.
Validator.Level The level of configuration for the validator.

Package org.eclipse.wst.validation Description

A framework for calling validators that are build based.

Also see Frequently Asked Questions

There are two main types of validation, build based and as you type. This framework supports build based validation. If auto build is turned on then the validators are called when the user saves their file. If auto build is not turned on then the validators are called when the user starts a build.

This framework was added to WTP in version 3.0.

Dependency Support

Sometimes resources depend on other resources, to determine whether they are valid or not. An example would be that an XML resource could depend on a DTD. If at some point in the future the DTD changes, then the dependent XML resource should be revalidated to ensure that it still meets the requirements of the changed DTD file. In order to do this efficiently, there needs to be an association between the DTD and all the resources that depend on it.

To be as efficient as possible, the validation framework allows this dependency information to be returned as part of a validate operation. Since the validator needed to figure this out anyways, why not pass this information back to the framework, so that it can be saved. This saves the cost of having to parse the file at some later point in time (when the file is probably sitting cold on disk). The fewer times that we need to open, read and/or parse the same file, will improve the performance of the product.

In particular when the validate method returns, a ValidationResult must be returned, inside of this result, all your dependencies need to be specified with the setDependsOn method.

In addition to keeping the dependency information up-to-date through the normal course of validation, direct access is also provided to the dependency support through the getDependencyIndex method. The IDependencyIndex allows you to directly manipulate the dependency information for a validator.

Entry Points into the Validation Framework

Here are some of the points where the platform calls into the framework:

  • Builder - ValidationBuilder
  • IFacetedProjectListener - ValManager
  • IJobChangeListener - ValidationOperation, ValidationOperation.ValidationLauncherJob
  • IProjectChangeListener - ValManager
  • IPropertyChangeListener - ValidationConfiguration, DisabledResourceManager
  • IResourceChangeListener - EventManger
  • IValChangedListener - ValManager, DisabledValidatorManager

  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire