blob: 1fb297defd248551da927e47ec1f13b2f5752644 [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:16:01 CDT 2008 -->
<TITLE>
TypeDeclarationMatch
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.search.TypeDeclarationMatch class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="TypeDeclarationMatch";
}
</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/TypeDeclarationMatch.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/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/search/TypeDeclarationMatch.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="TypeDeclarationMatch.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;<A HREF="#fields_inherited_from_class_org.eclipse.wst.jsdt.core.search.SearchMatch">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_org.eclipse.wst.jsdt.core.search.SearchMatch">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;METHOD</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.search</FONT>
<BR>
Class TypeDeclarationMatch</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html" title="class in org.eclipse.wst.jsdt.core.search">org.eclipse.wst.jsdt.core.search.SearchMatch</A>
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.search.TypeDeclarationMatch</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>TypeDeclarationMatch</B><DT>extends <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html" title="class in org.eclipse.wst.jsdt.core.search">SearchMatch</A></DL>
</PRE>
<P>
A JavaScript search match that represents a type declaration.
The element is an <code>IType</code>.
<p>
This class is intended to be instantiated and subclassed by clients.
</p>
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.core.search.SearchMatch"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.eclipse.wst.jsdt.core.search.<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html" title="class in org.eclipse.wst.jsdt.core.search">SearchMatch</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#A_ACCURATE">A_ACCURATE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#A_INACCURATE">A_INACCURATE</A></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/search/TypeDeclarationMatch.html#TypeDeclarationMatch(org.eclipse.wst.jsdt.core.IJavaScriptElement, int, int, int, org.eclipse.wst.jsdt.core.search.SearchParticipant, IResource)">TypeDeclarationMatch</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>&nbsp;element,
int&nbsp;accuracy,
int&nbsp;offset,
int&nbsp;length,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchParticipant.html" title="class in org.eclipse.wst.jsdt.core.search">SearchParticipant</A>&nbsp;participant,
IResource&nbsp;resource)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new type declaration match.</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>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.search.SearchMatch"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.eclipse.wst.jsdt.core.search.<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html" title="class in org.eclipse.wst.jsdt.core.search">SearchMatch</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getAccuracy()">getAccuracy</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getElement()">getElement</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getLength()">getLength</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getOffset()">getOffset</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getParticipant()">getParticipant</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getResource()">getResource</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#getRule()">getRule</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#isEquivalent()">isEquivalent</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#isErasure()">isErasure</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#isExact()">isExact</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#isImplicit()">isImplicit</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#isInsideDocComment()">isInsideDocComment</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#isRaw()">isRaw</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setAccuracy(int)">setAccuracy</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setElement(java.lang.Object)">setElement</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setImplicit(boolean)">setImplicit</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setInsideDocComment(boolean)">setInsideDocComment</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setLength(int)">setLength</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setOffset(int)">setOffset</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setParticipant(org.eclipse.wst.jsdt.core.search.SearchParticipant)">setParticipant</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setRaw(boolean)">setRaw</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setResource(IResource)">setResource</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#setRule(int)">setRule</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html#toString()">toString</A></CODE></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, 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="TypeDeclarationMatch(org.eclipse.wst.jsdt.core.IJavaScriptElement, int, int, int, org.eclipse.wst.jsdt.core.search.SearchParticipant, IResource)"><!-- --></A><H3>
TypeDeclarationMatch</H3>
<PRE>
public <B>TypeDeclarationMatch</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>&nbsp;element,
int&nbsp;accuracy,
int&nbsp;offset,
int&nbsp;length,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchParticipant.html" title="class in org.eclipse.wst.jsdt.core.search">SearchParticipant</A>&nbsp;participant,
IResource&nbsp;resource)</PRE>
<DL>
<DD>Creates a new type declaration match.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - the type declaration<DD><CODE>accuracy</CODE> - one of A_ACCURATE or A_INACCURATE<DD><CODE>offset</CODE> - the offset the match starts at, or -1 if unknown<DD><CODE>length</CODE> - the length of the match, or -1 if unknown<DD><CODE>participant</CODE> - the search participant that created the match<DD><CODE>resource</CODE> - the resource of the element</DL>
</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/TypeDeclarationMatch.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/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/search/TypeDeclarationMatch.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="TypeDeclarationMatch.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;<A HREF="#fields_inherited_from_class_org.eclipse.wst.jsdt.core.search.SearchMatch">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_org.eclipse.wst.jsdt.core.search.SearchMatch">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;METHOD</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>