diff options
Diffstat (limited to 'docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/Validator.html')
-rw-r--r-- | docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/Validator.html | 1438 |
1 files changed, 0 insertions, 1438 deletions
diff --git a/docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/Validator.html b/docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/Validator.html deleted file mode 100644 index 10606f53f..000000000 --- a/docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/Validator.html +++ /dev/null @@ -1,1438 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0) on Tue Jan 27 04:28:33 EST 2009 --> -<TITLE> -Validator -</TITLE> - -<META NAME="date" CONTENT="2009-01-27"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Validator"; - } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - -<!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Validator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../org/eclipse/wst/validation/ValidationState.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A> - <A HREF="../../../../org/eclipse/wst/validation/Validator.Level.html" title="enum in org.eclipse.wst.validation"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/eclipse/wst/validation/Validator.html" target="_top"><B>FRAMES</B></A> - <A HREF="Validator.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.eclipse.wst.validation</FONT> -<BR> -Class Validator</H2> -<PRE> -java.lang.Object - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.validation.Validator</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable<<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A>></DD> -</DL> -<DL> -<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/eclipse/wst/validation/Validator.V1.html" title="class in org.eclipse.wst.validation">Validator.V1</A>, <A HREF="../../../../org/eclipse/wst/validation/Validator.V2.html" title="class in org.eclipse.wst.validation">Validator.V2</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public abstract class <B>Validator</B><DT>extends java.lang.Object<DT>implements java.lang.Comparable<<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A>></DL> -</PRE> - -<P> -Represents a validator. This gets instantiated through one of the validator extension points. - <p> - <b>This class is not API</b>. - </p> -<P> - -<P> -<HR> - -<P> -<!-- ======== NESTED CLASS SUMMARY ======== --> - -<A NAME="nested_class_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Nested Class Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static class</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.Level.html" title="enum in org.eclipse.wst.validation">Validator.Level</A></B></CODE> - -<BR> - The level of configuration for the validator.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static class</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.V1.html" title="class in org.eclipse.wst.validation">Validator.V1</A></B></CODE> - -<BR> - A validator that uses version 1 of the validation framework.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static class</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.V2.html" title="class in org.eclipse.wst.validation">Validator.V2</A></B></CODE> - -<BR> - A validator that uses version 2 of the validation framework.</TD> -</TR> -</TABLE> - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#Validator(IProject)">Validator</A></B>(IProject project)</CODE> - -<BR> - </TD> -</TR> -</TABLE> - -<!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#asIValidator()">asIValidator</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/eclipse/wst/validation/Validator.V1.html" title="class in org.eclipse.wst.validation">Validator.V1</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#asV1Validator()">asV1Validator</A></B>()</CODE> - -<BR> - If you are a version 1 validator, answer yourself as one, otherwise answer null.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/eclipse/wst/validation/Validator.V2.html" title="class in org.eclipse.wst.validation">Validator.V2</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#asV2Validator()">asV2Validator</A></B>()</CODE> - -<BR> - If you are a version 2 validator, answer yourself as one, otherwise answer null.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#bumpChangeCountGlobal()">bumpChangeCountGlobal</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#bumpChangeCountMessages()">bumpChangeCountMessages</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#clean(IProject, org.eclipse.wst.validation.internal.ValOperation, IProgressMonitor)">clean</A></B>(IProject project, - org.eclipse.wst.validation.internal.ValOperation operation, - IProgressMonitor monitor)</CODE> - -<BR> - The project is being cleaned, this method gives the validator a chance to do any special cleanup.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#compareTo(org.eclipse.wst.validation.Validator)">compareTo</A></B>(<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> validator)</CODE> - -<BR> - Compare yourself based on Validator name.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#copy()">copy</A></B>()</CODE> - -<BR> - Answer a deep copy of yourself.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#copy(boolean)">copy</A></B>(boolean includeChangeCounts)</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#create(IConfigurationElement, IProject)">create</A></B>(IConfigurationElement validator, - IProject project)</CODE> - -<BR> - Create a new validator based on a abstract validator.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#create(ValidatorMetaData, ValidationConfiguration, IProject)">create</A></B>(ValidatorMetaData vmd, - ValidationConfiguration config, - IProject project)</CODE> - -<BR> - Create a new validator based on validator meta data.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getChangeCountGlobal()">getChangeCountGlobal</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getChangeCountMessages()">getChangeCountMessages</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getDelegatingId()">getDelegatingId</A></B>()</CODE> - -<BR> - Get the id of the "real" validator, that is the validator that will be called when this delegating - validator is asked to validate something.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getId()">getId</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getMarkerId()">getMarkerId</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/eclipse/wst/validation/MessageSeveritySetting.html" title="class in org.eclipse.wst.validation">MessageSeveritySetting</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getMessage(java.lang.String)">getMessage</A></B>(java.lang.String id)</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.Map<java.lang.String,<A HREF="../../../../org/eclipse/wst/validation/MessageSeveritySetting.html" title="class in org.eclipse.wst.validation">MessageSeveritySetting</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getMessageSettings()">getMessageSettings</A></B>()</CODE> - -<BR> - Answer all the message settings that this validator has defined.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getName()">getName</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> IProject</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getProject()">getProject</A></B>()</CODE> - -<BR> - Answer the project that you were enabled on.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getSourceId()">getSourceId</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getValidatorClassname()">getValidatorClassname</A></B>()</CODE> - -<BR> - Answer the name of the class that implements the validator.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#getVersion()">getVersion</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#hasGlobalChanges()">hasGlobalChanges</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#hashCodeForConfig()">hashCodeForConfig</A></B>()</CODE> - -<BR> - Answer a hash code for the configurable fields so that we can quickly determine if two - validators are the same.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#isBuildValidation()">isBuildValidation</A></B>()</CODE> - -<BR> - Is this validator currently enabled for validations that are triggered by builds?</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#isChanged()">isChanged</A></B>()</CODE> - -<BR> - Has the validator changed since it was last created or copied?</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#isManualValidation()">isManualValidation</A></B>()</CODE> - -<BR> - Is this validator currently enabled for validations that are triggered manually?</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#resetChangeCounters()">resetChangeCounters</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#sameConfig(org.eclipse.wst.validation.Validator)">sameConfig</A></B>(<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> validator)</CODE> - -<BR> - Answer true if you have the same configuration settings as validator.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#setBuildValidation(boolean)">setBuildValidation</A></B>(boolean buildValidation)</CODE> - -<BR> - Set whether this validator should be triggered by the build process.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#setDelegatingId(java.lang.String)">setDelegatingId</A></B>(java.lang.String delegating)</CODE> - -<BR> - Set the id of the "real" validator, that is the validator that will be called when this delegating - validator is asked to validate something.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#setManualValidation(boolean)">setManualValidation</A></B>(boolean manualValidation)</CODE> - -<BR> - Set whether this validator should be triggered as part of a manual validation.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#setMarkerId(java.lang.String)">setMarkerId</A></B>(java.lang.String markerId)</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#setSourceId(java.lang.String)">setSourceId</A></B>(java.lang.String sourceId)</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#setVersion(int)">setVersion</A></B>(int version)</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#shouldClearMarkers(org.eclipse.wst.validation.ValidationEvent)">shouldClearMarkers</A></B>(<A HREF="../../../../org/eclipse/wst/validation/ValidationEvent.html" title="class in org.eclipse.wst.validation">ValidationEvent</A> event)</CODE> - -<BR> - Should the validation framework first clear the markers that this - validator has placed on this resource?</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#shouldValidate(IResource, boolean, boolean)">shouldValidate</A></B>(IResource resource, - boolean isManual, - boolean isBuild)</CODE> - -<BR> - Answer true if this validator, based on it's filters, should validate - this resource.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#shouldValidate(IResource, org.eclipse.wst.validation.internal.ValType)">shouldValidate</A></B>(IResource resource, - org.eclipse.wst.validation.internal.ValType valType)</CODE> - -<BR> - Answer true if this validator, based on it's filters, should validate - this resource.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#shouldValidateProject(IProject, boolean, boolean)">shouldValidateProject</A></B>(IProject project, - boolean isManual, - boolean isBuild)</CODE> - -<BR> - Answer true if this validator, based on it's filters, should validate this project.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#shouldValidateProject(IProject, org.eclipse.wst.validation.internal.ValType)">shouldValidateProject</A></B>(IProject project, - org.eclipse.wst.validation.internal.ValType type)</CODE> - -<BR> - Answer true if this validator, based on it's filters, should validate this project.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.lang.String</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#toString()">toString</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract <A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation">ValidationResult</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#validate(IResource, int, org.eclipse.wst.validation.internal.ValOperation, IProgressMonitor)">validate</A></B>(IResource resource, - int kind, - org.eclipse.wst.validation.internal.ValOperation operation, - IProgressMonitor monitor)</CODE> - -<BR> - Validate the resource.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation">ValidationResult</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#validate(IResource, int, org.eclipse.wst.validation.internal.ValOperation, IProgressMonitor, org.eclipse.wst.validation.ValidationEvent)">validate</A></B>(IResource resource, - int kind, - org.eclipse.wst.validation.internal.ValOperation operation, - IProgressMonitor monitor, - <A HREF="../../../../org/eclipse/wst/validation/ValidationEvent.html" title="class in org.eclipse.wst.validation">ValidationEvent</A> event)</CODE> - -<BR> - Validate the resource.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#validationFinishing(IProject, org.eclipse.wst.validation.ValidationState, IProgressMonitor)">validationFinishing</A></B>(IProject project, - <A HREF="../../../../org/eclipse/wst/validation/ValidationState.html" title="class in org.eclipse.wst.validation">ValidationState</A> state, - IProgressMonitor monitor)</CODE> - -<BR> - This method will be called when validation is complete.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/Validator.html#validationStarting(IProject, org.eclipse.wst.validation.ValidationState, IProgressMonitor)">validationStarting</A></B>(IProject project, - <A HREF="../../../../org/eclipse/wst/validation/ValidationState.html" title="class in org.eclipse.wst.validation">ValidationState</A> state, - IProgressMonitor monitor)</CODE> - -<BR> - This method will be called before any validation takes place.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="Validator(IProject)"><!-- --></A><H3> -Validator</H3> -<PRE> -public <B>Validator</B>(IProject project)</PRE> -<DL> -</DL> - -<!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="create(IConfigurationElement, IProject)"><!-- --></A><H3> -create</H3> -<PRE> -public static <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> <B>create</B>(IConfigurationElement validator, - IProject project)</PRE> -<DL> -<DD>Create a new validator based on a abstract validator. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>validator</CODE> - The validator that is being wrapped.<DD><CODE>project</CODE> - The project that you are defined in. This can be null which - means that you are a global validator.</DL> -</DD> -</DL> -<HR> - -<A NAME="create(ValidatorMetaData, ValidationConfiguration, IProject)"><!-- --></A><H3> -create</H3> -<PRE> -public static <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> <B>create</B>(ValidatorMetaData vmd, - ValidationConfiguration config, - IProject project)</PRE> -<DL> -<DD>Create a new validator based on validator meta data. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project that you are defined in. This can be null which - means that you are a global validator.</DL> -</DD> -</DL> -<HR> - -<A NAME="asV1Validator()"><!-- --></A><H3> -asV1Validator</H3> -<PRE> -public <A HREF="../../../../org/eclipse/wst/validation/Validator.V1.html" title="class in org.eclipse.wst.validation">Validator.V1</A> <B>asV1Validator</B>()</PRE> -<DL> -<DD>If you are a version 1 validator, answer yourself as one, otherwise answer null. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="asV2Validator()"><!-- --></A><H3> -asV2Validator</H3> -<PRE> -public <A HREF="../../../../org/eclipse/wst/validation/Validator.V2.html" title="class in org.eclipse.wst.validation">Validator.V2</A> <B>asV2Validator</B>()</PRE> -<DL> -<DD>If you are a version 2 validator, answer yourself as one, otherwise answer null. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="clean(IProject, org.eclipse.wst.validation.internal.ValOperation, IProgressMonitor)"><!-- --></A><H3> -clean</H3> -<PRE> -public void <B>clean</B>(IProject project, - org.eclipse.wst.validation.internal.ValOperation operation, - IProgressMonitor monitor)</PRE> -<DL> -<DD>The project is being cleaned, this method gives the validator a chance to do any special cleanup. - The default is to do nothing. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>project</CODE> - the project being built.<DD><CODE>monitor</CODE> - the monitor that should be used for reporting progress if the clean takes a long time.</DL> -</DD> -</DL> -<HR> - -<A NAME="compareTo(org.eclipse.wst.validation.Validator)"><!-- --></A><H3> -compareTo</H3> -<PRE> -public int <B>compareTo</B>(<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> validator)</PRE> -<DL> -<DD>Compare yourself based on Validator name. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable<<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A>></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="copy()"><!-- --></A><H3> -copy</H3> -<PRE> -public <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> <B>copy</B>()</PRE> -<DL> -<DD>Answer a deep copy of yourself. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="copy(boolean)"><!-- --></A><H3> -copy</H3> -<PRE> -public abstract <A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> <B>copy</B>(boolean includeChangeCounts)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="shouldClearMarkers(org.eclipse.wst.validation.ValidationEvent)"><!-- --></A><H3> -shouldClearMarkers</H3> -<PRE> -public boolean <B>shouldClearMarkers</B>(<A HREF="../../../../org/eclipse/wst/validation/ValidationEvent.html" title="class in org.eclipse.wst.validation">ValidationEvent</A> event)</PRE> -<DL> -<DD>Should the validation framework first clear the markers that this - validator has placed on this resource? This method can be overridden by - validator implementors to provide a validator specific behavior. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>event</CODE> - The validation event that triggered the validation. -<DT><B>Returns:</B><DD>true if the validation framework should first clear all the - markers that this validator produced. This is the default - behavior. Return false to leave the markers unchanged. It then - becomes the responsibility of the validator to manage it's own - markers for this resource, for this validation event.</DL> -</DD> -</DL> -<HR> - -<A NAME="shouldValidate(IResource, boolean, boolean)"><!-- --></A><H3> -shouldValidate</H3> -<PRE> -public boolean <B>shouldValidate</B>(IResource resource, - boolean isManual, - boolean isBuild)</PRE> -<DL> -<DD>Answer true if this validator, based on it's filters, should validate - this resource. This method does not check to see if global validation or - project validation has been suspended or not. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>resource</CODE> - The resource to be checked.<DD><CODE>isManual</CODE> - If true then this validator must also be enabled for manual - validation.<DD><CODE>isBuild</CODE> - If true then this validator must also be enabled for builder - based validation. -<DT><B>Returns:</B><DD>true if the resource should be validated.</DL> -</DD> -</DL> -<HR> - -<A NAME="shouldValidate(IResource, org.eclipse.wst.validation.internal.ValType)"><!-- --></A><H3> -shouldValidate</H3> -<PRE> -public boolean <B>shouldValidate</B>(IResource resource, - org.eclipse.wst.validation.internal.ValType valType)</PRE> -<DL> -<DD>Answer true if this validator, based on it's filters, should validate - this resource. This method does not check to see if global validation or - project validation has been suspended or not. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>resource</CODE> - The resource to be checked.<DD><CODE>valType</CODE> - The context to use when performing the check. -<DT><B>Returns:</B><DD>true if the resource should be validated.</DL> -</DD> -</DL> -<HR> - -<A NAME="shouldValidateProject(IProject, org.eclipse.wst.validation.internal.ValType)"><!-- --></A><H3> -shouldValidateProject</H3> -<PRE> -public boolean <B>shouldValidateProject</B>(IProject project, - org.eclipse.wst.validation.internal.ValType type)</PRE> -<DL> -<DD>Answer true if this validator, based on it's filters, should validate this project. This method - does not check to see if global validation or project validation has been suspended or not. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>project</CODE> - the project to be checked<DD><CODE>type</CODE> - The type of validation request -<DT><B>Returns:</B><DD>true if the project should be validated.</DL> -</DD> -</DL> -<HR> - -<A NAME="shouldValidateProject(IProject, boolean, boolean)"><!-- --></A><H3> -shouldValidateProject</H3> -<PRE> -public boolean <B>shouldValidateProject</B>(IProject project, - boolean isManual, - boolean isBuild)</PRE> -<DL> -<DD>Answer true if this validator, based on it's filters, should validate this project. This method - does not check to see if global validation or project validation has been suspended or not. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>project</CODE> - the project to be checked<DD><CODE>isManual</CODE> - if true then this validator must also be enabled for manual validation.<DD><CODE>isBuild</CODE> - if true then this validator must also be enabled for builder based validation. -<DT><B>Returns:</B><DD>true if the project should be validated.</DL> -</DD> -</DL> -<HR> - -<A NAME="validate(IResource, int, org.eclipse.wst.validation.internal.ValOperation, IProgressMonitor)"><!-- --></A><H3> -validate</H3> -<PRE> -public abstract <A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation">ValidationResult</A> <B>validate</B>(IResource resource, - int kind, - org.eclipse.wst.validation.internal.ValOperation operation, - IProgressMonitor monitor)</PRE> -<DL> -<DD>Validate the resource. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>resource</CODE> - The resource to be validated.<DD><CODE>kind</CODE> - The kind of resource change, see IResourceDelta for values.<DD><CODE>operation</CODE> - The operation that this validation is running under. This can - be null.<DD><CODE>monitor</CODE> - A way to report progress. This can be null. -<DT><B>Returns:</B><DD>the result of doing the validation, it can be, but usually isn't - null.</DL> -</DD> -</DL> -<HR> - -<A NAME="validate(IResource, int, org.eclipse.wst.validation.internal.ValOperation, IProgressMonitor, org.eclipse.wst.validation.ValidationEvent)"><!-- --></A><H3> -validate</H3> -<PRE> -public <A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation">ValidationResult</A> <B>validate</B>(IResource resource, - int kind, - org.eclipse.wst.validation.internal.ValOperation operation, - IProgressMonitor monitor, - <A HREF="../../../../org/eclipse/wst/validation/ValidationEvent.html" title="class in org.eclipse.wst.validation">ValidationEvent</A> event)</PRE> -<DL> -<DD>Validate the resource. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>resource</CODE> - The resource to be validated.<DD><CODE>kind</CODE> - The kind of resource change, see IResourceDelta for values.<DD><CODE>operation</CODE> - The operation that this validation is running under. This can - be null.<DD><CODE>monitor</CODE> - A way to report progress. This can be null.<DD><CODE>event</CODE> - An event that describes in more detail what should be - validated and why it should be validated. This can be null. -<DT><B>Returns:</B><DD>the result of doing the validation, it can be, but usually isn't - null.</DL> -</DD> -</DL> -<HR> - -<A NAME="validationStarting(IProject, org.eclipse.wst.validation.ValidationState, IProgressMonitor)"><!-- --></A><H3> -validationStarting</H3> -<PRE> -public void <B>validationStarting</B>(IProject project, - <A HREF="../../../../org/eclipse/wst/validation/ValidationState.html" title="class in org.eclipse.wst.validation">ValidationState</A> state, - IProgressMonitor monitor)</PRE> -<DL> -<DD>This method will be called before any validation takes place. It allows validators to perform any - initialization that they might need. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>project</CODE> - 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.<DD><CODE>state</CODE> - a way to pass arbitrary, validator specific, data from one invocation of a validator to - the next, during the validation phase.<DD><CODE>monitor</CODE> - the monitor that should be used for reporting progress if the clean takes a long time.</DL> -</DD> -</DL> -<HR> - -<A NAME="validationFinishing(IProject, org.eclipse.wst.validation.ValidationState, IProgressMonitor)"><!-- --></A><H3> -validationFinishing</H3> -<PRE> -public void <B>validationFinishing</B>(IProject project, - <A HREF="../../../../org/eclipse/wst/validation/ValidationState.html" title="class in org.eclipse.wst.validation">ValidationState</A> state, - IProgressMonitor monitor)</PRE> -<DL> -<DD>This method will be called when validation is complete. It allows validators to perform any - cleanup that they might need to do. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>project</CODE> - 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.<DD><CODE>state</CODE> - a way to pass arbitrary, validator specific, data from one invocation of a validator to - the next, during the validation phase.<DD><CODE>monitor</CODE> - the monitor that should be used for reporting progress if the clean takes a long time.</DL> -</DD> -</DL> -<HR> - -<A NAME="asIValidator()"><!-- --></A><H3> -asIValidator</H3> -<PRE> -public <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> <B>asIValidator</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getId()"><!-- --></A><H3> -getId</H3> -<PRE> -public abstract java.lang.String <B>getId</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getMessage(java.lang.String)"><!-- --></A><H3> -getMessage</H3> -<PRE> -public <A HREF="../../../../org/eclipse/wst/validation/MessageSeveritySetting.html" title="class in org.eclipse.wst.validation">MessageSeveritySetting</A> <B>getMessage</B>(java.lang.String id)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getMessageSettings()"><!-- --></A><H3> -getMessageSettings</H3> -<PRE> -public java.util.Map<java.lang.String,<A HREF="../../../../org/eclipse/wst/validation/MessageSeveritySetting.html" title="class in org.eclipse.wst.validation">MessageSeveritySetting</A>> <B>getMessageSettings</B>()</PRE> -<DL> -<DD>Answer all the message settings that this validator has defined. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>an empty map if the validator did not define any message settings.</DL> -</DD> -</DL> -<HR> - -<A NAME="hashCodeForConfig()"><!-- --></A><H3> -hashCodeForConfig</H3> -<PRE> -public int <B>hashCodeForConfig</B>()</PRE> -<DL> -<DD>Answer a hash code for the configurable fields so that we can quickly determine if two - validators are the same. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getName()"><!-- --></A><H3> -getName</H3> -<PRE> -public abstract java.lang.String <B>getName</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getProject()"><!-- --></A><H3> -getProject</H3> -<PRE> -public IProject <B>getProject</B>()</PRE> -<DL> -<DD>Answer the project that you were enabled on. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>null if you are a global (i.e. workspace level) validator.</DL> -</DD> -</DL> -<HR> - -<A NAME="getValidatorClassname()"><!-- --></A><H3> -getValidatorClassname</H3> -<PRE> -public abstract java.lang.String <B>getValidatorClassname</B>()</PRE> -<DL> -<DD>Answer the name of the class that implements the validator. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="isManualValidation()"><!-- --></A><H3> -isManualValidation</H3> -<PRE> -public boolean <B>isManualValidation</B>()</PRE> -<DL> -<DD>Is this validator currently enabled for validations that are triggered manually? -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setManualValidation(boolean)"><!-- --></A><H3> -setManualValidation</H3> -<PRE> -public boolean <B>setManualValidation</B>(boolean manualValidation)</PRE> -<DL> -<DD>Set whether this validator should be triggered as part of a manual validation. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>manualValidation</CODE> - -<DT><B>Returns:</B><DD>true if the setting changed.</DL> -</DD> -</DL> -<HR> - -<A NAME="isBuildValidation()"><!-- --></A><H3> -isBuildValidation</H3> -<PRE> -public boolean <B>isBuildValidation</B>()</PRE> -<DL> -<DD>Is this validator currently enabled for validations that are triggered by builds? -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="isChanged()"><!-- --></A><H3> -isChanged</H3> -<PRE> -public boolean <B>isChanged</B>()</PRE> -<DL> -<DD>Has the validator changed since it was last created or copied? Or was it migrated from an earlier version. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setBuildValidation(boolean)"><!-- --></A><H3> -setBuildValidation</H3> -<PRE> -public boolean <B>setBuildValidation</B>(boolean buildValidation)</PRE> -<DL> -<DD>Set whether this validator should be triggered by the build process. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>buildValidation</CODE> - -<DT><B>Returns:</B><DD>true if the setting changed.</DL> -</DD> -</DL> -<HR> - -<A NAME="getDelegatingId()"><!-- --></A><H3> -getDelegatingId</H3> -<PRE> -public java.lang.String <B>getDelegatingId</B>()</PRE> -<DL> -<DD>Get the id of the "real" validator, that is the validator that will be called when this delegating - validator is asked to validate something. If this isn't a delegating validator answer null. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setDelegatingId(java.lang.String)"><!-- --></A><H3> -setDelegatingId</H3> -<PRE> -public void <B>setDelegatingId</B>(java.lang.String delegating)</PRE> -<DL> -<DD>Set the id of the "real" validator, that is the validator that will be called when this delegating - validator is asked to validate something. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>delegating</CODE> - the id of the validator that is actually going to perform the validation.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersion()"><!-- --></A><H3> -getVersion</H3> -<PRE> -public int <B>getVersion</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setVersion(int)"><!-- --></A><H3> -setVersion</H3> -<PRE> -public void <B>setVersion</B>(int version)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="toString()"><!-- --></A><H3> -toString</H3> -<PRE> -public java.lang.String <B>toString</B>()</PRE> -<DL> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getSourceId()"><!-- --></A><H3> -getSourceId</H3> -<PRE> -public java.lang.String <B>getSourceId</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setSourceId(java.lang.String)"><!-- --></A><H3> -setSourceId</H3> -<PRE> -public void <B>setSourceId</B>(java.lang.String sourceId)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getChangeCountGlobal()"><!-- --></A><H3> -getChangeCountGlobal</H3> -<PRE> -public int <B>getChangeCountGlobal</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="hasGlobalChanges()"><!-- --></A><H3> -hasGlobalChanges</H3> -<PRE> -public boolean <B>hasGlobalChanges</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getChangeCountMessages()"><!-- --></A><H3> -getChangeCountMessages</H3> -<PRE> -public int <B>getChangeCountMessages</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="bumpChangeCountMessages()"><!-- --></A><H3> -bumpChangeCountMessages</H3> -<PRE> -public void <B>bumpChangeCountMessages</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="resetChangeCounters()"><!-- --></A><H3> -resetChangeCounters</H3> -<PRE> -public void <B>resetChangeCounters</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="bumpChangeCountGlobal()"><!-- --></A><H3> -bumpChangeCountGlobal</H3> -<PRE> -public void <B>bumpChangeCountGlobal</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="sameConfig(org.eclipse.wst.validation.Validator)"><!-- --></A><H3> -sameConfig</H3> -<PRE> -public boolean <B>sameConfig</B>(<A HREF="../../../../org/eclipse/wst/validation/Validator.html" title="class in org.eclipse.wst.validation">Validator</A> validator)</PRE> -<DL> -<DD>Answer true if you have the same configuration settings as validator. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>validator</CODE> - this can be null.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMarkerId()"><!-- --></A><H3> -getMarkerId</H3> -<PRE> -public java.lang.String <B>getMarkerId</B>()</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setMarkerId(java.lang.String)"><!-- --></A><H3> -setMarkerId</H3> -<PRE> -public void <B>setMarkerId</B>(java.lang.String markerId)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<!-- ========= END OF CLASS DATA ========= --> -<HR> - - -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Validator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../org/eclipse/wst/validation/ValidationState.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A> - <A HREF="../../../../org/eclipse/wst/validation/Validator.Level.html" title="enum in org.eclipse.wst.validation"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/eclipse/wst/validation/Validator.html" target="_top"><B>FRAMES</B></A> - <A HREF="Validator.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> - -</BODY> -</HTML> |