blob: 15272b734d12008668c09f78f23c3f38b18f7c2c [file] [log] [blame]
<!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:54 EDT 2008 -->
<TITLE>
ValidationResult
</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="ValidationResult";
}
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ValidationResult.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/eclipse/wst/validation/ValidationFramework.ResourceAdder.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/eclipse/wst/validation/ValidationResults.html" title="class 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/ValidationResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ValidationResult.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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 ValidationResult</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.validation.ValidationResult</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>ValidationResult</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
The result of running a validate operation. Validators create and return this objects as part of
performing their validation.
<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>
<!-- ======== 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/ValidationResult.html#ValidationResult()">ValidationResult</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#add(org.eclipse.wst.validation.ValidatorMessage)">add</A></B>(<A HREF="../../../../org/eclipse/wst/validation/ValidatorMessage.html" title="class in org.eclipse.wst.validation">ValidatorMessage</A>&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is an optional method, that a validator can use to return error
messages.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IResource[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getDependsOn()">getDependsOn</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer the resources that the validated resource depends on.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/eclipse/wst/validation/ValidatorMessage.html" title="class in org.eclipse.wst.validation">ValidatorMessage</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getMessages()">getMessages</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer any validation messages that were added by the validator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getNumberOfValidatedResources()">getNumberOfValidatedResources</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer the number of resources that have been validated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getReporter(IProgressMonitor)">getReporter</A></B>(IProgressMonitor&nbsp;monitor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer an IReporter for handing error messages.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getSeverityError()">getSeverityError</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer the number of error messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getSeverityInfo()">getSeverityInfo</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer the number of informational messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getSeverityWarning()">getSeverityWarning</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer the number of warning messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IProject</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getSuspendValidation()">getSuspendValidation</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Answer the project that the validator would like to have suspended.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;IResource[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getValidated()">getValidated</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.eclipse.wst.validation.internal.core.ValidationException</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getValidationException()">getValidationException</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the validation ended with an exception, answer it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#incrementError(int)">incrementError</A></B>(int&nbsp;errors)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increment the number of error messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#incrementInfo(int)">incrementInfo</A></B>(int&nbsp;info)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increment the number of informational messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#incrementWarning(int)">incrementWarning</A></B>(int&nbsp;warnings)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increment the number of warning messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#isCanceled()">isCanceled</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Was the operation canceled before it completed?</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#mergeResults(org.eclipse.wst.validation.ValidationResult)">mergeResults</A></B>(<A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation">ValidationResult</A>&nbsp;result)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Merge the message counts and messages from an individual validator into this result.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setCanceled(boolean)">setCanceled</A></B>(boolean&nbsp;canceled)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate if the operation was canceled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setDependsOn(IResource[])">setDependsOn</A></B>(IResource[]&nbsp;dependsOn)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Update the resources that the validated resource depends on.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setSeverityError(int)">setSeverityError</A></B>(int&nbsp;severityError)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the number of error messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setSeverityInfo(int)">setSeverityInfo</A></B>(int&nbsp;severityInfo)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the number of informational messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setSeverityWarning(int)">setSeverityWarning</A></B>(int&nbsp;severityWarning)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the number of warning messages that were generated as part of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setSuspendValidation(IProject)">setSuspendValidation</A></B>(IProject&nbsp;project)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calling this method will inform the framework, that this validator does not wish to be
called again for any resources in this project, for the duration of this validation operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setValidated(IResource[])">setValidated</A></B>(IResource[]&nbsp;validated)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate that additional resources have been validated as part of this
validate operation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#setValidationException(org.eclipse.wst.validation.internal.core.ValidationException)">setValidationException</A></B>(org.eclipse.wst.validation.internal.core.ValidationException&nbsp;validationException)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the validation failed with an exception, it can be recorded here.</TD>
</TR>
</TABLE>
&nbsp;<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, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="ValidationResult()"><!-- --></A><H3>
ValidationResult</H3>
<PRE>
public <B>ValidationResult</B>()</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="add(org.eclipse.wst.validation.ValidatorMessage)"><!-- --></A><H3>
add</H3>
<PRE>
public void <B>add</B>(<A HREF="../../../../org/eclipse/wst/validation/ValidatorMessage.html" title="class in org.eclipse.wst.validation">ValidatorMessage</A>&nbsp;message)</PRE>
<DL>
<DD>This is an optional method, that a validator can use to return error
messages. The validation framework converts these into IMarkers.
<p>
The scenario that motivated this method, is when a validator is used both
for <b>as you type</b> validation and <b>build</b> validation. When
called in as you type mode, the validator doesn't want to directly create IMarkers,
because the resource hasn't been saved yet. It needs to return something
other than an IMarker. But when called in build mode, it does ultimately
want IMarkers. By returning ValidatorMessages, it only needs to return
one type of message, and those messages can be either be directly used by
the caller, or automatically converted into IMarkers by the validation
framework.
<p>
To make matters even more complicated there is a third way to return
messages. To make it easier for old validators to port to the new
framework, they can continue to use an IReporter. If a validator calls
the getReporter() method then it is assumed by the framework that that is
the approach that they have chosen.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - A validation message.<DT><B>See Also:</B><DD><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#getReporter(IProgressMonitor)"><CODE>getReporter(IProgressMonitor)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getReporter(IProgressMonitor)"><!-- --></A><H3>
getReporter</H3>
<PRE>
public <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A> <B>getReporter</B>(IProgressMonitor&nbsp;monitor)</PRE>
<DL>
<DD>Answer an IReporter for handing error messages.
<p>
This is a transition method, to help old validators port to the new validation framework. If this method
is called it is assumed by the framework, that this IReporter will be used as the only way of passing messages
back to the framework.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>monitor</CODE> - <DT><B>See Also:</B><DD><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html#add(org.eclipse.wst.validation.ValidatorMessage)"><CODE>add(ValidatorMessage)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="mergeResults(org.eclipse.wst.validation.ValidationResult)"><!-- --></A><H3>
mergeResults</H3>
<PRE>
public void <B>mergeResults</B>(<A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation">ValidationResult</A>&nbsp;result)</PRE>
<DL>
<DD>Merge the message counts and messages from an individual validator into this result.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>result</CODE> - it can be null, in which case it is ignored.</DL>
</DD>
</DL>
<HR>
<A NAME="getDependsOn()"><!-- --></A><H3>
getDependsOn</H3>
<PRE>
public IResource[] <B>getDependsOn</B>()</PRE>
<DL>
<DD>Answer the resources that the validated resource depends on.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMessages()"><!-- --></A><H3>
getMessages</H3>
<PRE>
public <A HREF="../../../../org/eclipse/wst/validation/ValidatorMessage.html" title="class in org.eclipse.wst.validation">ValidatorMessage</A>[] <B>getMessages</B>()</PRE>
<DL>
<DD>Answer any validation messages that were added by the validator.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array is returned even if there are no messages.</DL>
</DD>
</DL>
<HR>
<A NAME="setDependsOn(IResource[])"><!-- --></A><H3>
setDependsOn</H3>
<PRE>
public void <B>setDependsOn</B>(IResource[]&nbsp;dependsOn)</PRE>
<DL>
<DD>Update the resources that the validated resource depends on. This can be
left null. For example, a XML file may depend on a XSD file in order to
know if it is valid or not. It would pass back that XSD file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dependsOn</CODE> - If this is null then the dependency information is not updated. To
remove the dependency information, an empty array needs to be
supplied. A non null parameter, <b>replaces</b> all the dependency
information for this resource, for this validator.</DL>
</DD>
</DL>
<HR>
<A NAME="getValidated()"><!-- --></A><H3>
getValidated</H3>
<PRE>
public IResource[] <B>getValidated</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>All the resources that were validated as a side-effect of
validating the main resource, or null if none were.</DL>
</DD>
</DL>
<HR>
<A NAME="setValidated(IResource[])"><!-- --></A><H3>
setValidated</H3>
<PRE>
public void <B>setValidated</B>(IResource[]&nbsp;validated)</PRE>
<DL>
<DD>Indicate that additional resources have been validated as part of this
validate operation. Sometimes in the course of performing a validation on
one resource it is necessary to validate other resources as well. This
method is used to let the framework know about these additional validated
resources, to possibly save them being validated redundantly.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>validated</CODE> - Any additional resources that were validated.</DL>
</DD>
</DL>
<HR>
<A NAME="getSeverityError()"><!-- --></A><H3>
getSeverityError</H3>
<PRE>
public int <B>getSeverityError</B>()</PRE>
<DL>
<DD>Answer the number of error messages that were generated as part of this validation operation.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSeverityError(int)"><!-- --></A><H3>
setSeverityError</H3>
<PRE>
public void <B>setSeverityError</B>(int&nbsp;severityError)</PRE>
<DL>
<DD>Set the number of error messages that were generated as part of this validation operation.
<p>
Messages added through the add(ValidationMessage) method should not be included here, as this
information will be determined from the ValidationMessage.
</p>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="incrementError(int)"><!-- --></A><H3>
incrementError</H3>
<PRE>
public int <B>incrementError</B>(int&nbsp;errors)</PRE>
<DL>
<DD>Increment the number of error messages that were generated as part of this validation operation.
<p>
Messages added through the add(ValidationMessage) method should not be included here, as this
information will be determined from the ValidationMessage.
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the current number of errors.</DL>
</DD>
</DL>
<HR>
<A NAME="getSeverityWarning()"><!-- --></A><H3>
getSeverityWarning</H3>
<PRE>
public int <B>getSeverityWarning</B>()</PRE>
<DL>
<DD>Answer the number of warning messages that were generated as part of this validation operation.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSeverityWarning(int)"><!-- --></A><H3>
setSeverityWarning</H3>
<PRE>
public void <B>setSeverityWarning</B>(int&nbsp;severityWarning)</PRE>
<DL>
<DD>Set the number of warning messages that were generated as part of this validation operation.
<p>
Messages added through the add(ValidationMessage) method should not be included here, as this
information will be determined from the ValidationMessage.
</p>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="incrementWarning(int)"><!-- --></A><H3>
incrementWarning</H3>
<PRE>
public int <B>incrementWarning</B>(int&nbsp;warnings)</PRE>
<DL>
<DD>Increment the number of warning messages that were generated as part of this validation operation.
<p>
Messages added through the add(ValidationMessage) method should not be included here, as this
information will be determined from the ValidationMessage.
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the current number of warnings.</DL>
</DD>
</DL>
<HR>
<A NAME="getSeverityInfo()"><!-- --></A><H3>
getSeverityInfo</H3>
<PRE>
public int <B>getSeverityInfo</B>()</PRE>
<DL>
<DD>Answer the number of informational messages that were generated as part of this validation operation.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSeverityInfo(int)"><!-- --></A><H3>
setSeverityInfo</H3>
<PRE>
public void <B>setSeverityInfo</B>(int&nbsp;severityInfo)</PRE>
<DL>
<DD>Set the number of informational messages that were generated as part of this validation operation.
<p>
Messages added through the add(ValidationMessage) method should not be included here, as this
information will be determined from the ValidationMessage.
</p>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="incrementInfo(int)"><!-- --></A><H3>
incrementInfo</H3>
<PRE>
public int <B>incrementInfo</B>(int&nbsp;info)</PRE>
<DL>
<DD>Increment the number of informational messages that were generated as part of this validation operation.
<p>
Messages added through the add(ValidationMessage) method should not be included here, as this
information will be determined from the ValidationMessage.
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the current number of informational message.</DL>
</DD>
</DL>
<HR>
<A NAME="isCanceled()"><!-- --></A><H3>
isCanceled</H3>
<PRE>
public boolean <B>isCanceled</B>()</PRE>
<DL>
<DD>Was the operation canceled before it completed? For example if the validation is being run through the
user interface, the end user can cancel the operation through the progress monitor.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the operation was canceled</DL>
</DD>
</DL>
<HR>
<A NAME="setCanceled(boolean)"><!-- --></A><H3>
setCanceled</H3>
<PRE>
public void <B>setCanceled</B>(boolean&nbsp;canceled)</PRE>
<DL>
<DD>Indicate if the operation was canceled.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>canceled</CODE> - Set to true if it was canceled and false if it was not canceled.</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberOfValidatedResources()"><!-- --></A><H3>
getNumberOfValidatedResources</H3>
<PRE>
public int <B>getNumberOfValidatedResources</B>()</PRE>
<DL>
<DD>Answer the number of resources that have been validated.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValidationException()"><!-- --></A><H3>
getValidationException</H3>
<PRE>
public org.eclipse.wst.validation.internal.core.ValidationException <B>getValidationException</B>()</PRE>
<DL>
<DD>If the validation ended with an exception, answer it.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>null if the validator did not finish with an exception.</DL>
</DD>
</DL>
<HR>
<A NAME="setValidationException(org.eclipse.wst.validation.internal.core.ValidationException)"><!-- --></A><H3>
setValidationException</H3>
<PRE>
public void <B>setValidationException</B>(org.eclipse.wst.validation.internal.core.ValidationException&nbsp;validationException)</PRE>
<DL>
<DD>If the validation failed with an exception, it can be recorded here.
<p>
This method is provided for old validators to ease their transition to the new framework.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>validationException</CODE> - </DL>
</DD>
</DL>
<HR>
<A NAME="getSuspendValidation()"><!-- --></A><H3>
getSuspendValidation</H3>
<PRE>
public IProject <B>getSuspendValidation</B>()</PRE>
<DL>
<DD>Answer the project that the validator would like to have suspended.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the project to suspend or null. The normal result is null, which means that
the validator wishes to receive normal validation requests.</DL>
</DD>
</DL>
<HR>
<A NAME="setSuspendValidation(IProject)"><!-- --></A><H3>
setSuspendValidation</H3>
<PRE>
public void <B>setSuspendValidation</B>(IProject&nbsp;project)</PRE>
<DL>
<DD>Calling this method will inform the framework, that this validator does not wish to be
called again for any resources in this project, for the duration of this validation operation.
<p>
Some validators may have a rich set of triggers, but once they have been invoked once,
do not need to be invoked again during the course of the current validation.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project that this validator no longer wants to be notified on.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ValidationResult.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/eclipse/wst/validation/ValidationFramework.ResourceAdder.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/eclipse/wst/validation/ValidationResults.html" title="class 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/ValidationResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ValidationResult.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>