mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-09 01:05:38 +02:00
Code Issues Wiki Activity

[200541] Update Javadocs

Browse source
This commit is contained in:
Martin Oberhuber 2008-04-04 16:04:44 +00:00
parent 9cb36a7fc8
commit 9cae2425af
1 changed files with 27 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/connector/TerminalConnector.java
View file

@ -10,27 +10,42 @@ import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector; import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl; import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.Logger; import org.eclipse.tm.internal.terminal.provisional.api.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState; import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnectorImpl; import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnectorImpl;
/** /**
* A placeholder for the ITerminalConnector. It gets initialized when * A terminal connector instance, also known as terminal connection type.
* the real connector is needed. *
* The following methods can be called without initializing * It provides all terminal connector functions that can be provided by static
* the contributed class: {@link #getId()}, {@link #getName()}, * markup without loading the actual implementation class. The actual
* {@link #getSettingsSummary()},{@link #load(ISettingsStore)}, * {@link TerminalConnectorImpl} implementation class is lazily loaded by the
* provided {@link TerminalConnector.Factory} interface when needed. class, and
* delegates to the actual implementation when needed. The following methods can
* be called without initializing the contributed implementation class:
* {@link #getId()}, {@link #getName()}, {@link #getSettingsSummary()},{@link #load(ISettingsStore)},
* {@link #setTerminalSize(int, int)}, {@link #save(ISettingsStore)}, * {@link #setTerminalSize(int, int)}, {@link #save(ISettingsStore)},
* {@link #getAdapter(Class)} * {@link #getAdapter(Class)}
* *
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
* Clients can get terminal connector instances through the
* {@link TerminalConnectorExtension} class.
* @since org.eclipse.tm.terminal 2.0
*/ */
public class TerminalConnector implements ITerminalConnector { public class TerminalConnector implements ITerminalConnector {
/** /**
* Creates an instance of TerminalConnectorImpl. This is * Creates an instance of TerminalConnectorImpl. This is used to lazily load
* used to lazily load classed defined in extensions. * classed defined in extensions.
*
* @since org.eclipse.tm.terminal 2.0
*/ */
public interface Factory { public interface Factory {
/** /**
* @return an Connector * Factory method to create the actual terminal connector implementation
* when needed.
*
* @return a Connector
* @throws Exception * @throws Exception
*/ */
TerminalConnectorImpl makeConnector() throws Exception; TerminalConnectorImpl makeConnector() throws Exception;