1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-01 06:05:24 +02:00

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

This commit is contained in:
Martin Oberhuber 2008-04-04 15:25:53 +00:00
parent 1692d941ab
commit 6e7c3f740e
4 changed files with 105 additions and 7 deletions

View file

@ -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"/>

View file

@ -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"

View file

@ -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>

View file

@ -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$