org.eclipse.wst.validation.IMutableValidator Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2009, 2012 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;
/**
* A validator that has fields that can be updated.
*
* The following procedure is used to change a Validator's settings.
*
* - An IMutableValidator is retrieved.
* - The IMutableValidator is changed.
* - The IMutableValidator is "activated".
*
*
* The methods {@link ValidationFramework#getProjectSettings(org.eclipse.core.resources.IProject)} and
* {@link ValidationFramework#getWorkspaceSettings()} can be used to retrieve IMutableValidator's.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
* @author karasiuk
*
*/
public interface IMutableValidator {
/**
* Answer the validator's id.
* @return
*/
String getId();
/**
* Answer the validator's name.
* @return
*/
String getName();
/**
* Answer the validator's class name.
* @return
*/
String getValidatorClassname();
/**
* Answer if the validator is enabled for build based validation.
*/
boolean isBuildValidation();
/**
* Answer if the validator is enabled for manual based validation.
*/
boolean isManualValidation();
/**
* Set whether the validator should be enabled for build based validation.
*/
void setBuildValidation(boolean build);
/**
* Set whether the validator should be enabled for manual based validation.
*/
void setManualValidation(boolean manual);
}