blob: 18bbb0eec0dc299dd74f20eaef7e76f9d4d6ae31 [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_14) on Wed Apr 07 07:58:10 BST 2010 -->
<TITLE>
ICompilationUnitHandler
</TITLE>
<META NAME="date" CONTENT="2010-04-07">
<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="ICompilationUnitHandler";
}
}
</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/ICompilationUnitHandler.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/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/IModelElementSynchronizer.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../index.html?org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICompilationUnitHandler.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.jst.ws.jaxws.dom.runtime.persistence</FONT>
<BR>
Interface ICompilationUnitHandler</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/sync/AbstractModelSynchronizer.LoaderCompilationUnitHandler.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.persistence.sync">AbstractModelSynchronizer.LoaderCompilationUnitHandler</A>, <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/WorkspaceCUFinder.CountingCUHandler.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.persistence">WorkspaceCUFinder.CountingCUHandler</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ICompilationUnitHandler</B></DL>
</PRE>
<P>
A listener for events isseud by an <c>ICompilationUnitFinder</c> instance during compilation unit traversals
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Hristo Sabev</DD>
</DL>
<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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html#finished()">finished</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;called by the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance when it has finished to traverse the annotation set.</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/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html#handle(org.eclipse.jdt.core.ICompilationUnit)">handle</A></B>(org.eclipse.jdt.core.ICompilationUnit&nbsp;cu)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance found a compilation unit.</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/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html#handle(org.eclipse.jdt.core.IJavaProject)">handle</A></B>(org.eclipse.jdt.core.IJavaProject&nbsp;jprj)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance found a java project.</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/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html#started()">started</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;called by the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance when it has started to traverse the annotation set.</TD>
</TR>
</TABLE>
&nbsp;
<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="started()"><!-- --></A><H3>
started</H3>
<PRE>
void <B>started</B>()</PRE>
<DL>
<DD>called by the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance when it has started to traverse the annotation set. All calls to <c>handle(...)</c>
methods is inside a started-finished block.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="finished()"><!-- --></A><H3>
finished</H3>
<PRE>
void <B>finished</B>()</PRE>
<DL>
<DD>called by the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance when it has finished to traverse the annotation set.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handle(org.eclipse.jdt.core.ICompilationUnit)"><!-- --></A><H3>
handle</H3>
<PRE>
void <B>handle</B>(org.eclipse.jdt.core.ICompilationUnit&nbsp;cu)</PRE>
<DL>
<DD>Called when the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance found a compilation unit. This method is awlays called after a call to <c><CODE>handle(JavaProject)</CODE></c>.
The reported compilation unit is guaranteed to be found inside the <c>JavaProject</c> reported by the last call to <c></c>.
This method will be called exactly once for each compilation unit
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cu</CODE> - -
the compilation unit found by the finder</DL>
</DD>
</DL>
<HR>
<A NAME="handle(org.eclipse.jdt.core.IJavaProject)"><!-- --></A><H3>
handle</H3>
<PRE>
void <B>handle</B>(org.eclipse.jdt.core.IJavaProject&nbsp;jprj)</PRE>
<DL>
<DD>Called when the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><CODE>ICompilationUnitFinder</CODE></A></c> instance found a java project. This method is always called before the <c><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html#handle(org.eclipse.jdt.core.ICompilationUnit)"><CODE>handle(ICompilationUnit)</CODE></A></c>
for any compilation unit found in this project. This method will be called exactly once for each found project.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jprj</CODE> - -
the java project found by the finder</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/ICompilationUnitHandler.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/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitFinder.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/IModelElementSynchronizer.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.persistence"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../../index.html?org/eclipse/jst/ws/jaxws/dom/runtime/persistence/ICompilationUnitHandler.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ICompilationUnitHandler.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>