From 6e7c3f740ee48e1d7b05f2d6d101bb2da1449937 Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Fri, 4 Apr 2008 15:25:53 +0000
Subject: [PATCH] [200541][api][breaking] Rename terminalConnector ->
 terminalConnectors and add some Javadoc and @since tags

---
 .../org.eclipse.tm.terminal.serial/plugin.xml |  2 +-
 terminal/org.eclipse.tm.terminal/plugin.xml   |  4 +-
 .../schema/terminalConnectors.exsd            | 98 +++++++++++++++++++
 .../api/TerminalConnectorExtension.java       |  8 +-
 4 files changed, 105 insertions(+), 7 deletions(-)
 create mode 100644 terminal/org.eclipse.tm.terminal/schema/terminalConnectors.exsd

diff --git a/terminal/org.eclipse.tm.terminal.serial/plugin.xml b/terminal/org.eclipse.tm.terminal.serial/plugin.xml
index a7578808e5c..dc3e2863b5b 100644
--- a/terminal/org.eclipse.tm.terminal.serial/plugin.xml
+++ b/terminal/org.eclipse.tm.terminal.serial/plugin.xml
@@ -13,7 +13,7 @@
 -->
 <plugin>
    <extension
-         point="org.eclipse.tm.terminal.terminalConnector">
+         point="org.eclipse.tm.terminal.terminalConnectors">
       <connector name="%serialConnection" 
       id="org.eclipse.tm.internal.terminal.serial.SerialConnector"
       class="org.eclipse.tm.internal.terminal.serial.SerialConnector"/>
diff --git a/terminal/org.eclipse.tm.terminal/plugin.xml b/terminal/org.eclipse.tm.terminal/plugin.xml
index 0f7e5294e56..853af8e9ef3 100644
--- a/terminal/org.eclipse.tm.terminal/plugin.xml
+++ b/terminal/org.eclipse.tm.terminal/plugin.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?eclipse version="3.0"?>
 <!--
-# Copyright (c) 2006, 2007 Wind River Systems, Inc. and others.
+# Copyright (c) 2006, 2008 Wind River Systems, 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
@@ -12,7 +12,7 @@
 # Martin Oberhuber (Wind River) - fixed copyright headers and beautified
 -->
 <plugin>
-   <extension-point id="terminalConnector" name="Terminal Connector" schema="schema/terminalConnector.exsd"/>
+   <extension-point id="terminalConnectors" name="Terminal Connectors" schema="schema/terminalConnectors.exsd"/>
    <extension point="org.eclipse.ui.contexts">           
       <context
             name="%terminal.context.name"
diff --git a/terminal/org.eclipse.tm.terminal/schema/terminalConnectors.exsd b/terminal/org.eclipse.tm.terminal/schema/terminalConnectors.exsd
new file mode 100644
index 00000000000..ad054b5d9f1
--- /dev/null
+++ b/terminal/org.eclipse.tm.terminal/schema/terminalConnectors.exsd
@@ -0,0 +1,98 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- Schema file written by PDE -->
+<schema targetNamespace="org.eclipse.tm.terminal" xmlns="http://www.w3.org/2001/XMLSchema">
+<annotation>
+      <appinfo>
+         <meta.schema plugin="org.eclipse.tm.terminal" id="terminalConnectors" name="Terminal Connectors"/>
+      </appinfo>
+      <documentation>
+         
+      </documentation>
+   </annotation>
+
+   <element name="extension">
+      <complexType>
+         <sequence minOccurs="1" maxOccurs="unbounded">
+            <element ref="connector"/>
+         </sequence>
+         <attribute name="point" type="string" use="required">
+            <annotation>
+               <documentation>
+                  
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="id" type="string">
+            <annotation>
+               <documentation>
+                  
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="name" type="string">
+            <annotation>
+               <documentation>
+                  
+               </documentation>
+               <appinfo>
+                  <meta.attribute translatable="true"/>
+               </appinfo>
+            </annotation>
+         </attribute>
+      </complexType>
+   </element>
+
+   <element name="connector">
+      <complexType>
+         <attribute name="class" type="string" use="required">
+            <annotation>
+               <documentation>
+                  A class extending TerminalConnectorImpl
+               </documentation>
+               <appinfo>
+                  <meta.attribute kind="java" basedOn="org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl:"/>
+               </appinfo>
+            </annotation>
+         </attribute>
+         <attribute name="id" type="string" use="required">
+            <annotation>
+               <documentation>
+                  Uniquely identify this connector for programmatic access. Clients will use this ID in order to find and instantiate it.
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="name" type="string">
+            <annotation>
+               <documentation>
+                  The name of the connection (used in the UI)
+               </documentation>
+               <appinfo>
+                  <meta.attribute translatable="true"/>
+               </appinfo>
+            </annotation>
+         </attribute>
+      </complexType>
+   </element>
+
+
+
+
+
+   <annotation>
+      <appinfo>
+         <meta.section type="copyright"/>
+      </appinfo>
+      <documentation>
+         Copyright (c) 2006, 2008 Wind River Systems, 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: 
+Michael Scharf (Wind River) - initial API and implementation
+Martin Oberhuber (Wind River) - fixed copyright headers and beautified
+      </documentation>
+   </annotation>
+
+</schema>
diff --git a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java
index fc10bc7d5ef..7bd72a5a052 100644
--- a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java
+++ b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java
@@ -55,7 +55,7 @@ public class TerminalConnectorExtension {
 	 *            extension point
 	 * @return a new ITerminalConnector with id or <code>null</code> if there
 	 *         is no extension with that id.
-	 * @since 3.0
+	 * @since org.eclipse.tm.terminal 2.0
 	 */
 	public static ITerminalConnector makeTerminalConnector(String id) {
 		IConfigurationElement[] config = RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnectors"); //$NON-NLS-1$
@@ -68,15 +68,15 @@ public class TerminalConnectorExtension {
 	}
 	/**
 	 * Return a list of available terminal connectors (connection types).
-	 * 
+	 *
 	 * The terminal connectors returned are not yet instantiated to any real
 	 * connection. Each terminal connector can connect to one remote system at a
 	 * time.
-	 * 
+	 *
 	 * @return a new list of {@link ITerminalConnector} instances defined in the
 	 *         <code>org.eclipse.tm.terminal.terminalConnectors</code>
 	 *         extension point
-	 * @since 3.0
+	 * @since org.eclipse.tm.terminal 2.0 return value is ITerminalConnector[]
 	 */
 	public static ITerminalConnector[] makeTerminalConnectors() {
 		IConfigurationElement[] config = RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnectors"); //$NON-NLS-1$