Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorslewis2007-05-27 17:48:39 -0400
committerslewis2007-05-27 17:48:39 -0400
commit4e5af24a00757e3ec697218ef5f4f458da5cf3dd (patch)
tree996e5582b45b52a22daa5f322b5b8984d9da745c /framework/bundles/org.eclipse.ecf.presence
parenta698ea58333dc0aa2e63f9ff0254bb347e8c9dc7 (diff)
downloadorg.eclipse.ecf-4e5af24a00757e3ec697218ef5f4f458da5cf3dd.tar.gz
org.eclipse.ecf-4e5af24a00757e3ec697218ef5f4f458da5cf3dd.tar.xz
org.eclipse.ecf-4e5af24a00757e3ec697218ef5f4f458da5cf3dd.zip
Added documentation for listeners (asynchronous invocation).
Diffstat (limited to 'framework/bundles/org.eclipse.ecf.presence')
-rw-r--r--framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/AbstractPresenceContainer.java3
-rw-r--r--framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/chatroom/IChatRoomAdminListener.java22
2 files changed, 24 insertions, 1 deletions
diff --git a/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/AbstractPresenceContainer.java b/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/AbstractPresenceContainer.java
index c8f471918..052efcd62 100644
--- a/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/AbstractPresenceContainer.java
+++ b/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/AbstractPresenceContainer.java
@@ -13,13 +13,14 @@ package org.eclipse.ecf.presence;
import org.eclipse.core.runtime.IAdapterManager;
import org.eclipse.ecf.internal.presence.PresencePlugin;
import org.eclipse.ecf.presence.chatroom.IChatRoomManager;
+import org.eclipse.ecf.presence.service.IPresenceService;
/**
* An abstract {@link IPresenceContainerAdapter} implementation. This class is
* intended to be subclassed.
*/
public abstract class AbstractPresenceContainer implements
- IPresenceContainerAdapter {
+ IPresenceService {
/**
* @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
diff --git a/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/chatroom/IChatRoomAdminListener.java b/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/chatroom/IChatRoomAdminListener.java
index d743037a7..bff4520bc 100644
--- a/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/chatroom/IChatRoomAdminListener.java
+++ b/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/chatroom/IChatRoomAdminListener.java
@@ -15,6 +15,28 @@ import org.eclipse.ecf.core.identity.ID;
/**
* Listener for chat room subject changes
+ * <p>
+ * </p>
+ * Note these methods will be called asynchronously when notifications of remote
+ * changes are received by the provider implementation code. The provider is
+ * free to call the methods below with an arbitrary thread, so the
+ * implementation of these methods must be appropriately prepared.
+ * <p>
+ * </p>
+ * For example, if the code implementing any of these methods must interact with
+ * user interface code, then it should use code such as the following to execute
+ * on the SWT UI thread:
+ *
+ * <pre>
+ * Display.getDefault().asyncExec(new Runnable() {
+ * public void run() {
+ * ... UI code here
+ * }
+ * });
+ * </pre>
+ *
+ * Further, the code in the implementations of these methods should <b>not block</b>
+ * via I/O operations or blocking UI calls.
*/
public interface IChatRoomAdminListener {

Back to the top