Regenerated javadocs documentation for website. Added documentation to the connectionFactory schema. Added docs for test code.

4 files changed, 106 insertions, 82 deletions

diff --git a/framework/bundles/org.eclipse.ecf/javadoc.xml b/framework/bundles/org.eclipse.ecf/javadoc.xml
index f3fd80540..7995b8813 100644
--- a/framework/bundles/org.eclipse.ecf/javadoc.xml
+++ b/framework/bundles/org.eclipse.ecf/javadoc.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project default="javadoc">
     <target name="javadoc">
-        <javadoc destdir="../ecf website/org.eclipse.ecf.docs/api" access="protected" use="true" notree="false" nonavbar="false" noindex="false" splitindex="true" author="false" version="true" nodeprecatedlist="false" nodeprecated="false" packagenames="org.eclipse.ecf.core.identity.provider,org.eclipse.ecf.core.comm.provider,org.eclipse.ecf.core,org.eclipse.ecf.core.comm,org.eclipse.ecf.provider.generic.gmm,org.eclipse.ecf.core.events,org.eclipse.ecf.provider,org.eclipse.ecf.core.util,org.eclipse.ecf.core.identity,org.eclipse.ecf.core.provider,org.eclipse.ecf.provider.generic,org.eclipse.ecf.provider.comm.tcp,org.eclipse.ecf.provider.generic.events" sourcepath="src;../org.eclipse.ecf.provider/src" classpath="../org.eclipse.ecf.provider/bin;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\osgi.jar;C:\301\eclipse\plugins\org.eclipse.core.runtime_3.0.1\runtime.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\defaultAdaptor.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\core.jar;bin;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\eclipseAdaptor.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\resolver.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\console.jar" doctitle="Eclipse Communication Framework (ECF)">
+        <javadoc destdir="../ecf website/org.eclipse.ecf.docs/api" access="protected" use="true" notree="false" nonavbar="false" noindex="false" splitindex="true" author="false" version="true" nodeprecatedlist="false" nodeprecated="false" packagenames="org.eclipse.ecf.core.identity.provider,org.eclipse.ecf.core,org.eclipse.ecf.core.comm.provider,org.eclipse.ecf.core.comm,org.eclipse.ecf.provider.generic.gmm,org.eclipse.ecf.core.events,org.eclipse.ecf.provider,org.eclipse.ecf.core.util,org.eclipse.ecf.core.identity,org.eclipse.ecf.core.provider,org.eclipse.ecf.provider.generic,org.eclipse.ecf.provider.comm.tcp,org.eclipse.ecf.provider.generic.events" sourcepath="src;../org.eclipse.ecf.provider/src" classpath="../org.eclipse.ecf.provider/bin;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\osgi.jar;C:\301\eclipse\plugins\org.eclipse.core.runtime_3.0.1\runtime.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\defaultAdaptor.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\core.jar;bin;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\eclipseAdaptor.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\resolver.jar;C:\301\eclipse\plugins\org.eclipse.osgi_3.0.1\console.jar" doctitle="Eclipse Communication Framework (ECF) 0.2.0">
             <link href="http://java.sun.com/j2se/1.4.2/docs/api"/>
         </javadoc>
     </target>
diff --git a/framework/bundles/org.eclipse.ecf/schema/connectionFactory.exsd b/framework/bundles/org.eclipse.ecf/schema/connectionFactory.exsd
index 52488b4b9..ecede9243 100644
--- a/framework/bundles/org.eclipse.ecf/schema/connectionFactory.exsd
+++ b/framework/bundles/org.eclipse.ecf/schema/connectionFactory.exsd
@@ -6,7 +6,8 @@
          <meta.schema plugin="org.eclipse.ecf" id="comm" name="ECF Connection Factory"/>

       </appInfo>

       <documentation>

-         [Enter description of this extension point.]

+         This extension allows plugins to register themselves as &apos;providers&apos; of ECF connection factories.  Once registered via this extension point, plugins can provide implementations of custom ISynchAsynchConnection instances via the ECF connection factory (&lt;b&gt;org.eclipse.ecf.core.comm.ConnectionFactory&lt;/b&gt;).

+&lt;p&gt;Plugins using this extension point can define new implementation classes of the core ISynchAsynchConnection interface.  When client requests are made to ECF to create &lt;b&gt;ISynchAsynchConnection&lt;/b&gt; instances via the ConnectionFactory.makeSynchAsynchConnection() methods, requests to create instances of the appropriate type will be re-directed to the given extension.

       </documentation>

    </annotation>

 

