| <!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:58 CDT 2008 --> |
| <TITLE> |
| StructuralPropertyDescriptor |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.dom.StructuralPropertyDescriptor class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="StructuralPropertyDescriptor"; |
| } |
| </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/StructuralPropertyDescriptor.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/StringLiteral.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SuperConstructorInvocation.html" title="class 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/StructuralPropertyDescriptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StructuralPropertyDescriptor.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.jsdt.core.dom</FONT> |
| <BR> |
| Class StructuralPropertyDescriptor</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.dom.StructuralPropertyDescriptor</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildListPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">ChildListPropertyDescriptor</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">ChildPropertyDescriptor</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimplePropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">SimplePropertyDescriptor</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>StructuralPropertyDescriptor</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Abstract base class for property descriptors of AST nodes. |
| There are three kinds of properties: |
| <ul> |
| <li>simple properties (<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimplePropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>SimplePropertyDescriptor</CODE></A>) |
| - properties where the value is a primitive (int, boolean) |
| or simple (String, InfixExprsssion.Operator) type other than an |
| AST node; for example, the identifier of a <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimpleName.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>SimpleName</CODE></A></li> |
| <li>child properties (<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>ChildPropertyDescriptor</CODE></A>) |
| - properties whose value is another AST node; |
| for example, the name of a <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/FunctionDeclaration.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>FunctionDeclaration</CODE></A></li> |
| <li>child list properties (<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildListPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>ChildListPropertyDescriptor</CODE></A>) |
| - properties where the value is a list of AST nodes; |
| for example, the statements of a <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Block.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>Block</CODE></A></li> |
| </ul> |
| |
| 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> |
| |
| <!-- ========== 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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/StructuralPropertyDescriptor.html#getId()">getId</A></B>()</CODE> |
| |
| <BR> |
| Returns the id of this property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/StructuralPropertyDescriptor.html#getNodeClass()">getNodeClass</A></B>()</CODE> |
| |
| <BR> |
| Returns the AST node type that owns this property.</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/StructuralPropertyDescriptor.html#isChildListProperty()">isChildListProperty</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this property is a child list property |
| (instance of <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildListPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>ChildListPropertyDescriptor</CODE></A>.</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/StructuralPropertyDescriptor.html#isChildProperty()">isChildProperty</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this property is a child property |
| (instance of <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>ChildPropertyDescriptor</CODE></A>.</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/StructuralPropertyDescriptor.html#isSimpleProperty()">isSimpleProperty</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this property is a simple property |
| (instance of <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimplePropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>SimplePropertyDescriptor</CODE></A>.</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/StructuralPropertyDescriptor.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| Returns a string suitable for debug purposes.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="getId()"><!-- --></A><H3> |
| getId</H3> |
| <PRE> |
| public final java.lang.String <B>getId</B>()</PRE> |
| <DL> |
| <DD>Returns the id of this property. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the property id</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNodeClass()"><!-- --></A><H3> |
| getNodeClass</H3> |
| <PRE> |
| public final java.lang.Class <B>getNodeClass</B>()</PRE> |
| <DL> |
| <DD>Returns the AST node type that owns this property. |
| <p> |
| For example, for all properties of the node type |
| TypeDeclaration, this method returns <code>TypeDeclaration.class</code>. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the node type that owns this property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSimpleProperty()"><!-- --></A><H3> |
| isSimpleProperty</H3> |
| <PRE> |
| public final boolean <B>isSimpleProperty</B>()</PRE> |
| <DL> |
| <DD>Returns whether this property is a simple property |
| (instance of <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimplePropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>SimplePropertyDescriptor</CODE></A>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this is a simple property, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isChildProperty()"><!-- --></A><H3> |
| isChildProperty</H3> |
| <PRE> |
| public final boolean <B>isChildProperty</B>()</PRE> |
| <DL> |
| <DD>Returns whether this property is a child property |
| (instance of <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>ChildPropertyDescriptor</CODE></A>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this is a child property, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isChildListProperty()"><!-- --></A><H3> |
| isChildListProperty</H3> |
| <PRE> |
| public final boolean <B>isChildListProperty</B>()</PRE> |
| <DL> |
| <DD>Returns whether this property is a child list property |
| (instance of <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildListPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>ChildListPropertyDescriptor</CODE></A>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this is a child list property, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD>Returns a string suitable for debug purposes. |
| <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></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/StructuralPropertyDescriptor.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/StringLiteral.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SuperConstructorInvocation.html" title="class 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/StructuralPropertyDescriptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StructuralPropertyDescriptor.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> |
