mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-29 03:45:35 +02:00
Code Issues Wiki Activity

[200541][api][breaking] Rename terminalConnector -> terminalConnectors and add some Javadoc and @since tags

Browse source
This commit is contained in:
Martin Oberhuber 2008-04-04 15:23:10 +00:00
parent fc86a78f14
commit 0c2a2d41ff
6 changed files with 61 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
org.eclipse.tm.terminal.ssh/plugin.xml
View file

@ -13,7 +13,7 @@
--> -->
<plugin> <plugin>
<extension <extension
point="org.eclipse.tm.terminal.terminalConnector"> point="org.eclipse.tm.terminal.terminalConnectors">
<connector name="%sshConnection" <connector name="%sshConnection"
id="org.eclipse.tm.internal.terminal.ssh.SshConnector" id="org.eclipse.tm.internal.terminal.ssh.SshConnector"
class="org.eclipse.tm.internal.terminal.ssh.SshConnector"/> class="org.eclipse.tm.internal.terminal.ssh.SshConnector"/>

2
org.eclipse.tm.terminal.telnet/plugin.xml
View file

@ -13,7 +13,7 @@
--> -->
<plugin> <plugin>
<extension <extension
point="org.eclipse.tm.terminal.terminalConnector"> point="org.eclipse.tm.terminal.terminalConnectors">
<connector name="%telnetConnection" <connector name="%telnetConnection"
id="org.eclipse.tm.internal.terminal.telnet.TelnetConnector" id="org.eclipse.tm.internal.terminal.telnet.TelnetConnector"
class="org.eclipse.tm.internal.terminal.telnet.TelnetConnector"/> class="org.eclipse.tm.internal.terminal.telnet.TelnetConnector"/>

4
org.eclipse.tm.terminal.test/plugin.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.2"?> <?eclipse version="3.2"?>
<!-- <!--
# Copyright (c) 2006 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 # All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0 # are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at # which accompanies this distribution, and is available at
@ -13,7 +13,7 @@
--> -->
<plugin> <plugin>
<extension <extension
point="org.eclipse.tm.terminal.terminalConnector"> point="org.eclipse.tm.terminal.terminalConnectors">
<connector name="Speed Test" <connector name="Speed Test"
id="org.eclipse.tm.internal.terminal.speedtest.SpeedTestConnector" id="org.eclipse.tm.internal.terminal.speedtest.SpeedTestConnector"
class="org.eclipse.tm.internal.terminal.speedtest.SpeedTestConnector"/> class="org.eclipse.tm.internal.terminal.speedtest.SpeedTestConnector"/>

98
org.eclipse.tm.terminal/schema/terminalConnector.exsd
View file

@ -1,98 +0,0 @@
<?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="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>

56
org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java
View file

