Attachment 94858 Details for Bug 200541 – Renaming ext.point to terminalConnectors + Adding some Javadocs

[patch] Renaming ext.point to terminalConnectors + Adding some Javadocs

terminalConnectors.diff.txt (text/plain), 20.41 KB, created by Martin Oberhuber

on 2008-04-04 11:03:23 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Oberhuber

Created: 2008-04-04 11:03:23 EDT

Size: 20.41 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.tm.terminal.ssh
>Index: plugin.xml
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal.ssh/plugin.xml,v
>retrieving revision 1.7
>diff -u -r1.7 plugin.xml
>--- plugin.xml	3 Oct 2007 01:04:57 -0000	1.7
>+++ plugin.xml	4 Apr 2008 14:58:56 -0000
>@@ -13,7 +13,7 @@
> -->
> <plugin>
> <extension
>- point="org.eclipse.tm.terminal.terminalConnector">
>+ point="org.eclipse.tm.terminal.terminalConnectors">
> <connector name="%sshConnection"
> id="org.eclipse.tm.internal.terminal.ssh.SshConnector"
> class="org.eclipse.tm.internal.terminal.ssh.SshConnector"/>
>#P org.eclipse.tm.terminal.telnet
>Index: plugin.xml
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal.telnet/plugin.xml,v
>retrieving revision 1.2
>diff -u -r1.2 plugin.xml
>--- plugin.xml	3 Oct 2007 01:05:04 -0000	1.2
>+++ plugin.xml	4 Apr 2008 14:58:57 -0000
>@@ -13,7 +13,7 @@
> -->
> <plugin>
> <extension
>- point="org.eclipse.tm.terminal.terminalConnector">
>+ point="org.eclipse.tm.terminal.terminalConnectors">
> <connector name="%telnetConnection"
> id="org.eclipse.tm.internal.terminal.telnet.TelnetConnector"
> class="org.eclipse.tm.internal.terminal.telnet.TelnetConnector"/>
>#P org.eclipse.tm.terminal.test
>Index: plugin.xml
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal.test/plugin.xml,v
>retrieving revision 1.1
>diff -u -r1.1 plugin.xml
>--- plugin.xml	4 Oct 2007 18:44:58 -0000	1.1
>+++ plugin.xml	4 Apr 2008 14:59:00 -0000
>@@ -1,7 +1,7 @@
> <?xml version="1.0" encoding="UTF-8"?>
> <?eclipse version="3.2"?>
> 
> <plugin>
> <extension
>- point="org.eclipse.tm.terminal.terminalConnector">
>+ point="org.eclipse.tm.terminal.terminalConnectors">
> <connector name="Speed Test" 
> id="org.eclipse.tm.internal.terminal.speedtest.SpeedTestConnector"
> class="org.eclipse.tm.internal.terminal.speedtest.SpeedTestConnector"/>
>#P org.eclipse.tm.terminal
>Index: plugin.xml
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal/plugin.xml,v
>retrieving revision 1.9
>diff -u -r1.9 plugin.xml
>--- plugin.xml	5 Jun 2007 12:48:29 -0000	1.9
>+++ plugin.xml	4 Apr 2008 14:59:01 -0000
>@@ -1,7 +1,7 @@
> <?xml version="1.0" encoding="UTF-8"?>
> <?eclipse version="3.0"?>
> 
> <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"
>Index: src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java,v
>retrieving revision 1.5
>diff -u -r1.5 ITerminalConnector.java
>--- src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java	4 Apr 2008 13:52:06 -0000	1.5
>+++ src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java	4 Apr 2008 14:59:01 -0000
>@@ -1,11 +1,11 @@
> /*******************************************************************************
>- * Copyright (c) 2006, 2007 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: 
>+ * 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
> *******************************************************************************/
>@@ -17,19 +17,21 @@
> 
> 
> /**
>- * Manage a single connection. Implementations of this class are contributed 
>- * via <code>org.eclipse.tm.terminal.terminalConnector</code> extension point.
>- * This class is a handle to a {@link ITerminalConnector connector} that comes from an
>- * extension. It maintains {@link TerminalConnectorImpl} to the connector to allow lazy initialization of the
>- * real {@link ITerminalConnector connector} that comes from an extension.
>-
>+ * Manage a single connection. Implementations of this class are contributed via
>+ * <code>org.eclipse.tm.terminal.terminalConnectors</code> extension point.
>+ * This class is a handle to a {@link ITerminalConnector connector} that comes
>+ * from an extension. It maintains {@link TerminalConnectorImpl} to the
>+ * connector to allow lazy initialization of the real
>+ * {@link ITerminalConnector connector} that comes from an extension.
>+ *
> * @author Michael Scharf
>- * 
>- * EXPERIMENTAL. This class or interface has been added as
>- * part of a work in progress. There is no guarantee that this API will
>- * work or that it will remain the same. Please do not use this API without
>- * consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
>- * 
>+ * 
>+ * EXPERIMENTAL. This class or interface has been
>+ * added as part of a work in progress. There is no guarantee that this
>+ * API will work or that it will remain the same. Please do not use this
>+ * API without consulting with the <a
>+ * href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
>+ * 
> */
> public interface ITerminalConnector extends IAdaptable {
> 	/**
>@@ -48,7 +50,7 @@
> 	 * returns the error message.
> 	 */
> 	boolean isInitialized();
>-	
>+
> 	/**
> 	 * This method initializes the connector if it is not initialized!
> 	 * If the connector was initialized successfully, <code>null</code> is
>@@ -89,16 +91,16 @@
> OutputStream getTerminalToRemoteStream();
> 
> 	/**
>-	 * Load the state of this connection. Is typically called before 
>+	 * Load the state of this connection. Is typically called before
> 	 * {@link #connect(ITerminalControl)}.
>-	 * 
>-	 * @param store a string based data store. Short keys like "foo" can be used to 
>+	 *
>+	 * @param store a string based data store. Short keys like "foo" can be used to
> 	 * store the state of the connection.
> 	 */
> 	void load(ISettingsStore store);
>-	
>+
> 	/**
>-	 * When the view or dialog containing the terminal is closed, 
>+	 * When the view or dialog containing the terminal is closed,
> 	 * the state of the connection is saved into the settings store <code>store</code>
> 	 * @param store
> 	 */
>@@ -108,13 +110,13 @@
> 	 * @return a new page that can be used in a dialog to setup this connection.
> 	 * The dialog should persist its settings with the {@link #load(ISettingsStore)}
> 	 * and {@link #save(ISettingsStore)} methods.
>-	 * 
>+	 *
> 	 */
> 	ISettingsPage makeSettingsPage();
> 
> 	/**
> 	 * @return A string that represents the settings of the connection. This representation
>-	 * may be shown in the status line of the terminal view. 
>+	 * may be shown in the status line of the terminal view.
> 	 */
> 	String getSettingsSummary();
> 
>Index: src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java,v
>retrieving revision 1.8
>diff -u -r1.8 TerminalConnectorExtension.java
>--- src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java	4 Apr 2008 13:52:06 -0000	1.8
>+++ src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java	4 Apr 2008 14:59:01 -0000
>@@ -1,11 +1,11 @@
> /*******************************************************************************
> * Copyright (c) 2006, 2007 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: 
>+ * 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
> *******************************************************************************/
>@@ -20,7 +20,7 @@
> 
> /**
> * A factory to get {@link ITerminalConnector} instances.
>- * 
>+ *
> * @author Michael Scharf
> *
> * 
>@@ -47,26 +47,39 @@
> 	}
> 
> 	/**
>+	 * Return a specific terminal connector for a given connector id. The
>+	 * terminal connector is not yet instantiated to any real connection.
>+	 *
> 	 * @param id the id of the terminal connector in the
>-	 * <code>org.eclipse.tm.terminal.terminalConnector</code> extension point
>-	 * @return a new ITerminalConnector with id or <code>null</code> if there is no
>-	 * extension with that id.
>+	 * <code>org.eclipse.tm.terminal.terminalConnectors</code>
>+	 * extension point
>+	 * @return a new ITerminalConnector with id or <code>null</code> if there
>+	 * is no extension with that id.
>+	 * @since 3.0
> 	 */
> 	public static ITerminalConnector makeTerminalConnector(String id) {
>-		IConfigurationElement[] config=RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnector"); //$NON-NLS-1$
>+		IConfigurationElement[] config = RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnectors"); //$NON-NLS-1$
> 		for (int i = 0; i < config.length; i++) {
> 			if(id.equals(config[i].getAttribute("id"))) { //$NON-NLS-1$
> 				return makeConnector(config[i]);
> 			}
> 		}
>-		return null;	
>+		return null;
> 	}
> 	/**
>-	 * @return a new list of {@link ITerminalConnector} instances defined in 
>-	 * the <code>org.eclipse.tm.terminal.terminalConnector</code> extension point
>+	 * 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
> 	 */
> 	public static ITerminalConnector[] makeTerminalConnectors() {
>-		IConfigurationElement[] config=RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnector"); //$NON-NLS-1$
>+		IConfigurationElement[] config = RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnectors"); //$NON-NLS-1$
> 		List result=new ArrayList();
> 		for (int i = 0; i < config.length; i++) {
> 			result.add(makeConnector(config[i]));
>Index: schema/terminalConnector.exsd
>===================================================================
>RCS file: schema/terminalConnector.exsd
>diff -N schema/terminalConnector.exsd
>--- schema/terminalConnector.exsd	4 Apr 2008 13:52:07 -0000	1.8
>+++ /dev/null	1 Jan 1970 00:00:00 -0000
>@@ -1,98 +0,0 @@
>-<?xml version='1.0' encoding='UTF-8'?>
>-
>-<schema targetNamespace="org.eclipse.tm.terminal" xmlns="http://www.w3.org/2001/XMLSchema">
>-<annotation>
>- <appinfo>
>- <meta.schema plugin="org.eclipse.tm.terminal" id="terminalConnector" name="TerminalConnector"/>
>- </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 implementing ITerminalConnector
>- </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
>- </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 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>
>Index: schema/terminalConnectors.exsd
>===================================================================
>RCS file: schema/terminalConnectors.exsd
>diff -N schema/terminalConnectors.exsd
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ schema/terminalConnectors.exsd	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,98 @@
>+<?xml version='1.0' encoding='UTF-8'?>
>+
>+<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>
>#P org.eclipse.tm.terminal.serial
>Index: plugin.xml
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/terminal/org.eclipse.tm.terminal.serial/plugin.xml,v
>retrieving revision 1.7
>diff -u -r1.7 plugin.xml
>--- plugin.xml	3 Oct 2007 01:05:01 -0000	1.7
>+++ plugin.xml	4 Apr 2008 14:59:03 -0000
>@@ -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"/>

Actions: View | Diff

Attachments on bug 200541: 94252 | 94317 | 94807 | 94858