blob: 8cc8eea178b94df86cdc8592c470cb5553e36f36 [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.5.0_12) on Fri May 30 11:15:46 CDT 2008 -->
<TITLE>
CorrectionEngine
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.CorrectionEngine class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="CorrectionEngine";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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/CorrectionEngine.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</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/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ElementChangedEvent.html" title="class in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/CorrectionEngine.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CorrectionEngine.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.jsdt.core</FONT>
<BR>
Class CorrectionEngine</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.CorrectionEngine</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>org.eclipse.wst.jsdt.internal.compiler.lookup.ProblemReasons</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>CorrectionEngine</B><DT>extends java.lang.Object<DT>implements org.eclipse.wst.jsdt.internal.compiler.lookup.ProblemReasons</DL>
</PRE>
<P>
This class is the entry point for source corrections.
This class is not intended to be subclassed by clients. This class is intended to be instantiated by clients.
Provisional API: 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>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.eclipse.wst.jsdt.internal.compiler.lookup.ProblemReasons"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.eclipse.wst.jsdt.internal.compiler.lookup.ProblemReasons</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>Ambiguous, IllegalSuperTypeVariable, InheritedNameHidesEnclosingName, InternalNameProvided, InvalidTypeForStaticImport, NoError, NonStaticReferenceInConstructorInvocation, NonStaticReferenceInStaticContext, NotAFunction, NotFound, NotVisible, ParameterBoundMismatch, ParameterizedMethodTypeMismatch, ReceiverTypeNotVisible, TypeArgumentsForRawGenericMethod, TypeParameterArityMismatch</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/jsdt/core/CorrectionEngine.html#CorrectionEngine(java.util.Map)">CorrectionEngine</A></B>(java.util.Map&nbsp;setting)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The CorrectionEngine is responsible for computing problem corrections.</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/jsdt/core/CorrectionEngine.html#computeCorrections(IMarker, org.eclipse.wst.jsdt.core.IJavaScriptUnit, int, org.eclipse.wst.jsdt.core.ICorrectionRequestor)">computeCorrections</A></B>(IMarker&nbsp;marker,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>&nbsp;targetUnit,
int&nbsp;positionOffset,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html" title="interface in org.eclipse.wst.jsdt.core">ICorrectionRequestor</A>&nbsp;requestor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs code correction for the given marker,
reporting results to the given correction requestor.</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/jsdt/core/CorrectionEngine.html#computeCorrections(org.eclipse.wst.jsdt.core.compiler.IProblem, org.eclipse.wst.jsdt.core.IJavaScriptUnit, org.eclipse.wst.jsdt.core.ICorrectionRequestor)">computeCorrections</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/IProblem.html" title="interface in org.eclipse.wst.jsdt.core.compiler">IProblem</A>&nbsp;problem,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>&nbsp;targetUnit,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html" title="interface in org.eclipse.wst.jsdt.core">ICorrectionRequestor</A>&nbsp;requestor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs code correction for the given IProblem,
reporting results to the given correction requestor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/CorrectionEngine.html#getAllWarningTokens()">getAllWarningTokens</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an array of strings which contains one entry per warning token
accepted by the <code>@SuppressWarnings</code> annotation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/CorrectionEngine.html#getProblemArguments(IMarker)">getProblemArguments</A></B>(IMarker&nbsp;problemMarker)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Helper method for decoding problem marker attributes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/CorrectionEngine.html#getWarningToken(int)">getWarningToken</A></B>(int&nbsp;problemID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a token which can be used to suppress a given warning using
<code>@SuppressWarnings</code> annotation, for a given problem ID
(<A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/IProblem.html" title="interface in org.eclipse.wst.jsdt.core.compiler"><CODE>IProblem</CODE></A>).</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="CorrectionEngine(java.util.Map)"><!-- --></A><H3>
CorrectionEngine</H3>
<PRE>
public <B>CorrectionEngine</B>(java.util.Map&nbsp;setting)</PRE>
<DL>
<DD>The CorrectionEngine is responsible for computing problem corrections.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>setting</CODE> - java.util.Map
set of options used to configure the code correction engine.
CURRENTLY THERE IS NO CORRECTION SPECIFIC SETTINGS.</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="computeCorrections(IMarker, org.eclipse.wst.jsdt.core.IJavaScriptUnit, int, org.eclipse.wst.jsdt.core.ICorrectionRequestor)"><!-- --></A><H3>
computeCorrections</H3>
<PRE>
public void <B>computeCorrections</B>(IMarker&nbsp;marker,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>&nbsp;targetUnit,
int&nbsp;positionOffset,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html" title="interface in org.eclipse.wst.jsdt.core">ICorrectionRequestor</A>&nbsp;requestor)
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Performs code correction for the given marker,
reporting results to the given correction requestor.
Correction results are answered through a requestor.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>marker</CODE> - the marker which describe the problem to correct.<DD><CODE>targetUnit</CODE> - replace the compilation unit given by the marker. Ignored if null.<DD><CODE>positionOffset</CODE> - the offset of position given by the marker.<DD><CODE>requestor</CODE> - the given correction requestor
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>requestor</code> is <code>null</code>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - currently this exception is never thrown, but the opportunity to thrown an exception
when the correction failed is kept for later.</DL>
</DD>
</DL>
<HR>
<A NAME="computeCorrections(org.eclipse.wst.jsdt.core.compiler.IProblem, org.eclipse.wst.jsdt.core.IJavaScriptUnit, org.eclipse.wst.jsdt.core.ICorrectionRequestor)"><!-- --></A><H3>
computeCorrections</H3>
<PRE>
public void <B>computeCorrections</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/IProblem.html" title="interface in org.eclipse.wst.jsdt.core.compiler">IProblem</A>&nbsp;problem,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>&nbsp;targetUnit,
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ICorrectionRequestor.html" title="interface in org.eclipse.wst.jsdt.core">ICorrectionRequestor</A>&nbsp;requestor)
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Performs code correction for the given IProblem,
reporting results to the given correction requestor.
Correction results are answered through a requestor.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>problem</CODE> - the problem which describe the problem to correct.<DD><CODE>targetUnit</CODE> - denote the compilation unit in which correction occurs. Cannot be null.<DD><CODE>requestor</CODE> - the given correction requestor
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>targetUnit</code> or <code>requestor</code> is <code>null</code>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - currently this exception is never thrown, but the opportunity to thrown an exception
when the correction failed is kept for later.</DL>
</DD>
</DL>
<HR>
<A NAME="getAllWarningTokens()"><!-- --></A><H3>
getAllWarningTokens</H3>
<PRE>
public static java.lang.String[] <B>getAllWarningTokens</B>()</PRE>
<DL>
<DD>Return an array of strings which contains one entry per warning token
accepted by the <code>@SuppressWarnings</code> annotation. This array is
neither null nor empty, it contains at least the String <code>all</code>.
It should not be modified by the caller (please take a copy if modifications
are needed).<br>
<b>Note:</b> The tokens returned are not necessarily standardized across JavaScript
validators. If you were to use one of these tokens in a <code>@SuppressWarnings</code>
annotation in the JavaScript source code, the effects (if any) may vary from
validator to validator.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an array of strings which contains one entry per warning token
accepted by the <code>@SuppressWarnings</code> annotation.</DL>
</DD>
</DL>
<HR>
<A NAME="getProblemArguments(IMarker)"><!-- --></A><H3>
getProblemArguments</H3>
<PRE>
public static java.lang.String[] <B>getProblemArguments</B>(IMarker&nbsp;problemMarker)</PRE>
<DL>
<DD>Helper method for decoding problem marker attributes. Returns an array of String arguments
extracted from the problem marker "arguments" attribute, or <code>null</code> if the marker
"arguments" attribute is missing or ill-formed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>problemMarker</CODE> - the problem marker to decode arguments from.
<DT><B>Returns:</B><DD>an array of String arguments, or <code>null</code> if unable to extract arguments</DL>
</DD>
</DL>
<HR>
<A NAME="getWarningToken(int)"><!-- --></A><H3>
getWarningToken</H3>
<PRE>
public static java.lang.String <B>getWarningToken</B>(int&nbsp;problemID)</PRE>
<DL>
<DD>Returns a token which can be used to suppress a given warning using
<code>@SuppressWarnings</code> annotation, for a given problem ID
(<A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/IProblem.html" title="interface in org.eclipse.wst.jsdt.core.compiler"><CODE>IProblem</CODE></A>). If a particular problem is not suppressable,
<code>null</code> will be returned.
<p>
<b>Note:</b> <code>@SuppressWarnings</code> can only suppress warnings,
which means that if some problems got promoted to ERROR using custom compiler
settings (<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html#setOption(java.lang.String, java.lang.String)"><CODE>IJavaScriptProject.setOption(String, String)</CODE></A>), the
<code>@SuppressWarnings</code> annotation will be ineffective.
</p>
<p>
<b>Note:</b> <code>@SuppressWarnings</code> can be argumented with
<code>"all"</code> so as to suppress all possible warnings at once.
</p>
<p>
<b>Note:</b> The tokens returned are not necessarily standardized across JavaScript
validators. If you were to use one of these tokens in an @SuppressWarnings
annotation in the JavaScript source code, the effects (if any) may vary from
validator to validator.
</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>problemID</CODE> - the ID of a given warning to suppress
<DT><B>Returns:</B><DD>a String which can be used in <code>@SuppressWarnings</code> annotation,
or <code>null</code> if unable to suppress this warning.</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/CorrectionEngine.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</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/jsdt/core/CompletionRequestor.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ElementChangedEvent.html" title="class in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/CorrectionEngine.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="CorrectionEngine.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>