diff options
| author | pnehrer | 2005-02-11 17:37:39 +0000 |
|---|---|---|
| committer | pnehrer | 2005-02-11 17:37:39 +0000 |
| commit | 17545eb03ca38ea1c6c670ec902282e791abc864 (patch) | |
| tree | e3cfe259b6d3be120d92ac77eafe4b68dbbb98db | |
| parent | 6805443c35e52c3fd203fa71b9feb5f55aca55fb (diff) | |
| download | org.eclipse.ecf-17545eb03ca38ea1c6c670ec902282e791abc864.tar.gz org.eclipse.ecf-17545eb03ca38ea1c6c670ec902282e791abc864.tar.xz org.eclipse.ecf-17545eb03ca38ea1c6c670ec902282e791abc864.zip | |
Automated build process.
16 files changed, 257 insertions, 411 deletions
diff --git a/doc/bundles/org.eclipse.ecf.doc/.cvsignore b/doc/bundles/org.eclipse.ecf.doc/.cvsignore new file mode 100644 index 000000000..954b6be7d --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/.cvsignore @@ -0,0 +1,4 @@ +*.class +*.java +tocapi.xml +tocextpoint.xml diff --git a/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc buildapitoc.xml [Builder].launch b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc buildapitoc.xml [Builder].launch new file mode 100644 index 000000000..e601aa02b --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc buildapitoc.xml [Builder].launch @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType"> +<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/> +<booleanAttribute key="org.eclipse.debug.ui.ATTR_LAUNCH_IN_BACKGROUND" value="false"/> +<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.ui.antsupport.InternalAntRunner"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_RUN_BUILD_KINDS" value="full,incremental,"/> +<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="C:\home\pnehrer\e31\eclipse\workspace\org.eclipse.ecf.doc"/> +<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/> +<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/> +<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_TYPE_ID" value="org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType"/> +<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.ecf.doc"/> +<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_NAME" value="j2re1.4.2_06"/> +<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${project}"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.ecf.doc/buildapitoc.xml}"/> +<booleanAttribute key="org.eclipse.debug.core.ATTR_REFRESH_RECURSIVE" value="false"/> +</launchConfiguration> diff --git a/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc buildschematoc.xml [Builder].launch b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc buildschematoc.xml [Builder].launch new file mode 100644 index 000000000..aa3ec3628 --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc buildschematoc.xml [Builder].launch @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType"> +<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/> +<booleanAttribute key="org.eclipse.debug.ui.ATTR_LAUNCH_IN_BACKGROUND" value="false"/> +<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.ui.antsupport.InternalAntRunner"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_RUN_BUILD_KINDS" value="full,incremental,"/> +<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/> +<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="C:\home\pnehrer\e31\eclipse\workspace\org.eclipse.ecf.doc"/> +<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/> +<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_TYPE_ID" value="org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType"/> +<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_NAME" value="j2re1.4.2_06"/> +<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.ecf.doc"/> +<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${project}"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.ecf.doc/buildschematoc.xml}"/> +<booleanAttribute key="org.eclipse.debug.core.ATTR_REFRESH_RECURSIVE" value="false"/> +</launchConfiguration> diff --git a/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc javadoc.xml [Builder].launch b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc javadoc.xml [Builder].launch new file mode 100644 index 000000000..2ab07f6fb --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc javadoc.xml [Builder].launch @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType"> +<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/> +<booleanAttribute key="org.eclipse.debug.ui.ATTR_LAUNCH_IN_BACKGROUND" value="false"/> +<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.ui.antsupport.InternalAntRunner"/> +<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_TYPE_ID" value="org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_RUN_BUILD_KINDS" value="full,incremental,"/> +<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_NAME" value="j2re1.4.2_06"/> +<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.ecf.doc"/> +<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:<?xml version="1.0" encoding="UTF-8"?> <launchConfigurationWorkingSet factoryID="org.eclipse.ui.internal.WorkingSetFactory" name="workingSet"> <item factoryID="org.eclipse.ui.internal.model.ResourceFactory" path="/org.eclipse.ecf.doc/html/reference/api" type="2"/> </launchConfigurationWorkingSet> }"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.ecf.doc/javadoc.xml}"/> +<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/> +<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="C:\home\pnehrer\e31\eclipse\workspace\org.eclipse.ecf.doc"/> +<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/> +</launchConfiguration> diff --git a/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc schema.xml [Builder].launch b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc schema.xml [Builder].launch new file mode 100644 index 000000000..5269de0b4 --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/.externalToolBuilders/org.eclipse.ecf.doc schema.xml [Builder].launch @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<launchConfiguration type="org.eclipse.ant.AntBuilderLaunchConfigurationType"> +<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/> +<booleanAttribute key="org.eclipse.debug.ui.ATTR_LAUNCH_IN_BACKGROUND" value="false"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_RUN_BUILD_KINDS" value="full,incremental,"/> +<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="org.eclipse.ecf.doc"/> +<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:<?xml version="1.0" encoding="UTF-8"?> <launchConfigurationWorkingSet editPageId="org.eclipse.ui.resourceWorkingSetPage" factoryID="org.eclipse.ui.internal.WorkingSetFactory" name="workingSet"> <item factoryID="org.eclipse.ui.internal.model.ResourceFactory" path="/org.eclipse.ecf.doc/html/reference/extension-points" type="2"/> </launchConfigurationWorkingSet> }"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/org.eclipse.ecf.doc/schema.xml}"/> +<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="C:\home\pnehrer\e31\eclipse\workspace\org.eclipse.ecf.doc"/> +<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/> +<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/> +<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_TARGETS" value="clean,schema,"/> +</launchConfiguration> diff --git a/doc/bundles/org.eclipse.ecf.doc/.project b/doc/bundles/org.eclipse.ecf.doc/.project index ea84e6059..fede0b69a 100644 --- a/doc/bundles/org.eclipse.ecf.doc/.project +++ b/doc/bundles/org.eclipse.ecf.doc/.project @@ -15,6 +15,42 @@ <arguments> </arguments> </buildCommand> + <buildCommand> + <name>org.eclipse.ui.externaltools.ExternalToolBuilder</name> + <arguments> + <dictionary> + <key>LaunchConfigHandle</key> + <value><project>/.externalToolBuilders/org.eclipse.ecf.doc javadoc.xml [Builder].launch</value> + </dictionary> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.ui.externaltools.ExternalToolBuilder</name> + <arguments> + <dictionary> + <key>LaunchConfigHandle</key> + <value><project>/.externalToolBuilders/org.eclipse.ecf.doc schema.xml [Builder].launch</value> + </dictionary> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.ui.externaltools.ExternalToolBuilder</name> + <arguments> + <dictionary> + <key>LaunchConfigHandle</key> + <value><project>/.externalToolBuilders/org.eclipse.ecf.doc buildapitoc.xml [Builder].launch</value> + </dictionary> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.ui.externaltools.ExternalToolBuilder</name> + <arguments> + <dictionary> + <key>LaunchConfigHandle</key> + <value><project>/.externalToolBuilders/org.eclipse.ecf.doc buildschematoc.xml [Builder].launch</value> + </dictionary> + </arguments> + </buildCommand> </buildSpec> <natures> <nature>org.eclipse.pde.PluginNature</nature> diff --git a/doc/bundles/org.eclipse.ecf.doc/buildapitoc.xml b/doc/bundles/org.eclipse.ecf.doc/buildapitoc.xml new file mode 100644 index 000000000..45e8b0e8b --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/buildapitoc.xml @@ -0,0 +1,44 @@ +<project default="toc"> + + <target name="init"> + <property name="package-list.path" location="${basedir}/html/reference/api/package-list"/> + <uptodate property="BuildAPITOC.uptodate" srcfile="${package-list.path}" targetfile="BuildAPITOC.class"/> + </target> + + <target name="toc" depends="init,compile"> + <echo file="tocapi.xml"><![CDATA[ +<toc label="JavaDoc"> +]]></echo> + <java classname="BuildAPITOC" classpath="." output="tocapi.xml" append="true"> + <arg line="${package-list.path}"/> + </java> + <echo file="tocapi.xml" append="true"><![CDATA[ +</toc> +]]></echo> + </target> + + <target name="compile" unless="BuildAPITOC.uptodate"> + <echo file="BuildAPITOC.java"><![CDATA[ +import java.io.*; +public class BuildAPITOC { + public static void main(String[] args) throws Exception { + BufferedReader r = new BufferedReader(new FileReader(args[0])); + String line; + try { + while ((line = r.readLine()) != null) + System.out.println("<topic label=\"" + line + "\" href=\"html/reference/api/" + line.replace('.', '/') + "/package-summary.html\"/>"); + } finally { + r.close(); + } + } +} +]]></echo> + <javac srcDir="." includes="BuildAPITOC.java"/> + </target> + + <target name="clean"> + <delete> + <fileset dir="." includes="BuildAPITOC.*,tocapi.xml"/> + </delete> + </target> +</project>
\ No newline at end of file diff --git a/doc/bundles/org.eclipse.ecf.doc/buildschematoc.xml b/doc/bundles/org.eclipse.ecf.doc/buildschematoc.xml new file mode 100644 index 000000000..864553a69 --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/buildschematoc.xml @@ -0,0 +1,48 @@ +<project default="toc"> + + <target name="init"> + <property name="dest.path" location="${basedir}/html/reference/extension-points"/> + <uptodate property="BuildExtPointTOC.uptodate" targetfile="BuildExtPointTOC.class"> + <srcfiles dir="${dest.path}" includes="*.html"/> + </uptodate> + </target> + + <target name="toc" depends="init,compile"> + <echo file="tocextpoint.xml"><![CDATA[ +<toc label="Extension Points"> +]]></echo> + <java classname="BuildExtPointTOC" classpath="." output="tocextpoint.xml" append="true"> + <arg line="${dest.path}"/> + </java> + <echo file="tocextpoint.xml" append="true"><![CDATA[ +</toc> +]]></echo> + </target> + + <target name="compile" unless="BuildExtPointTOC.uptodate"> + <echo file="BuildExtPointTOC.java"><![CDATA[ +import java.io.*; +public class BuildExtPointTOC { + public static void main(String[] args) throws Exception { + File dir = new File(args[0]); + File[] files = dir.listFiles(new FileFilter() { + public boolean accept(File file) { + return file.isFile() && file.getName().endsWith(".html"); + } + }); + for (int i = 0; i < files.length; ++i) { + String name = files[i].getName(); + System.out.println("<topic label=\"" + name.substring(0, name.indexOf('.')).replace('_', '.') + "\" href=\"html/reference/extension-points/" + name + "\"/>"); + } + } +} +]]></echo> + <javac srcDir="." includes="BuildExtPointTOC.java"/> + </target> + + <target name="clean"> + <delete> + <fileset dir="." includes="BuildExtPointTOC.*,tocextpoint.xml"/> + </delete> + </target> +</project>
\ No newline at end of file diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/.cvsignore b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/.cvsignore new file mode 100644 index 000000000..2d19fc766 --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.comm.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.comm.html deleted file mode 100644 index eebdd042d..000000000 --- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.comm.html +++ /dev/null @@ -1,130 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>ECF Connection Factory</title> - -<style>@import url("file:/c:/cygwin/home/pnehrer/eclipse-SDK-3.1M4/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/book.css");</style> -<style>@import url("file:/c:/cygwin/home/pnehrer/eclipse-SDK-3.1M4/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/schema.css");</style></head> - -<body> -<h1><center>ECF Connection Factory</center></h1> -<p></p> -<h6 class="CaptionFigColumn" id="header">Identifier: </h6>org.eclipse.ecf.comm<p></p> -<h6 class="CaptionFigColumn" id="header">Since: </h6>0.2.0 -<p></p> - -<p> -</p><h6 class="CaptionFigColumn" id="header">Description: </h6>This -extension allows plugins to register themselves as 'providers' of ECF -connection factories. Once registered via this extension point, plugins -can provide implementations of custom ISynchAsynchConnection instances -via the ECF connection factory (<b>org.eclipse.ecf.core.comm.ConnectionFactory</b>). -<p>Plugins using this extension point can define new implementation -classes of the core ISynchAsynchConnection interface. When client -requests are made to ECF to create <b>ISynchAsynchConnection</b> -instances via the ConnectionFactory.makeSynchAsynchConnection() -methods, requests to create instances of the appropriate type will be -re-directed to the given extension.</p> -<p></p><h6 class="CaptionFigColumn" id="header">Configuration Markup:</h6><p></p> -<p class="code" id="dtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.connectionFactory">connectionFactory</a>)></p> -<p class="code" id="dtd"><!ATTLIST extension</p> -<p class="code" id="dtdAttlist">point CDATA #REQUIRED</p><p class="code" id="dtdAttlist">id CDATA #IMPLIED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED></p> -<p></p> -<ul class="ConfigMarkup" id="attlistDesc"> -</ul> -<br><p class="code" id="dtd"><!ELEMENT <a name="e.connectionFactory">connectionFactory</a> (<a href="#e.defaultargument">defaultargument</a>)></p> -<p class="code" id="dtd"><!ATTLIST connectionFactory</p> -<p class="code" id="dtdAttlist">class CDATA #REQUIRED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED</p><p class="code" id="dtdAttlist">description CDATA #IMPLIED></p> -<p></p> -<p class="ConfigMarkup" id="elementDesc"> -Connection factory definition</p> -<br> -<ul class="ConfigMarkup" id="attlistDesc"> -<li><b>class</b> - Required class that provides implementation of connection factory. The class must implement <b>org.eclipse.ecf.core.comm.provider.ISynchAsynchConnectionInstantiator</b></li> -<li><b>name</b> - Optional name for connection factory. If this name is not explicitly given, the class will be used for the name.</li> -<li><b>description</b> - An optional description for the connection factory.</li> -</ul> -<br><p class="code" id="dtd"><!ELEMENT <a name="e.defaultargument">defaultargument</a> EMPTY></p> -<p class="code" id="dtd"><!ATTLIST defaultargument</p> -<p class="code" id="dtdAttlist">type CDATA #IMPLIED</p><p class="code" id="dtdAttlist">value CDATA #IMPLIED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED></p> -<p></p> -<p class="ConfigMarkup" id="elementDesc"> -Default argument to be passed to makeInstance method. Value of this -element (if any) is used to provide a default value for the given -argument</p> -<br> -<ul class="ConfigMarkup" id="attlistDesc"> -<li><b>type</b> - The fully qualified type of the argument.</li> -<li><b>value</b> - The value for the default argument</li> -<li><b>name</b> - An optional name for the defaultargument</li> -</ul> -<br><h6 class="CaptionFigColumn" id="header">Examples: </h6>Here's an extension that associates a class org.eclipse.ecf.test.FooContainerFactory with name 'foo' in the ECF <b>SharedObjectContainerFactory</b>: - -<pre> <p class="code" id="tag"><extension - point=</p><p class="code" id="cstring">"org.eclipse.ecf.connectionFactory"</p><p class="code" id="tag">></p> - <p class="code" id="tag"><connectionFactory - class=</p><p class="code" id="cstring">"org.eclipse.ecf.provider.comm.tcp.Client$Creator"</p><p class="code" id="tag"> - description=</p><p class="code" id="cstring">"TCP Client Connection Factory"</p><p class="code" id="tag"> - name=</p><p class="code" id="cstring">"org.eclipse.ecf.provider.comm.tcp.Client"</p><p class="code" id="tag">></p> - <p class="code" id="tag"><defaultargument - value=</p><p class="code" id="cstring">"10000"</p><p class="code" id="tag"> - type=</p><p class="code" id="cstring">"java.lang.Integer"</p><p class="code" id="tag"> - name=</p><p class="code" id="cstring">"keepAlive"</p><p class="code" id="tag">/></p> - <p class="code" id="tag"></connectionFactory></p> - <p class="code" id="tag"></extension></p> -</pre> - -Here's an example implementation of this extension point: - -<pre> public ISynchAsynchConnection makeInstance(ConnectionDescription description, - ISynchAsynchConnectionEventHandler handler, Class[] clazzes, - Object[] args) throws ConnectionInstantiationException { - try { - String [] argVals = description.getArgDefaults(); - Integer ka = null; - if (argVals != null && argVals.length != 0) { - String val = argVals[0]; - if (val != null) { - ka = new Integer(val); - } - } - if (args != null && args.length != 0) { - if (args[0] instanceof Integer) { - ka = (Integer) args[0]; - } else if (args[0] instanceof String) { - ka = new Integer((String) args[0]); - } - } - return new Client(handler, ka); - } catch (Exception e) { - throw new ConnectionInstantiationException( - "Exception in creating connection " - + Client.class.getName(), e); - } - } -</pre> -<p></p> - -<h6 class="CaptionFigColumn" id="header">API Information: </h6>The API for this extension point is provided by the <b>org.eclipse.ecf.core.comm.ContainerFactory</b> -static methods. Specifically, the 'makeSynchAsynchConnection' static -methods are to be used by clients. The functionality provided by the -extension point mechanism can be used at runtime via the <b>ConnectionFactory.addDescription(ConnectionDescription)</b> method. The available connection factories can be queried with the <b>ConnectionFactory.getDescriptions()</b> method. -<p></p> - -<h6 class="CaptionFigColumn" id="header">Supplied Implementation: </h6>The supplied implementations of this extension point are: - -In org.eclipse.ecf.provider plugin: - -org.eclipse.ecf.provider.tcp.Client$Creator -<p></p> - -<br> -<p class="note" id="copyright"> -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 -</p><p></p> - -<p></p> -</body></html>
\ No newline at end of file diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.containerFactory.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.containerFactory.html deleted file mode 100644 index 988d35406..000000000 --- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.containerFactory.html +++ /dev/null @@ -1,143 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>ECF Container Factory</title> - -<style>@import url("file:/c:/cygwin/home/pnehrer/eclipse-SDK-3.1M4/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/book.css");</style> -<style>@import url("file:/c:/cygwin/home/pnehrer/eclipse-SDK-3.1M4/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/schema.css");</style></head> - -<body> -<h1><center>ECF Container Factory</center></h1> -<p></p> -<h6 class="CaptionFigColumn" id="header">Identifier: </h6>org.eclipse.ecf.containerFactory<p></p> -<h6 class="CaptionFigColumn" id="header">Since: </h6>0.0.1 -<p></p> - -<p> -</p><h6 class="CaptionFigColumn" id="header">Description: </h6>This -extension allows plugins to register themselves as 'providers' of ECF -shared object containers. Once registered via this extension point, -plugins can then provide there own implementations of -ISharedObjectContainer in response to client request of the ECF -container factory (<b>org.eclipse.ecf.core.SharedObjectContainerFactory</b>). -<p>Plugins using this extension point can define a new implementation -of any desired communications protocol, and expose that protocol as an -instance of an <b>ISharedObjectContainer</b>. When client requests are made to ECF SharedObjectContainerFactory to create <b>ISharedObjectContainer</b> instances, those requests will be re-directed to the given ISharedObjectContainer implementer.</p> -<p></p><h6 class="CaptionFigColumn" id="header">Configuration Markup:</h6><p></p> -<p class="code" id="dtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.containerFactory">containerFactory</a>+)></p> -<p class="code" id="dtd"><!ATTLIST extension</p> -<p class="code" id="dtdAttlist">point CDATA #REQUIRED</p><p class="code" id="dtdAttlist">id CDATA #IMPLIED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED></p> -<p></p> -<ul class="ConfigMarkup" id="attlistDesc"> -</ul> -<br><p class="code" id="dtd"><!ELEMENT <a name="e.containerFactory">containerFactory</a> (<a href="#e.defaultargument">defaultargument</a>* , <a href="#e.property">property</a>*)></p> -<p class="code" id="dtd"><!ATTLIST containerFactory</p> -<p class="code" id="dtdAttlist">class CDATA #REQUIRED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED</p><p class="code" id="dtdAttlist">description CDATA #IMPLIED></p> -<p></p> -<p class="ConfigMarkup" id="elementDesc"> -The container factory extension point. Can optionally contain a list of -'defaultargument' elements that describe the arguments (and provide -default values) to be passed to provider implementation</p> -<br> -<ul class="ConfigMarkup" id="attlistDesc"> -<li><b>class</b> - The class implementing the containerFactory extension point. The given class must implement the <b>org.eclipse.ecf.core.provider.ISharedObjectContainerInstantiator</b> interface</li> -<li><b>name</b> - An optional name for the extension. If no name is -explicitly provided by the extension, the containerFactory class name -is used as the name. Note that this name must <b>not</b> conflict with -any other name in the ECF SharedObjectContainerFactory in order to be -successfully registered. Care should therefore be taken in selection of -a name such that it does not conflict with other pre-existing names for -this factory implementations</li> -<li><b>description</b> - An optional description of the implementation of this extension point</li> -</ul> -<br><p class="code" id="dtd"><!ELEMENT <a name="e.defaultargument">defaultargument</a> EMPTY></p> -<p class="code" id="dtd"><!ATTLIST defaultargument</p> -<p class="code" id="dtdAttlist">type CDATA #IMPLIED</p><p class="code" id="dtdAttlist">value CDATA #IMPLIED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED></p> -<p></p> -<p class="ConfigMarkup" id="elementDesc"> -Default argument to be passed to <b>org.eclipse.ecf.core.provider.makeInstance()</b> method. Value of this element (if any) is used to indicate a default value for the given argument</p> -<br> -<ul class="ConfigMarkup" id="attlistDesc"> -<li><b>type</b> - The fully qualified type of the default argument</li> -<li><b>value</b> - The value for the default argument</li> -<li><b>name</b> - An optional name for the defaultargument element</li> -</ul> -<br><p class="code" id="dtd"><!ELEMENT <a name="e.property">property</a> EMPTY></p> -<p class="code" id="dtd"><!ATTLIST property</p> -<p class="code" id="dtdAttlist">name CDATA #REQUIRED</p><p class="code" id="dtdAttlist">value CDATA #REQUIRED></p> -<p></p> -<p class="ConfigMarkup" id="elementDesc"> -Property (name,value) associated with SharedObjectContainerDescription</p> -<br> -<ul class="ConfigMarkup" id="attlistDesc"> -<li><b>name</b> - The name of the property</li> -<li><b>value</b> - The value of the property</li> -</ul> -<br><h6 class="CaptionFigColumn" id="header">Examples: </h6>Here's an extension that associates a class org.eclipse.ecf.test.FooContainerFactory with name 'foo' in the ECF <b>SharedObjectContainerFactory</b>: - -<pre><p class="code" id="tag"><extension point=</p><p class="code" id="cstring">"org.eclipse.ecf.containerFactory"</p><p class="code" id="tag">></p> - <p class="code" id="tag"><containerFactory name=</p><p class="code" id="cstring">"foo"</p><p class="code" id="tag"> class=</p><p class="code" id="cstring">"org.eclipse.ecf.test.FooContainerFactory"</p><p class="code" id="tag"> description=</p><p class="code" id="cstring">"My container factory"</p><p class="code" id="tag">/></p> - <p class="code" id="tag"><defaultargument type=</p><p class="code" id="cstring">"java.lang.String"</p><p class="code" id="tag"> value=</p><p class="code" id="cstring">"defaultvalue"</p><p class="code" id="tag"> name=</p><p class="code" id="cstring">"variablename"</p><p class="code" id="tag">/></p> -<p class="code" id="tag"></extension></p> -</pre> - -Here is some example code to implement this class: - -<pre>package org.eclipse.ecf.test; - -import org.eclipse.ecf.core.ISharedObjectContainer; -import org.eclipse.ecf.core.SharedObjectContainerInstantiationException; -import org.eclipse.ecf.core.provider.ISharedObjectContainerInstantiator; - -public class FooContainerFactory implements ISharedObjectContainerInstantiator { - - public FooContainerFactory() { - super(); - } - public ISharedObjectContainer makeInstance(SharedObjectContainterDescription description, Class[] argTypes, Object[] args) - throws SharedObjectContainerInstantiationException { - // Create/return instance of FooSharedObjectContainer - // Note that FooSharedObjectContainer class must - // implement ISharedObjectContainer - return new FooSharedObjectContainer(); - } -} -</pre> - -In this example, the given class implements the <b>ISharedObjectContainerInstantiator</b>.makeInstance -method by creating and returning a new instance of -FooSharedObjectContainer, a class also defined in the extension plugin. -As noted in the code, this class must implement <b>ISharedObjectContainer</b>, so that it can successfully be returned from makeInstance. - -<h3>Example Usage of Container by Clients</h3> - -Clients that wish to use the 'foo' container implementation can do so simply by making the following call to create an <b>ISharedObjectContainer</b>: - -<pre>ISharedObjectContainer newContainer = SharedObjectContainerFactory.makeSharedObjectContainer('foo'); -// Further use of newContainer instance here - -</pre> -<p></p> - -<h6 class="CaptionFigColumn" id="header">API Information: </h6>The API for this extension point is provided by the <b>org.eclipse.ecf.core.SharedObjectContainerFactory</b> -static methods. Specifically, the 'makeSharedObjectContainer' static -methods are to be used by clients. The functionality provided by the -extension point mechanism can be used at runtime via the <b>SharedObjectContainerFactory.addDescription(SharedObjectContainerDescription)</b> method. -<p></p> - -<h6 class="CaptionFigColumn" id="header">Supplied Implementation: </h6>The supplied implementations of this extension point are: - -org.eclipse.ecf.provider.generic.ContainerInstantiator -<b>TEST</b>: org.eclipse.ecf.test.TestContainer -<p></p> - -<br> -<p class="note" id="copyright"> -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 -</p><p></p> - -<p></p> -</body></html>
\ No newline at end of file diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.namespace.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.namespace.html deleted file mode 100644 index 4b4a232f5..000000000 --- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org.eclipse.ecf.namespace.html +++ /dev/null @@ -1,133 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>ECF Namespace</title> - -<style>@import url("file:/c:/cygwin/home/pnehrer/eclipse-SDK-3.1M4/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/book.css");</style> -<style>@import url("file:/c:/cygwin/home/pnehrer/eclipse-SDK-3.1M4/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/schema.css");</style></head> - -<body> -<h1><center>ECF Namespace</center></h1> -<p></p> -<h6 class="CaptionFigColumn" id="header">Identifier: </h6>org.eclipse.ecf.namespace<p></p> -<h6 class="CaptionFigColumn" id="header">Since: </h6>1.0.0 -<p></p> - -<p> -</p><h6 class="CaptionFigColumn" id="header">Description: </h6>Extension -point that allows other plugins to define new Namespaces for -instantiating new types of identity. Plugins can register themselves as -'providers' for namespaces that they define, and will then be called -when ECF clients use the <b>org.eclipse.ecf.core.identity.IDFactory.makeID</b> identity factory. -<p> -Plugins implementing this extension point must define an instantiatorClass that implements <b>org.eclipse.ecf.core.identity.provider.IDInstantiator</b>.</p> -<p></p><h6 class="CaptionFigColumn" id="header">Configuration Markup:</h6><p></p> -<p class="code" id="dtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.namespace">namespace</a>+)></p> -<p class="code" id="dtd"><!ATTLIST extension</p> -<p class="code" id="dtdAttlist">point CDATA #REQUIRED</p><p class="code" id="dtdAttlist">id CDATA #IMPLIED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED></p> -<p></p> -<ul class="ConfigMarkup" id="attlistDesc"> -</ul> -<br><p class="code" id="dtd"><!ELEMENT <a name="e.namespace">namespace</a> EMPTY></p> -<p class="code" id="dtd"><!ATTLIST namespace</p> -<p class="code" id="dtdAttlist">instantiatorClass CDATA #REQUIRED</p><p class="code" id="dtdAttlist">name CDATA #IMPLIED</p><p class="code" id="dtdAttlist">namespaceClass CDATA #IMPLIED</p><p class="code" id="dtdAttlist">description CDATA #IMPLIED></p> -<p></p> -<p class="ConfigMarkup" id="elementDesc"> -Element allowing extension plugins to define new namespaces</p> -<br> -<ul class="ConfigMarkup" id="attlistDesc"> -<li><b>instantiatorClass</b> - Required class name. <b>Must</b> implement <b>org.eclipse.identity.provider.IDInstantiator</b></li> -<li><b>name</b> - Optional name for new namespace. If not provided, the -name will be assumed to be the fully qualified name of the -instantiatorClass. Note that this name must <b>not</b> conflict with -any other namespace name in the ECF IDFactory in order to be -successfully registered. Care should therefore be taken in selection of -a name such that it does not conflict with other implementations.</li> -<li><b>namespaceClass</b> - Optional class name of the Namespace class. Defaults to <b>org.eclipse.ecf.core.identity.Namespace</b>. -Implementers may choose to create a subclass of the Namespace class, -and can provide that class name here to use that class as the Namespace -implementation. Note that the class, if provided, <b>must</b> extend <b>org.eclipse.ecf.core.identity.Namespace</b> and also must implement the two public constructors defined in the Namespace superclass.</li> -<li><b>description</b> - An optional description for the implementation of this extension point</li> -</ul> -<br><h6 class="CaptionFigColumn" id="header">Examples: </h6>Here's an extension definition that associates an namespace instantiatorClass with namespace 'testid' in the ECF <b>org.eclipse.ecf.core.identity.IDFactory</b>: - -<pre> <p class="code" id="tag"><extension point=</p><p class="code" id="cstring">"org.eclipse.ecf.namespace"</p><p class="code" id="tag">></p> - <p class="code" id="tag"><namespace name=</p><p class="code" id="cstring">"testid"</p><p class="code" id="tag"> instantiatorClass=</p><p class="code" id="cstring">"org.eclipse.ecf.test.FooIDInstantiator"</p><p class="code" id="tag"> description=</p><p class="code" id="cstring">"my namespace implementation"</p><p class="code" id="tag">/></p> - <p class="code" id="tag"></extension></p> -</pre> - -Here is some example code to implement this FooIDInstantiator class: - -<pre>package org.eclipse.ecf.test; - -import org.eclipse.ecf.core.identity.ID; -import org.eclipse.ecf.core.identity.IDInstantiationException; -import org.eclipse.ecf.core.identity.Namespace; - -public class FooIDInstantiator implements - org.eclipse.ecf.core.identity.provider.IDInstantiator { - - public FooIDInstantiator() { - super(); - } - public ID makeInstance(Namespace ns, Class[] argTypes, Object[] args) - throws IDInstantiationException { - return new FooID(ns, (String) args[0]); - } -} -</pre> - -In this example, the given class implements the <b>IDInstantiator</b>.makeInstance -method by creating and returning a new instance of FooID, a class also -defined in the extension plugin. This class must implement <b>ID</b>, so that it can successfully be returned from makeInstance. - -<h3>Example Usage of IDFactory by Clients</h3> - -Clients that wish to use the 'testid' ID instantiator implementation can do so simply by making the following call to create an <b>IDFactory</b>: - -<pre>ID newID = IDFactory.makeID('testid','email@emailserver.com'); -// Further use of newID instance here - -</pre> -<p></p> - -<h6 class="CaptionFigColumn" id="header">API Information: </h6>The API for this extension point is provided by the <b>org.eclipse.ecf.core.IDFactory</b> -static methods. Specifically, the 'makeID' static methods are to be -used by clients. The functionality provided by the extension point -mechanism can be used at runtime via the <b>IDFactory.addNamespace(Namespace)</b> method. -<p></p> - -<h6 class="CaptionFigColumn" id="header">Supplied Implementation: </h6>The following implementations of this extension point are provided by ECF itself: -<p> -StringID -- A namespace of ID instances that are implemented by <b>org.eclipse.ecf.core.identity.StringID</b> -</p><p>Clients may use this namespace with calls to: -</p><pre>ID newID = org.eclipse.ecf.core.identity.IDFactory.makeStringID('idstringvalue'); -</pre> -<p></p> -<p></p> -<p> -LongID -- A namespace of ID instances that are implemented by <b>org.eclipse.ecf.core.identity.LongID</b> -</p><p>Clients may use this namespace with calls to: -</p><pre>ID newID = org.eclipse.ecf.core.identity.IDFactory.makeLongID(2004L); -</pre> -<p></p> -<p></p> -<p> -GUID -- A namespace of ID instances that are implemented by <b>org.eclipse.ecf.core.identity.GUID</b> -</p><p>Clients may use this namespace with calls to: -</p><pre>ID newID = org.eclipse.ecf.core.identity.IDFactory.makeGUID(16); -</pre> -<p></p> -<p></p> -<p></p> - -<br> -<p class="note" id="copyright"> -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 -</p><p></p> - -<p></p> -</body></html>
\ No newline at end of file diff --git a/doc/bundles/org.eclipse.ecf.doc/javadoc.xml b/doc/bundles/org.eclipse.ecf.doc/javadoc.xml index f52ce9ce0..9e366f7a1 100644 --- a/doc/bundles/org.eclipse.ecf.doc/javadoc.xml +++ b/doc/bundles/org.eclipse.ecf.doc/javadoc.xml @@ -2,7 +2,12 @@ <project default="javadoc"> <target name="javadoc"> <javadoc access="public" author="true" classpath="." destdir="html/reference/api" doctitle="Eclipse Communication Framework (ECF) 1.0.0" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" packagenames="org.eclipse.ecf.core.comm,org.eclipse.ecf.provider,org.eclipse.ecf.sdo.emf,org.eclipse.ecf.core.identity,org.eclipse.ecf.provider.generic.events,org.eclipse.ecf.core.identity.provider,org.eclipse.ecf.provider.comm.tcp,org.eclipse.ecf.provider.generic.gmm,org.eclipse.ecf.provider.app,org.eclipse.ecf.provider.generic,org.eclipse.ecf.sdo,org.eclipse.ecf.provider.generic.user,org.eclipse.ecf.core,org.eclipse.ecf.provider.generic.sobject,org.eclipse.ecf.core.user,org.eclipse.ecf.core.provider,org.eclipse.ecf.core.events,org.eclipse.ecf.core.util,org.eclipse.ecf.core.comm.provider" source="1.4" sourcepath="../org.eclipse.ecf.sdo/src;../org.eclipse.ecf.provider/src;../org.eclipse.ecf/src" splitindex="true" use="true" version="true"> - <link href="http://java.sun.com/j2se/1.4.1/docs/api"/> + <link href="http://java.sun.com/j2se/1.4.2/docs/api"/> </javadoc> </target> + <target name="clean"> + <delete> + <fileset dir="html/reference/api" includes="**/*.html,**/*.css,**/*.gif,package-list"/> + </delete> + </target> </project> diff --git a/doc/bundles/org.eclipse.ecf.doc/plugin.xml b/doc/bundles/org.eclipse.ecf.doc/plugin.xml index d683d740b..7fb877a07 100644 --- a/doc/bundles/org.eclipse.ecf.doc/plugin.xml +++ b/doc/bundles/org.eclipse.ecf.doc/plugin.xml @@ -26,6 +26,12 @@ file="tocreference.xml"> </toc> <toc + file="tocapi.xml"> + </toc> + <toc + file="tocextpoint.xml"> + </toc> + <toc file="tocsamples.xml"> </toc> </extension> diff --git a/doc/bundles/org.eclipse.ecf.doc/schema.xml b/doc/bundles/org.eclipse.ecf.doc/schema.xml new file mode 100644 index 000000000..2e3ec1317 --- /dev/null +++ b/doc/bundles/org.eclipse.ecf.doc/schema.xml @@ -0,0 +1,48 @@ +<project default="schema"> + + <property name="dest.path" value="html/reference/extension-points"/> + + <target name="org.eclipse.ecf"> + <eclipse.convertPath property="org.eclipse.ecf.manifest" resourcePath="/org.eclipse.ecf/plugin.xml"/> + <antcall target="_plugin"> + <param name="manifest.path" value="${org.eclipse.ecf.manifest}"/> + </antcall> + </target> + + <target name="org.eclipse.ecf.provider"> + <eclipse.convertPath property="org.eclipse.ecf.provider.manifest" resourcePath="/org.eclipse.ecf.provider/plugin.xml"/> + <antcall target="_plugin"> + <param name="manifest.path" value="${org.eclipse.ecf.provider.manifest}"/> + </antcall> + </target> + + <target name="org.eclipse.ecf.ui"> + <eclipse.convertPath property="org.eclipse.ecf.ui.manifest" resourcePath="/org.eclipse.ecf.ui/plugin.xml"/> + <antcall target="_plugin"> + <param name="manifest.path" value="${org.eclipse.ecf.ui.manifest}"/> + </antcall> + </target> + + <target name="org.eclipse.ecf.sdo"> + <eclipse.convertPath property="org.eclipse.ecf.sdo.manifest" resourcePath="/org.eclipse.ecf.sdo/plugin.xml"/> + <antcall target="_plugin"> + <param name="manifest.path" value="${org.eclipse.ecf.sdo.manifest}"/> + </antcall> + </target> + + <target name="schema" depends="org.eclipse.ecf,org.eclipse.ecf.provider,org.eclipse.ecf.ui,org.eclipse.ecf.sdo"> + <!-- unfortunately, the task generates local filesystem references... fix them! --> + <property name="cssurl" value="${osgi.install.area}plugins/org.eclipse.platform.doc.isv_3.1.0"/> + <replace dir="${dest.path}" token="${cssurl}" value="../../../../org.eclipse.platform.doc.isv" includes="*.html"/> + </target> + + <target name="_plugin"> + <pde.convertSchemaToHTML manifest="${manifest.path}" destination="${dest.path}"/> + </target> + + <target name="clean"> + <delete> + <fileset dir="${dest.path}" includes="*.html"/> + </delete> + </target> +</project>
\ No newline at end of file diff --git a/doc/bundles/org.eclipse.ecf.doc/tocreference.xml b/doc/bundles/org.eclipse.ecf.doc/tocreference.xml index cce211cbe..44d9d1f31 100644 --- a/doc/bundles/org.eclipse.ecf.doc/tocreference.xml +++ b/doc/bundles/org.eclipse.ecf.doc/tocreference.xml @@ -2,10 +2,10 @@ <?NLS TYPE="org.eclipse.help.toc"?> <toc label="Reference" link_to="toc.xml#reference"> - <topic label="JavaDoc" href="html/reference/api/index.html"/> + <topic label="JavaDoc" href="html/reference/api/overview-summary.html"> + <link toc="tocapi.xml"/> + </topic> <topic label="Extension Points"> - <topic label="org.eclipse.ecf.comm" href="html/reference/extension-points/org.eclipse.ecf.comm.html"/> - <topic label="org.eclipse.ecf.containerFactory" href="html/reference/extension-points/org.eclipse.ecf.containerFactory.html"/> - <topic label="org.eclipse.ecf.namespace" href="html/reference/extension-points/org.eclipse.ecf.namespace.html"/> + <link toc="tocextpoint.xml"/> </topic> </toc> |