| <!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:56 CDT 2008 --> |
| <TITLE> |
| IBinding |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.dom.IBinding interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IBinding"; |
| } |
| </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> </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/IBinding.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</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/jsdt/core/dom/FunctionRefParameter.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IExtendedModifier.html" title="interface in org.eclipse.wst.jsdt.core.dom"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/dom/IBinding.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IBinding.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | 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.jsdt.core.dom</FONT> |
| <BR> |
| Interface IBinding</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IFunctionBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">IFunctionBinding</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IMemberValuePairBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">IMemberValuePairBinding</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IPackageBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">IPackageBinding</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ITypeBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">ITypeBinding</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IVariableBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">IVariableBinding</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IBinding</B></DL> |
| </PRE> |
| |
| <P> |
| A binding represents a named entity in the JavaScript language. The world of |
| bindings provides an integrated picture of the structure of the program as |
| seen from the compiler's point of view. This interface declare protocol |
| common to the various different kinds of named entities in the JavaScript language: |
| packages, types, fields, methods, constructors, and local variables. |
| <p> |
| This interface is not intended to be implemented by clients. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IPackageBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>IPackageBinding</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ITypeBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>ITypeBinding</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IVariableBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>IVariableBinding</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IFunctionBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>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.</CODE></A></DL> |
| <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> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#METHOD">METHOD</A></B></CODE> |
| |
| <BR> |
| Kind constant (value 4) indicating a method or constructor binding.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#PACKAGE">PACKAGE</A></B></CODE> |
| |
| <BR> |
| Kind constant (value 1) indicating a package binding.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#TYPE">TYPE</A></B></CODE> |
| |
| <BR> |
| Kind constant (value 2) indicating a type binding.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#VARIABLE">VARIABLE</A></B></CODE> |
| |
| <BR> |
| Kind constant (value 3) indicating a field or local variable binding.</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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE> |
| |
| <BR> |
| There is no special definition of equality for bindings; equality is |
| simply object identity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#getJavaElement()">getJavaElement</A></B>()</CODE> |
| |
| <BR> |
| Returns the JavaScript element that corresponds to this binding.</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/jsdt/core/dom/IBinding.html#getKey()">getKey</A></B>()</CODE> |
| |
| <BR> |
| Returns the key for this binding.</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/jsdt/core/dom/IBinding.html#getKind()">getKind</A></B>()</CODE> |
| |
| <BR> |
| Returns the kind of bindings this is.</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/jsdt/core/dom/IBinding.html#getModifiers()">getModifiers</A></B>()</CODE> |
| |
| <BR> |
| Returns the modifiers for this binding.</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/jsdt/core/dom/IBinding.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of this binding.</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/jsdt/core/dom/IBinding.html#isDeprecated()">isDeprecated</A></B>()</CODE> |
| |
| <BR> |
| Return whether this binding is for something that is deprecated.</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/jsdt/core/dom/IBinding.html#isEqualTo(org.eclipse.wst.jsdt.core.dom.IBinding)">isEqualTo</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">IBinding</A> binding)</CODE> |
| |
| <BR> |
| Returns whether this binding has the same key as that of the given |
| binding.</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/jsdt/core/dom/IBinding.html#isRecovered()">isRecovered</A></B>()</CODE> |
| |
| <BR> |
| Return whether this binding is created because the bindings recovery is enabled.</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/jsdt/core/dom/IBinding.html#isSynthetic()">isSynthetic</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this binding is synthetic.</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/jsdt/core/dom/IBinding.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| Returns a string representation of this binding suitable for debugging |
| purposes only.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="PACKAGE"><!-- --></A><H3> |
| PACKAGE</H3> |
| <PRE> |
| static final int <B>PACKAGE</B></PRE> |
| <DL> |
| <DD>Kind constant (value 1) indicating a package binding. |
| Bindings of this kind can be safely cast to <code>IPackageBinding</code>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#getKind()"><CODE>getKind()</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IPackageBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>IPackageBinding</CODE></A>, |
| <A HREF="../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.dom.IBinding.PACKAGE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TYPE"><!-- --></A><H3> |
| TYPE</H3> |
| <PRE> |
| static final int <B>TYPE</B></PRE> |
| <DL> |
| <DD>Kind constant (value 2) indicating a type binding. |
| Bindings of this kind can be safely cast to <code>ITypeBinding</code>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#getKind()"><CODE>getKind()</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ITypeBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>ITypeBinding</CODE></A>, |
| <A HREF="../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.dom.IBinding.TYPE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="VARIABLE"><!-- --></A><H3> |
| VARIABLE</H3> |
| <PRE> |
| static final int <B>VARIABLE</B></PRE> |
| <DL> |
| <DD>Kind constant (value 3) indicating a field or local variable binding. |
| Bindings of this kind can be safely cast to <code>IVariableBinding</code>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#getKind()"><CODE>getKind()</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IVariableBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>IVariableBinding</CODE></A>, |
| <A HREF="../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.dom.IBinding.VARIABLE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="METHOD"><!-- --></A><H3> |
| METHOD</H3> |
| <PRE> |
| static final int <B>METHOD</B></PRE> |
| <DL> |
| <DD>Kind constant (value 4) indicating a method or constructor binding. |
| Bindings of this kind can be safely cast to <code>IFunctionBinding</code>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#getKind()"><CODE>getKind()</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IFunctionBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom"><CODE>IFunctionBinding</CODE></A>, |
| <A HREF="../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.dom.IBinding.METHOD">Constant Field Values</A></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="getKind()"><!-- --></A><H3> |
| getKind</H3> |
| <PRE> |
| int <B>getKind</B>()</PRE> |
| <DL> |
| <DD>Returns the kind of bindings this is. That is one of the kind constants: |
| <code>PACKAGE</code>, |
| <code>TYPE</code>, |
| <code>VARIABLE</code>, |
| <code>METHOD</code>, |
| <code>ANNOTATION</code>, |
| or <code>MEMBER_VALUE_PAIR</code>. |
| <p> |
| Note that additional kinds might be added in the |
| future, so clients should not assume this list is exhaustive and |
| should program defensively, e.g. by having a reasonable default |
| in a switch statement. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>one of the kind constants</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| java.lang.String <B>getName</B>()</PRE> |
| <DL> |
| <DD>Returns the name of this binding. |
| Details of the name are specified with each specific kind of binding. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of this binding</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getModifiers()"><!-- --></A><H3> |
| getModifiers</H3> |
| <PRE> |
| int <B>getModifiers</B>()</PRE> |
| <DL> |
| <DD>Returns the modifiers for this binding. |
| <p> |
| Note that deprecated is not included among the modifiers. |
| Use <code>isDeprecated</code> to find out whether a binding is deprecated. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the bit-wise or of <code>Modifier</code> constants<DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Modifier.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>Modifier</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDeprecated()"><!-- --></A><H3> |
| isDeprecated</H3> |
| <PRE> |
| boolean <B>isDeprecated</B>()</PRE> |
| <DL> |
| <DD>Return whether this binding is for something that is deprecated. |
| A deprecated class, interface, field, method, or constructor is one that |
| is marked with the 'deprecated' tag in its jsdoc comment. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this binding is deprecated, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isRecovered()"><!-- --></A><H3> |
| isRecovered</H3> |
| <PRE> |
| boolean <B>isRecovered</B>()</PRE> |
| <DL> |
| <DD>Return whether this binding is created because the bindings recovery is enabled. This binding is considered |
| to be incomplete. Its internal state might be incomplete. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this binding is a recovered binding, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSynthetic()"><!-- --></A><H3> |
| isSynthetic</H3> |
| <PRE> |
| boolean <B>isSynthetic</B>()</PRE> |
| <DL> |
| <DD>Returns whether this binding is synthetic. A synthetic binding is one that |
| was made up by the compiler, rather than something declared in the |
| source code. Note that default constructors (the 0-argument constructor that |
| the validator generates for class declarations with no explicit constructors |
| declarations) are not generally considered synthetic (although they |
| may be if the class itself is synthetic). |
| But see <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IFunctionBinding.html#isDefaultConstructor()"><CODE>IFunctionBinding.isDefaultConstructor</CODE></A> |
| for cases where the compiled-generated default constructor can be recognized |
| instead. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this binding is synthetic, and |
| <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IFunctionBinding.html#isDefaultConstructor()"><CODE>IFunctionBinding.isDefaultConstructor()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getJavaElement()"><!-- --></A><H3> |
| getJavaElement</H3> |
| <PRE> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> <B>getJavaElement</B>()</PRE> |
| <DL> |
| <DD>Returns the JavaScript element that corresponds to this binding. |
| Returns <code>null</code> if this binding has no corresponding |
| JavaScript element. |
| <p> |
| For array types, this method returns the JavaScript element that corresponds |
| to the array's element type. For raw and parameterized types, this method |
| returns the JavaScript element of the erasure. For annotations, this methods |
| returns the JavaScript element of the annotation type. |
| </p> |
| <p> |
| Here are the cases where a <code>null</code> should be expected: |
| <ul> |
| <li>primitive types, including void</li> |
| <li>null type</li> |
| <li>wildcard types</li> |
| <li>capture types</li> |
| <li>array types of any of the above</li> |
| <li>the "length" field of an array type</li> |
| <li>the default constructor of a source class</li> |
| <li>the constructor of an anonymous class</li> |
| <li>member value pairs</li> |
| </ul> |
| For all other kind of type, method, variable, annotation and package bindings, |
| this method returns non-<code>null</code>. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the JavaScript element that corresponds to this binding, |
| or <code>null</code> if none</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKey()"><!-- --></A><H3> |
| getKey</H3> |
| <PRE> |
| java.lang.String <B>getKey</B>()</PRE> |
| <DL> |
| <DD>Returns the key for this binding. |
| <p> |
| Within a connected cluster of bindings (for example, all bindings |
| reachable from a given AST), each binding will have a distinct keys. |
| The keys are generated in a manner that is predictable and as |
| stable as possible. This last property makes these keys useful for |
| comparing bindings between disconnected clusters of bindings (for example, |
| the bindings between the "before" and "after" ASTs of the same |
| javaScript unit). |
| </p> |
| <p> |
| The exact details of how the keys are generated is unspecified. |
| However, it is a function of the following information: |
| <ul> |
| <li>packages - the name of the package (for an unnamed package, |
| some internal id)</li> |
| <li>classes or interfaces - the VM name of the type and the key |
| of its package</li> |
| <li>array types - the key of the component type and number of |
| dimensions</li> |
| <li>primitive types - the name of the primitive type</li> |
| <li>fields - the name of the field and the key of its declaring |
| type</li> |
| <li>methods - the name of the method, the key of its declaring |
| type, and the keys of the parameter types</li> |
| <li>constructors - the key of its declaring class, and the |
| keys of the parameter types</li> |
| <li>local variables - the name of the local variable, the index of the |
| declaring block relative to its parent, the key of its method</li> |
| <li>local types - the name of the type, the index of the declaring |
| block relative to its parent, the key of its method</li> |
| <li>anonymous types - the occurence count of the anonymous |
| type relative to its declaring type, the key of its declaring type</li> |
| <li>enum types - treated like classes</li> |
| <li>annotation types - treated like interfaces</li> |
| <li>type variables - the name of the type variable and |
| the key of the generic type or generic method that declares that |
| type variable</li> |
| <li>wildcard types - the key of the optional wildcard type bound</li> |
| <li>capture type bindings - the key of the wildcard captured</li> |
| <li>generic type instances - the key of the generic type and the keys |
| of the type arguments used to instantiate it, and whether the |
| instance is explicit (a parameterized type reference) or |
| implicit (a raw type reference)</li> |
| <li>generic method instances - the key of the generic method and the keys |
| of the type arguments used to instantiate it, and whether the |
| instance is explicit (a parameterized method reference) or |
| implicit (a raw method reference)</li> |
| <li>members of generic type instances - the key of the generic type |
| instance and the key of the corresponding member in the generic |
| type</li> |
| </ul> |
| </p> |
| <p>Note that the key for annotation bindings and member value pair bindings is |
| not yet implemented. This returns <code>null</code> for these 2 kinds of bindings.<br> |
| Recovered bindings have a unique key. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the key for this binding</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
| equals</H3> |
| <PRE> |
| boolean <B>equals</B>(java.lang.Object obj)</PRE> |
| <DL> |
| <DD>There is no special definition of equality for bindings; equality is |
| simply object identity. Within the context of a single cluster of |
| bindings, each binding is represented by a distinct object. However, |
| between different clusters of bindings, the binding objects may or may |
| not be different; in these cases, the client should compare bindings |
| using <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#isEqualTo(org.eclipse.wst.jsdt.core.dom.IBinding)"><CODE>isEqualTo(IBinding)</CODE></A>, which checks their keys. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isEqualTo(org.eclipse.wst.jsdt.core.dom.IBinding)"><!-- --></A><H3> |
| isEqualTo</H3> |
| <PRE> |
| boolean <B>isEqualTo</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html" title="interface in org.eclipse.wst.jsdt.core.dom">IBinding</A> binding)</PRE> |
| <DL> |
| <DD>Returns whether this binding has the same key as that of the given |
| binding. Within the context of a single cluster of bindings, each |
| binding is represented by a distinct object. However, between |
| different clusters of bindings, the binding objects may or may |
| not be different objects; in these cases, the binding keys |
| are used where available. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>binding</CODE> - the other binding, or <code>null</code> |
| <DT><B>Returns:</B><DD><code>true</code> if the given binding is the identical |
| object as this binding, or if the keys of both bindings are the |
| same string; <code>false</code> if the given binding is |
| <code>null</code>, or if the bindings do not have the same key, |
| or if one or both of the bindings have no key<DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IBinding.html#getKey()"><CODE>getKey()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD>Returns a string representation of this binding suitable for debugging |
| purposes only. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a debug string</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/IBinding.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</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="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</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/jsdt/core/dom/FunctionRefParameter.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/IExtendedModifier.html" title="interface in org.eclipse.wst.jsdt.core.dom"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/dom/IBinding.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IBinding.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