@ -1,11 +1,11 @@
/******************************************************************************* /*******************************************************************************
* 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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html * http://www.eclipse.org/legal/epl-v10.html
* *
* Contributors: * Contributors:
* Michael Scharf (Wind River) - initial API and implementation * Michael Scharf (Wind River) - initial API and implementation
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified * Martin Oberhuber (Wind River) - fixed copyright headers and beautified
*******************************************************************************/ *******************************************************************************/
@ -17,19 +17,21 @@ import org.eclipse.core.runtime.IAdaptable;
/** /**
* Manage a single connection. Implementations of this class are contributed * Manage a single connection. Implementations of this class are contributed via
* via <code>org.eclipse.tm.terminal.terminalConnector</code> extension point. * <code>org.eclipse.tm.terminal.terminalConnectors</code> extension point.
* This class is a handle to a {@link ITerminalConnector connector} that comes from an * This class is a handle to a {@link ITerminalConnector connector} that comes
* extension. It maintains {@link TerminalConnectorImpl} to the connector to allow lazy initialization of the * from an extension. It maintains {@link TerminalConnectorImpl} to the
* real {@link ITerminalConnector connector} that comes from an extension. * connector to allow lazy initialization of the real
* {@link ITerminalConnector connector} that comes from an extension.
*
* @author Michael Scharf * @author Michael Scharf
* <p> * <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as * <strong>EXPERIMENTAL</strong>. This class or interface has been
* part of a work in progress. There is no guarantee that this API will * added as part of a work in progress. There is no guarantee that this
* work or that it will remain the same. Please do not use this API without * API will work or that it will remain the same. Please do not use this
* consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team. * API without consulting with the <a
* </p> * href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
* </p>
*/ */
public interface ITerminalConnector extends IAdaptable { public interface ITerminalConnector extends IAdaptable {
/** /**
@ -48,7 +50,7 @@ public interface ITerminalConnector extends IAdaptable {
* returns the error message. * returns the error message.
*/ */
boolean isInitialized(); boolean isInitialized();
/** /**
* This method initializes the connector if it is not initialized! * This method initializes the connector if it is not initialized!
* If the connector was initialized successfully, <code>null</code> is * If the connector was initialized successfully, <code>null</code> is
@ -89,16 +91,16 @@ public interface ITerminalConnector extends IAdaptable {
OutputStream getTerminalToRemoteStream(); 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)}. * {@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. * store the state of the connection.
*/ */
void load(ISettingsStore store); 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> * the state of the connection is saved into the settings store <code>store</code>
* @param store * @param store
*/ */
@ -108,13 +110,13 @@ public interface ITerminalConnector extends IAdaptable {
* @return a new page that can be used in a dialog to setup this connection. * @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)} * The dialog should persist its settings with the {@link #load(ISettingsStore)}
* and {@link #save(ISettingsStore)} methods. * and {@link #save(ISettingsStore)} methods.
* *
*/ */
ISettingsPage makeSettingsPage(); ISettingsPage makeSettingsPage();
/** /**
* @return A string that represents the settings of the connection. This representation * @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(); String getSettingsSummary();

43
org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorExtension.java
View file

@ -1,11 +1,11 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2007 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2007 Wind River Systems, Inc. and others.
* All rights reserved. This program and the accompanying materials * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html * http://www.eclipse.org/legal/epl-v10.html
* *
* Contributors: * Contributors:
* Michael Scharf (Wind River) - initial API and implementation * Michael Scharf (Wind River) - initial API and implementation
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified * Martin Oberhuber (Wind River) - fixed copyright headers and beautified
*******************************************************************************/ *******************************************************************************/
@ -20,7 +20,7 @@ import org.eclipse.tm.internal.terminal.connector.TerminalConnector;
/** /**
* A factory to get {@link ITerminalConnector} instances. * A factory to get {@link ITerminalConnector} instances.
* *
* @author Michael Scharf * @author Michael Scharf
* *
* <p> * <p>
@ -47,26 +47,39 @@ public class TerminalConnectorExtension {
} }
/** /**
* 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 * @param id the id of the terminal connector in the
* <code>org.eclipse.tm.terminal.terminalConnector</code> extension point * <code>org.eclipse.tm.terminal.terminalConnectors</code>
* @return a new ITerminalConnector with id or <code>null</code> if there is no * extension point
* extension with that id. * @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) { 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++) { for (int i = 0; i < config.length; i++) {
if(id.equals(config[i].getAttribute("id"))) { //$NON-NLS-1$ if(id.equals(config[i].getAttribute("id"))) { //$NON-NLS-1$
return makeConnector(config[i]); return makeConnector(config[i]);
} }
} }
return null; return null;
} }
/** /**
* @return a new list of {@link ITerminalConnector} instances defined in * Return a list of available terminal connectors (connection types).
* the <code>org.eclipse.tm.terminal.terminalConnector</code> extension point *
* 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() { 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(); List result=new ArrayList();
for (int i = 0; i < config.length; i++) { for (int i = 0; i < config.length; i++) {
result.add(makeConnector(config[i])); result.add(makeConnector(config[i]));