@@ -70,7 +71,7 @@
          <meta.section type="since"/>

       </appInfo>

       <documentation>

-         [Enter the first release in which this extension point appears.]

+         0.2.0

       </documentation>

    </annotation>

 

@@ -79,7 +80,7 @@
          <meta.section type="examples"/>

       </appInfo>

       <documentation>

-         [Enter extension point usage example here.]

+         

       </documentation>

    </annotation>

 

@@ -88,7 +89,7 @@
          <meta.section type="apiInfo"/>

       </appInfo>

       <documentation>

-         [Enter API information here.]

+         The API for this extension point is provided by the &lt;b&gt;org.eclipse.ecf.core.comm.ContainerFactory&lt;/b&gt; static methods.  Specifically, the &apos;makeSynchAsynchConnection&apos; static methods are to be used by clients.  The functionality provided by the extension point mechanism can be used at runtime via the &lt;b&gt;ConnectionFactory.addDescription(ConnectionDescription)&lt;/b&gt; method.  The available connection factories can be queried with the &lt;b&gt;ConnectionFactory.getDescriptions()&lt;/b&gt; method.

       </documentation>

    </annotation>

 

@@ -97,7 +98,11 @@
          <meta.section type="implementation"/>

       </appInfo>

       <documentation>

-         [Enter information about supplied implementation of this extension point.]

+         The supplied implementations of this extension point are:

+

+In org.eclipse.ecf.provider plugin:

+

+org.eclipse.ecf.provider.tcp.Client$Creator

       </documentation>

    </annotation>

 

@@ -106,7 +111,8 @@
          <meta.section type="copyright"/>

       </appInfo>

       <documentation>

-         

+         Copyright (c) 2005 Composent, Inc. and others.

+All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.  Contributors:  Composent, Inc. - initial API and implementation

       </documentation>

    </annotation>

 

diff --git a/framework/bundles/org.eclipse.ecf/schema/containerFactory.exsd b/framework/bundles/org.eclipse.ecf/schema/containerFactory.exsd
index c8adbf9bb..a920ab232 100644
--- a/framework/bundles/org.eclipse.ecf/schema/containerFactory.exsd
+++ b/framework/bundles/org.eclipse.ecf/schema/containerFactory.exsd
@@ -146,6 +146,10 @@ ISharedObjectContainer newContainer = SharedObjectContainerFactory.makeSharedObj
       </appInfo>

       <documentation>

          The supplied implementations of this extension point are:

+

+org.eclipse.ecf.provider.generic.ContainerInstantiator

+&lt;b&gt;TEST&lt;/b&gt;:  org.eclipse.ecf.internal.impl.standalone.StandaloneContainerInstantiator

+&lt;b&gt;TEST&lt;/b&gt;:  org.eclipse.ecf.test.TestContainer

       </documentation>

    </annotation>

 

diff --git a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/comm/ConnectionFactory.java b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/comm/ConnectionFactory.java
index 7240715af..0bfe850b3 100644
--- a/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/comm/ConnectionFactory.java
+++ b/framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/comm/ConnectionFactory.java
@@ -1,29 +1,47 @@
-/****************************************************************************
-* Copyright (c) 2004 Composent, Inc. and others.
-* All rights reserved. This program and the accompanying materials
-* are made available under the terms of the Eclipse Public License v1.0
-* which accompanies this distribution, and is available at
-* http://www.eclipse.org/legal/epl-v10.html
-*
-* Contributors:
-*    Composent, Inc. - initial API and implementation
-*****************************************************************************/
-
+/*******************************************************************************
+ * Copyright (c) 2004 Composent, Inc. and others. All rights reserved. This
+ * program and the accompanying materials are made available under the terms of
+ * the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ * 
+ * Contributors: Composent, Inc. - initial API and implementation
+ ******************************************************************************/
 package org.eclipse.ecf.core.comm;
 
 import java.util.ArrayList;
 import java.util.Hashtable;
 import java.util.List;
