| <!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:12 BST 2010 --> |
| <TITLE> |
| IWsDOMRuntimeExtension |
| </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="IWsDOMRuntimeExtension"; |
| } |
| } |
| </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> </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/IWsDOMRuntimeExtension.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/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWSDOMRuntimeManager.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api"><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/api/IWsDOMRuntimeExtension.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IWsDOMRuntimeExtension.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.jst.ws.jaxws.dom.runtime.api</FONT> |
| <BR> |
| Interface IWsDOMRuntimeExtension</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/persistence/Jee5WsDomRuntimeExtension.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.persistence">Jee5WsDomRuntimeExtension</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IWsDOMRuntimeExtension</B></DL> |
| </PRE> |
| |
| <P> |
| This interface should be implemented by all runtime which want to have DOM Tree |
| representation on top of them. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Georgi Hristov I036201</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDOMRuntimeExtension.html#addLoadListener(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWsDomLoadListener)">addLoadListener</A></B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWsDomLoadListener</A> listener)</CODE> |
| |
| <BR> |
| Adds a load listener to be notified in load events.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDOMRuntimeExtension.html#createDOM(org.eclipse.core.runtime.IProgressMonitor)">createDOM</A></B>(org.eclipse.core.runtime.IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| This method should instantiate the DOM instance for the runtime and loads the |
| data into it.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IDOM.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IDOM</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDOMRuntimeExtension.html#getDOM()">getDOM</A></B>()</CODE> |
| |
| <BR> |
| To get a handle to the DOM instance available for this runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDOMRuntimeExtension.html#removeLoadListener(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWsDomLoadListener)">removeLoadListener</A></B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWsDomLoadListener</A> listener)</CODE> |
| |
| <BR> |
| Removes the listener from DOM loading listeners list</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="createDOM(org.eclipse.core.runtime.IProgressMonitor)"><!-- --></A><H3> |
| createDOM</H3> |
| <PRE> |
| void <B>createDOM</B>(org.eclipse.core.runtime.IProgressMonitor monitor) |
| throws java.io.IOException, |
| <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/WsDOMLoadCanceledException.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.api">WsDOMLoadCanceledException</A></PRE> |
| <DL> |
| <DD>This method should instantiate the DOM instance for the runtime and loads the |
| data into it. The method locks the workspace root during execution. If you call this |
| method during loading (i.e. somebody already called it in different thread) the method |
| will block until the load finishes instead of triggering DOM reload. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>monitor</CODE> - progress monitor to be used during loading, cancelling the load via monitor is supported |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE> - in case the DOM loading is not able to read required data |
| <DD><CODE><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/WsDOMLoadCanceledException.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.api">WsDOMLoadCanceledException</A></CODE> - in case the loading was cancelled via provided |
| <code>monitor</code>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addLoadListener(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWsDomLoadListener)"><!-- --></A><H3> |
| addLoadListener</H3> |
| <PRE> |
| void <B>addLoadListener</B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWsDomLoadListener</A> listener)</PRE> |
| <DL> |
| <DD>Adds a load listener to be notified in load events. In case the loading has already been started |
| this listener's methods are called depending on the current state of the load. |
| <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html#finished()"><CODE>IWsDomLoadListener.finished()</CODE></A> method is called in any case regardless of whether loading |
| has been cancelled or not. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeLoadListener(org.eclipse.jst.ws.jaxws.dom.runtime.api.IWsDomLoadListener)"><!-- --></A><H3> |
| removeLoadListener</H3> |
| <PRE> |
| void <B>removeLoadListener</B>(<A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IWsDomLoadListener</A> listener)</PRE> |
| <DL> |
| <DD>Removes the listener from DOM loading listeners list |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDOM()"><!-- --></A><H3> |
| getDOM</H3> |
| <PRE> |
| <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IDOM.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api">IDOM</A> <B>getDOM</B>() |
| throws <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/WsDOMLoadCanceledException.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.api">WsDOMLoadCanceledException</A></PRE> |
| <DL> |
| <DD>To get a handle to the DOM instance available for this runtime. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the DOM instance or <code>null</code> in case the loading was not started yet or |
| is not finished yet. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/WsDOMLoadCanceledException.html" title="class in org.eclipse.jst.ws.jaxws.dom.runtime.api">WsDOMLoadCanceledException</A></CODE> - in case loading has been called already but the load |
| has been cancelled</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/IWsDOMRuntimeExtension.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/jst/ws/jaxws/dom/runtime/api/IWsDomLoadListener.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../../org/eclipse/jst/ws/jaxws/dom/runtime/api/IWSDOMRuntimeManager.html" title="interface in org.eclipse.jst.ws.jaxws.dom.runtime.api"><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/api/IWsDOMRuntimeExtension.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IWsDOMRuntimeExtension.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> |
