| <!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_01) on Tue Feb 01 22:35:06 PST 2005 --> |
| <TITLE> |
| ISharedObject |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.ecf.core.ISharedObject interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ISharedObject"; |
| } |
| </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/ISharedObject.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/ecf/core/IOSGIService.html" title="interface in org.eclipse.ecf.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/eclipse/ecf/core/ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/eclipse/ecf/core/ISharedObject.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ISharedObject.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.ecf.core</FONT> |
| <BR> |
| Interface ISharedObject</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/eclipse/ecf/provider/generic/sobject/BaseSharedObject.html" title="class in org.eclipse.ecf.provider.generic.sobject">BaseSharedObject</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>ISharedObject</B></DL> |
| </PRE> |
| |
| <P> |
| Core interface for implementing components that exist within <A HREF="../../../../org/eclipse/ecf/core/ISharedObjectContainer.html" title="interface in org.eclipse.ecf.core"><CODE>ISharedObjectContainer</CODE></A> |
| <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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/ecf/core/ISharedObject.html#dispose(org.eclipse.ecf.core.identity.ID)">dispose</A></B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A> containerID)</CODE> |
| |
| <BR> |
| Method called by the ISharedObjectContainer upon ISharedObject |
| destruction.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/ecf/core/ISharedObject.html#getAdapter(java.lang.Class)">getAdapter</A></B>(java.lang.Class clazz)</CODE> |
| |
| <BR> |
| Provide access to an adapter object.</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/ecf/core/ISharedObject.html#handleEvent(org.eclipse.ecf.core.util.Event)">handleEvent</A></B>(<A HREF="../../../../org/eclipse/ecf/core/util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</A> event)</CODE> |
| |
| <BR> |
| Handle Event passed to this ISharedObject.</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/ecf/core/ISharedObject.html#handleEvents(org.eclipse.ecf.core.util.Event[])">handleEvents</A></B>(<A HREF="../../../../org/eclipse/ecf/core/util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</A>[] events)</CODE> |
| |
| <BR> |
| Handle Events passed to this ISharedObject.</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/ecf/core/ISharedObject.html#init(org.eclipse.ecf.core.ISharedObjectConfig)">init</A></B>(<A HREF="../../../../org/eclipse/ecf/core/ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core">ISharedObjectConfig</A> initData)</CODE> |
| |
| <BR> |
| Initialize this ISharedObject.</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="init(org.eclipse.ecf.core.ISharedObjectConfig)"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| void <B>init</B>(<A HREF="../../../../org/eclipse/ecf/core/ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core">ISharedObjectConfig</A> initData) |
| throws <A HREF="../../../../org/eclipse/ecf/core/SharedObjectInitException.html" title="class in org.eclipse.ecf.core">SharedObjectInitException</A></PRE> |
| <DL> |
| <DD>Initialize this ISharedObject. The ISharedObjectContainer for this |
| ISharedObject must call this method with a non-null instance of |
| ISharedObjectConfig. ISharedObject implementations can use this |
| initialization to perform any initialization necessary prior to receiving |
| any events (via handleEvent/s). Note that the ISharedObjectContext |
| provided via the ISharedObjectConfig.getSharedObjectContext() method is |
| not guaranteed to allow any method calls until after this init() method |
| call has completed. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>initData</CODE> - the initialization data passed by the ISharedObjectContainer |
| upon initialization |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/eclipse/ecf/core/SharedObjectInitException.html" title="class in org.eclipse.ecf.core">SharedObjectInitException</A></CODE> - thrown by ISharedObject to halt initialization. |
| ISharedObjectContainers must respond to such an exception |
| by halting the addition of the ISharedObject instance and |
| treating it as <b>not </b> in the container.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="handleEvent(org.eclipse.ecf.core.util.Event)"><!-- --></A><H3> |
| handleEvent</H3> |
| <PRE> |
| void <B>handleEvent</B>(<A HREF="../../../../org/eclipse/ecf/core/util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</A> event)</PRE> |
| <DL> |
| <DD>Handle Event passed to this ISharedObject. The ISharedObjectContainer |
| will pass events to all SharedObjects via this method and the |
| handleEvents method. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>event</CODE> - the Event for the ISharedObject to process</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="handleEvents(org.eclipse.ecf.core.util.Event[])"><!-- --></A><H3> |
| handleEvents</H3> |
| <PRE> |
| void <B>handleEvents</B>(<A HREF="../../../../org/eclipse/ecf/core/util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</A>[] events)</PRE> |
| <DL> |
| <DD>Handle Events passed to this ISharedObject. The ISharedObjectContainer |
| will pass events to all SharedObjects via this method and the |
| handleEvents method. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>events</CODE> - the Events [] for the ISharedObject to process</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dispose(org.eclipse.ecf.core.identity.ID)"><!-- --></A><H3> |
| dispose</H3> |
| <PRE> |
| void <B>dispose</B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A> containerID)</PRE> |
| <DL> |
| <DD>Method called by the ISharedObjectContainer upon ISharedObject |
| destruction. Once this method is called, no more Events will be passed to |
| a ISharedObject until the init method is called again. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerID</CODE> - the ID of the container that is disposing this ISharedObject</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAdapter(java.lang.Class)"><!-- --></A><H3> |
| getAdapter</H3> |
| <PRE> |
| java.lang.Object <B>getAdapter</B>(java.lang.Class clazz)</PRE> |
| <DL> |
| <DD>Provide access to an adapter object. This method guarantees that any |
| non-null object instance provided is an instance of the class provided as |
| the first parameter. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the Class of the adapter. The returned Object instance must |
| implement the given clazz |
| <DT><B>Returns:</B><DD>Object the adaptor object</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/ISharedObject.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/ecf/core/IOSGIService.html" title="interface in org.eclipse.ecf.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/eclipse/ecf/core/ISharedObjectConfig.html" title="interface in org.eclipse.ecf.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/eclipse/ecf/core/ISharedObject.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ISharedObject.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> |