-
 import org.eclipse.ecf.core.comm.provider.ISynchAsynchConnectionInstantiator;
 import org.eclipse.ecf.core.util.AbstractFactory;
 import org.eclipse.ecf.internal.core.Trace;
 
 public class ConnectionFactory {
-
-    private static Trace debug = Trace.create("connectionfactory");
-    
     private static Hashtable connectiontypes = new Hashtable();
+    private static Trace debug = Trace.create("connectionfactory");
+
+    public final static ConnectionDescription addDescription(
+            ConnectionDescription scd) {
+        debug("addDescription(" + scd + ")");
+        return addDescription0(scd);
+    }
+
+    protected static ConnectionDescription addDescription0(
+            ConnectionDescription n) {
+        if (n == null)
+            return null;
+        return (ConnectionDescription) connectiontypes.put(n.getName(), n);
+    }
+
+    public final static boolean containsDescription(ConnectionDescription scd) {
+        debug("containsDescription(" + scd + ")");
+        return containsDescription0(scd);
+    }
+
+    protected static boolean containsDescription0(ConnectionDescription scd) {
+        if (scd == null)
+            return false;
+        return connectiontypes.containsKey(scd.getName());
+    }
 
     private static void debug(String msg) {
         if (Trace.ON && debug != null) {
@@ -36,75 +54,60 @@ public class ConnectionFactory {
             debug.dumpStack(e, msg);
         }
     }
+
     public final static ConnectionDescription getDescription(
             ConnectionDescription scd) {
-        debug("getDescription("+scd+")");
+        debug("getDescription(" + scd + ")");
         return getDescription0(scd);
     }
+
     protected static ConnectionDescription getDescription0(
             ConnectionDescription scd) {
         if (scd == null)
             return null;
         return (ConnectionDescription) connectiontypes.get(scd.getName());
     }
-    protected static List getDescriptions0() {
-        return new ArrayList(connectiontypes.values());
-    }
+
     protected static ConnectionDescription getDescription0(String name) {
         if (name == null)
             return null;
         return (ConnectionDescription) connectiontypes.get(name);
     }
+
     public final static ConnectionDescription getDescriptionByName(String name) {
-        debug("getDescriptionByName("+name+")");
+        debug("getDescriptionByName(" + name + ")");
         return getDescription0(name);
     }
-    public final static ConnectionDescription removeDescription(
-            ConnectionDescription scd) {
-        debug("removeDescription("+scd+")");
-        return removeDescription0(scd);
-    }
+
     public static final List getDescriptions() {
         debug("getDescriptions()");
-    	return getDescriptions0();
+        return getDescriptions0();
     }
 
-    protected static ConnectionDescription removeDescription0(
-            ConnectionDescription n) {
-        if (n == null)
-            return null;
-        return (ConnectionDescription) connectiontypes.remove(n.getName());
-    }
-    public final static ConnectionDescription addDescription(
-            ConnectionDescription scd) {
-        debug("addDescription("+scd+")");
-        return addDescription0(scd);
+    protected static List getDescriptions0() {
+        return new ArrayList(connectiontypes.values());
     }
 
-    protected static ConnectionDescription addDescription0(
-            ConnectionDescription n) {
-        if (n == null)
-            return null;
-        return (ConnectionDescription) connectiontypes.put(n.getName(), n);
-    }
-    public final static boolean containsDescription(ConnectionDescription scd) {
-        debug("containsDescription("+scd+")");
-        return containsDescription0(scd);
-    }
-    protected static boolean containsDescription0(ConnectionDescription scd) {
-        if (scd == null)
-            return false;
-        return connectiontypes.containsKey(scd.getName());
+    public static ISynchAsynchConnection makeSynchAsynchConnection(
+            ISynchAsynchConnectionEventHandler handler,
+            ConnectionDescription desc, Object[] args)
+            throws ConnectionInstantiationException {
+        if (handler == null)
+            throw new ConnectionInstantiationException(
+                    "ISynchAsynchConnectionEventHandler cannot be null");
+        return makeSynchAsynchConnection(handler, desc, null, args);
     }
 
     public static ISynchAsynchConnection makeSynchAsynchConnection(
             ISynchAsynchConnectionEventHandler handler,
             ConnectionDescription desc, String[] argTypes, Object[] args)
             throws ConnectionInstantiationException {
-
-        debug("makeSynchAsynchConnection("+handler+","+desc+","+Trace.convertStringAToString(argTypes)+","+Trace.convertObjectAToString(args)+")");
+        debug("makeSynchAsynchConnection(" + handler + "," + desc + ","
+                + Trace.convertStringAToString(argTypes) + ","
+                + Trace.convertObjectAToString(args) + ")");
         if (handler == null)
-            throw new ConnectionInstantiationException("ISynchAsynchConnectionEventHandler cannot be null");
+            throw new ConnectionInstantiationException(
+                    "ISynchAsynchConnectionEventHandler cannot be null");
         if (desc == null)
             throw new ConnectionInstantiationException(
                     "ConnectionDescription cannot be null");
@@ -115,7 +118,8 @@ public class ConnectionFactory {
         ISynchAsynchConnectionInstantiator instantiator = null;
         Class clazzes[] = null;
         try {
-            instantiator = (ISynchAsynchConnectionInstantiator) cd.getInstantiator();
+            instantiator = (ISynchAsynchConnectionInstantiator) cd
+                    .getInstantiator();
             clazzes = AbstractFactory.getClassesForTypes(argTypes, args, cd
                     .getClassLoader());
             if (instantiator == null)
@@ -127,51 +131,61 @@ public class ConnectionFactory {
                     "Exception getting instantiator for '" + desc.getName()
                             + "'", e);
         }
-        debug("makeSynchAsynchConnection:got instantiator:"+instantiator);
+        debug("makeSynchAsynchConnection:got instantiator:" + instantiator);
         // Ask instantiator to actually create instance
         return instantiator.makeInstance(handler, clazzes, args);
     }
+
     public static ISynchAsynchConnection makeSynchAsynchConnection(
-            ISynchAsynchConnectionEventHandler handler,
-            ConnectionDescription desc, Object[] args)
+            ISynchAsynchConnectionEventHandler handler, String descriptionName)
             throws ConnectionInstantiationException {
         if (handler == null)
-            throw new ConnectionInstantiationException("ISynchAsynchConnectionEventHandler cannot be null");
-        return makeSynchAsynchConnection(handler, desc, null, args);
+            throw new ConnectionInstantiationException(
+                    "ISynchAsynchConnectionEventHandler cannot be null");
+        ConnectionDescription desc = getDescriptionByName(descriptionName);
+        if (desc == null)
+            throw new ConnectionInstantiationException(
+                    "Connection type named '" + descriptionName + "' not found");
+        return makeSynchAsynchConnection(handler, desc, null, null);
     }
+
     public static ISynchAsynchConnection makeSynchAsynchConnection(
             ISynchAsynchConnectionEventHandler handler, String descriptionName,
             Object[] args) throws ConnectionInstantiationException {
         if (handler == null)
-            throw new ConnectionInstantiationException("ISynchAsynchConnectionEventHandler cannot be null");
+            throw new ConnectionInstantiationException(
+                    "ISynchAsynchConnectionEventHandler cannot be null");
         ConnectionDescription desc = getDescriptionByName(descriptionName);
         if (desc == null)
-            throw new ConnectionInstantiationException("Connection type named '"
-                    + descriptionName + "' not found");
+            throw new ConnectionInstantiationException(
+                    "Connection type named '" + descriptionName + "' not found");
         return makeSynchAsynchConnection(handler, desc, args);
     }
+
     public static ISynchAsynchConnection makeSynchAsynchConnection(
             ISynchAsynchConnectionEventHandler handler, String descriptionName,
             String[] argTypes, Object[] args)
             throws ConnectionInstantiationException {
         if (handler == null)
-            throw new ConnectionInstantiationException("ISynchAsynchConnectionEventHandler cannot be null");
+            throw new ConnectionInstantiationException(
+                    "ISynchAsynchConnectionEventHandler cannot be null");
         ConnectionDescription desc = getDescriptionByName(descriptionName);
         if (desc == null)
-            throw new ConnectionInstantiationException("Connection type named '"
-                    + descriptionName + "' not found");
+            throw new ConnectionInstantiationException(
+                    "Connection type named '" + descriptionName + "' not found");
         return makeSynchAsynchConnection(handler, desc, argTypes, args);
     }
-    public static ISynchAsynchConnection makeSynchAsynchConnection(
-            ISynchAsynchConnectionEventHandler handler, String descriptionName)
-            throws ConnectionInstantiationException {
-        if (handler == null)
-            throw new ConnectionInstantiationException("ISynchAsynchConnectionEventHandler cannot be null");
-        ConnectionDescription desc = getDescriptionByName(descriptionName);
-        if (desc == null)
-            throw new ConnectionInstantiationException("Connection type named '"
-                    + descriptionName + "' not found");
-        return makeSynchAsynchConnection(handler, desc, null, null);
+
+    public final static ConnectionDescription removeDescription(
+            ConnectionDescription scd) {
+        debug("removeDescription(" + scd + ")");
+        return removeDescription0(scd);
     }
 
+    protected static ConnectionDescription removeDescription0(
+            ConnectionDescription n) {
+        if (n == null)
+            return null;
+        return (ConnectionDescription) connectiontypes.remove(n.getName());
+    }
 }
\ No newline at end of file