diff options
Diffstat (limited to 'plugins/org.eclipse.wst.validation/validate_core/org/eclipse/wst/validation/internal/provisional/core/IValidator.java')
| -rw-r--r-- | plugins/org.eclipse.wst.validation/validate_core/org/eclipse/wst/validation/internal/provisional/core/IValidator.java | 71 |
1 files changed, 0 insertions, 71 deletions
diff --git a/plugins/org.eclipse.wst.validation/validate_core/org/eclipse/wst/validation/internal/provisional/core/IValidator.java b/plugins/org.eclipse.wst.validation/validate_core/org/eclipse/wst/validation/internal/provisional/core/IValidator.java deleted file mode 100644 index cfd19694c..000000000 --- a/plugins/org.eclipse.wst.validation/validate_core/org/eclipse/wst/validation/internal/provisional/core/IValidator.java +++ /dev/null @@ -1,71 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2004 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.validation.internal.provisional.core; - -import org.eclipse.wst.validation.internal.core.ValidationException; - -/** - * This is the base interface for all Validators. A Validator is a class which verifies that objects - * follow some rules. For example, in a MOF model which represents an EJB jar, the EJB specification - * determines the rules. <br> - * <br> - * A validator can perform full validation or incremental validation. All validators must implement - * full validation but incremental validation is optional. <br> - * <br> - * Each validator must not be tied to any particular workbench implementation. <br> - * <br> - * A validator's verification starts when the ValidatorLauncher singleton calls - * <code>validate</code>. - * - * [issue: LM - This interface will be implemented by clients. This should be considered a candidate for - * an abstract class. ] - */ -public interface IValidator{ - /** - * <p> - * Perform any resource cleanup once validation is complete. If cleanup will take some time, the - * IValidator should report subtask information to the user through the IReporter parameter. The - * IReporter parameter will not be null. - * </p> - * @param reporter used for the interaction with the user - * @plannedfor WTP 1.0 - * - * [issue : CS - Perhaps the IValidator should be required to provide a 'name' that can be used describe - * the running validation 'Job'. Then the framework could automatically say something like 'XYZ validator : cleanup'. - * Relying on the IValidator to provide subtask information seems error prone.] - * [issue: LM - Is the cleanup method necessary? Can the framework put a requirement that client validators 'clean up' - * before returning from the validate method? ] - */ - void cleanup(IReporter reporter); - - /** - * This is the method which performs the validation on the objects. <br> - * <br> - * <code>helper</code> and <code>reporter</code> may not be null. <code>changedFiles</code> - * may be null, if a full build is desired. <br> - * <br> - * @param helper - * loads an object. - * @param reporter - * Is an instance of an IReporter interface, which is used for - * interaction with the user. - * @param changedFiles - * Is an array of files which have been added, changed, or deleted - * since the last validation. If <code>changedFiles</code> is null, or if it is an empty - * array, then a full validation should be performed. Otherwise, validation on just the files - * listed in the array should performed if the validator supports incremental validation. - * - * [issue : CS - I'm curious to understand why the validator is not invoked directly on a file. It seems it should be the - * domain of another API to manage manage incremental file changes and triggering validations accordingly. - * Do we have a current use case in WTP where the validator does anything more validate a file from the changedFiles list?] - */ - void validate(IValidationContext helper, IReporter reporter) throws ValidationException; -}
\ No newline at end of file |