diff options
Diffstat (limited to 'docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/internal/provisional/core/IValidator.html')
-rw-r--r-- | docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/internal/provisional/core/IValidator.html | 264 |
1 files changed, 0 insertions, 264 deletions
diff --git a/docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/internal/provisional/core/IValidator.html b/docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/internal/provisional/core/IValidator.html deleted file mode 100644 index d24cd04db..000000000 --- a/docs/org.eclipse.wst.validation.doc.isv/reference/api/org/eclipse/wst/validation/internal/provisional/core/IValidator.html +++ /dev/null @@ -1,264 +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 May 20 09:50:55 EDT 2008 --> -<TITLE> -IValidator -</TITLE> - -<META NAME="date" CONTENT="2008-05-20"> - -<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="IValidator"; - } -} -</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/IValidator.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/internal/provisional/core/IValidationContext.html" title="interface in org.eclipse.wst.validation.internal.provisional.core"><B>PREV CLASS</B></A> - <A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IValidatorJob.html" title="interface in org.eclipse.wst.validation.internal.provisional.core"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../../../index.html?org/eclipse/wst/validation/internal/provisional/core/IValidator.html" target="_top"><B>FRAMES</B></A> - <A HREF="IValidator.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <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.internal.provisional.core</FONT> -<BR> -Interface IValidator</H2> -<DL> -<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IValidatorJob.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidatorJob</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <B>IValidator</B></DL> -</PRE> - -<P> -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. - <p> - A validator can perform full validation or incremental validation. All validators must implement - full validation but incremental validation is optional. - </p> - <p> - Each validator must not be tied to any particular workbench implementation. - </p> - <p> - A validator's verification starts when the ValidatorLauncher singleton calls - <code>validate</code>. - </p> - <p> - <b>Provisional API:</b> This class/interface is part of an interim API that is still under development and expected to - change significantly before reaching stability. It is being made available at this early stage to solicit feedback - from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken - (repeatedly) as the API evolves. - </p> -<P> - -<P> -<HR> - -<P> - -<!-- ========== 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> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html#cleanup(org.eclipse.wst.validation.internal.provisional.core.IReporter)">cleanup</A></B>(<A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A> reporter)</CODE> - -<BR> - Perform any resource cleanup once 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/internal/provisional/core/IValidator.html#validate(org.eclipse.wst.validation.internal.provisional.core.IValidationContext, org.eclipse.wst.validation.internal.provisional.core.IReporter)">validate</A></B>(<A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IValidationContext.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidationContext</A> helper, - <A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A> reporter)</CODE> - -<BR> - This is the method which performs the validation on the objects.</TD> -</TR> -</TABLE> - -<P> - -<!-- ============ 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="cleanup(org.eclipse.wst.validation.internal.provisional.core.IReporter)"><!-- --></A><H3> -cleanup</H3> -<PRE> -void <B>cleanup</B>(<A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A> reporter)</PRE> -<DL> -<DD>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> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>reporter</CODE> - Used for the interaction with the user.</DL> -</DD> -</DL> -<HR> - -<A NAME="validate(org.eclipse.wst.validation.internal.provisional.core.IValidationContext, org.eclipse.wst.validation.internal.provisional.core.IReporter)"><!-- --></A><H3> -validate</H3> -<PRE> -void <B>validate</B>(<A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IValidationContext.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidationContext</A> helper, - <A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A> reporter) - throws org.eclipse.wst.validation.internal.core.ValidationException</PRE> -<DL> -<DD>This is the method which performs the validation on the objects. - <p> - <code>helper</code> and <code>reporter</code> may not be null. <code>changedFiles</code> - may be null, if a full build is desired. <br> - </p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>helper</CODE> - Loads an object.<DD><CODE>reporter</CODE> - Is an instance of an IReporter interface, which is used for interaction with the user. -<DT><B>Throws:</B> -<DD><CODE>org.eclipse.wst.validation.internal.core.ValidationException</CODE></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/IValidator.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/internal/provisional/core/IValidationContext.html" title="interface in org.eclipse.wst.validation.internal.provisional.core"><B>PREV CLASS</B></A> - <A HREF="../../../../../../../org/eclipse/wst/validation/internal/provisional/core/IValidatorJob.html" title="interface in org.eclipse.wst.validation.internal.provisional.core"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../../../../index.html?org/eclipse/wst/validation/internal/provisional/core/IValidator.html" target="_top"><B>FRAMES</B></A> - <A HREF="IValidator.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> - -</BODY> -</HTML> |