1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-22 16:35:25 +02:00

[200541] Update Javadocs

This commit is contained in:
Martin Oberhuber 2008-04-04 15:57:20 +00:00
parent 23dce55e96
commit 9cb36a7fc8

View file

@ -14,16 +14,28 @@ package org.eclipse.tm.internal.terminal.provisional.api;
import java.io.OutputStream; import java.io.OutputStream;
import org.eclipse.core.runtime.IAdaptable; import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;
import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnectorImpl; import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnectorImpl;
/** /**
* Manage a single connection. Implementations of this class are contributed via * A contributed connection type to manage a single connection.
*
* Implementations of this class are contributed through the
* <code>org.eclipse.tm.terminal.terminalConnectors</code> extension point. * <code>org.eclipse.tm.terminal.terminalConnectors</code> extension point.
* This class is a handle to a {@link ITerminalConnector connector} that comes * This class gives access to the static markup of a terminal connector
* from an extension. It maintains {@link TerminalConnectorImpl} to the * extension as well as providing the lifecycle management for the dynamically
* connector to allow lazy initialization of the real * loaded {@link TerminalConnectorImpl} instance, which performs the actual
* {@link ITerminalConnector connector} that comes from an extension. * communications. This pattern allows for lazy initialization, bundle
* activation and class loading of the actual {@link TerminalConnectorImpl}
* instance.
*
* Clients can get terminal connector instances from the
* {@link TerminalConnectorExtension} class, or from
* {@link ITerminalViewControl#getTerminalConnector()} when running inside an
* active terminal widget.
*
* @noimplement This interface is not intended to be implemented by clients.
* *
* @author Michael Scharf * @author Michael Scharf
* <p> * <p>
@ -37,11 +49,13 @@ import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnect
public interface ITerminalConnector extends IAdaptable { public interface ITerminalConnector extends IAdaptable {
/** /**
* @return an ID of this connector. The id from the plugin.xml. * @return an ID of this connector. The id from the plugin.xml.
* @since org.eclipse.tm.terminal 2.0
*/ */
String getId(); String getId();
/** /**
* @return <code>null</code> the name (as specified in the plugin.xml) * @return <code>null</code> the name (as specified in the plugin.xml)
* @since org.eclipse.tm.terminal 2.0
*/ */
String getName(); String getName();
@ -49,6 +63,7 @@ public interface ITerminalConnector extends IAdaptable {
* @return true if the {@link TerminalConnectorImpl} has been initialized. * @return true if the {@link TerminalConnectorImpl} has been initialized.
* If there was an initialization error, {@link #getInitializationErrorMessage()} * If there was an initialization error, {@link #getInitializationErrorMessage()}
* returns the error message. * returns the error message.
* @since org.eclipse.tm.terminal 2.0
*/ */
boolean isInitialized(); boolean isInitialized();
@ -57,6 +72,7 @@ public interface ITerminalConnector extends IAdaptable {
* If the connector was initialized successfully, <code>null</code> is * If the connector was initialized successfully, <code>null</code> is
* returned. Otherwise an error message describing the problem is returned. * returned. Otherwise an error message describing the problem is returned.
* @return <code>null</code> or a localized error message. * @return <code>null</code> or a localized error message.
* @since org.eclipse.tm.terminal 2.0
*/ */
String getInitializationErrorMessage(); String getInitializationErrorMessage();
@ -88,6 +104,7 @@ public interface ITerminalConnector extends IAdaptable {
* @return the terminal to remote stream (bytes written to this stream will * @return the terminal to remote stream (bytes written to this stream will
* be sent to the remote site). For the stream in the other direction (remote to * be sent to the remote site). For the stream in the other direction (remote to
* terminal see {@link ITerminalControl#getRemoteToTerminalOutputStream()} * terminal see {@link ITerminalControl#getRemoteToTerminalOutputStream()}
* @since org.eclipse.tm.terminal 2.0
*/ */
OutputStream getTerminalToRemoteStream(); OutputStream getTerminalToRemoteStream();