1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-26 10:25:32 +02:00

[cleanup] Fix some @since tag problems

This commit is contained in:
Martin Oberhuber 2008-05-05 12:22:07 +00:00
parent 0b82909c80
commit 33fa542dd5
14 changed files with 291 additions and 186 deletions

View file

@ -24,9 +24,9 @@ import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
/** /**
* An interface used to drive properties into a subsystem during host creation. * An interface used to drive properties into a subsystem during host creation.
* *
* @noimplement This is an internal interface for use in the framework. * This is an internal interface for use in the framework. Potential clients
* Potential clients should extend one of the implementations or * should extend one of the implementations or implement one of the extensions.
* implement one of the extensions. *
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */
public interface ISubSystemConfigurator { public interface ISubSystemConfigurator {

View file

@ -27,10 +27,12 @@ import org.eclipse.rse.ui.filters.dialogs.SystemFilterDialogInputs;
/** /**
* A class capturing the attributes commonly needed by dialogs that * A class capturing the attributes commonly needed by dialogs that work with
* work with filter pools. * filter pools.
* @noextend This class is not intended to be subclassed by clients. *
* This class is complete and should be used as is. * @noextend This class is not intended to be subclassed by clients. This class
* is complete and should be used as is.
* @since 3.0
*/ */
public class SystemFilterPoolDialogInputs extends SystemFilterDialogInputs public class SystemFilterPoolDialogInputs extends SystemFilterDialogInputs
{ {

View file

@ -21,6 +21,8 @@ import org.eclipse.rse.ui.filters.actions.SystemFilterAbstractFilterPoolAction;
/** /**
* Common interface for dialogs or wizards that work with filter pools. * Common interface for dialogs or wizards that work with filter pools.
*
* @since 3.0
*/ */
public interface SystemFilterPoolDialogInterface public interface SystemFilterPoolDialogInterface
{ {

View file

@ -24,10 +24,12 @@ import org.eclipse.rse.ui.dialogs.SystemSimpleContentElement;
/** /**
* A class capturing the attributes commonly returned by dialogs that * A class capturing the attributes commonly returned by dialogs that work with
* work with filter pools. * filter pools.
* @noextend This class is not intended to be subclassed by clients. *
* This class is complete and should be used as is. * @noextend This class is not intended to be subclassed by clients. This class
* is complete and should be used as is.
* @since 3.0
*/ */
public class SystemFilterPoolDialogOutputs public class SystemFilterPoolDialogOutputs
{ {

View file

@ -18,10 +18,10 @@ import org.eclipse.rse.core.model.IHost;
import org.eclipse.rse.core.model.ISystemViewInputProvider; import org.eclipse.rse.core.model.ISystemViewInputProvider;
/** /**
* Public interface for the system resource selection input provider * Public interface for the system resource selection input provider that is
* that is used in the SystemRemoteResourceDialog and the * used in the SystemRemoteResourceDialog and the SystemResourceSelectionForm
* SystemResourceSelectionForm
* *
* @since 3.0
*/ */
public interface ISystemResourceSelectionInputProvider public interface ISystemResourceSelectionInputProvider
extends ISystemViewInputProvider extends ISystemViewInputProvider

View file

@ -18,6 +18,9 @@ import org.eclipse.rse.core.filters.ISystemFilter;
import org.eclipse.rse.core.model.IHost; import org.eclipse.rse.core.model.IHost;
import org.eclipse.rse.core.model.ISystemViewInputProvider; import org.eclipse.rse.core.model.ISystemViewInputProvider;
/**
* @since 3.0
*/
public interface ISystemSelectRemoteObjectAPIProvider public interface ISystemSelectRemoteObjectAPIProvider
extends ISystemViewInputProvider extends ISystemViewInputProvider
{ {

View file

@ -15,6 +15,9 @@ package org.eclipse.rse.ui.view;
import org.eclipse.ui.views.properties.IPropertyDescriptor; import org.eclipse.ui.views.properties.IPropertyDescriptor;
/**
* @since 3.0
*/
public interface ISystemTableViewColumnManager { public interface ISystemTableViewColumnManager {
public IPropertyDescriptor[] getVisibleDescriptors(ISystemViewElementAdapter adapter); public IPropertyDescriptor[] getVisibleDescriptors(ISystemViewElementAdapter adapter);

View file

@ -34,8 +34,13 @@ import org.eclipse.rse.ui.RSEUIPlugin;
/** /**
* This is a base class that a provider of root nodes to the remote systems tree viewer part can * This is a base class that a provider of root nodes to the remote systems tree
* use as a parent class. * viewer part can use as a parent class.
*
* This class existed in RSE 1.0, was made "internal" for RSE 2.0 and restored
* as API for RSE 3.0.
*
* @since 3.0
*/ */
public abstract class SystemAbstractAPIProvider public abstract class SystemAbstractAPIProvider
implements ISystemViewInputProvider implements ISystemViewInputProvider

View file

@ -35,6 +35,12 @@ public class FactoryServiceElement extends ServiceElement
private ServiceElement[] _children; private ServiceElement[] _children;
/**
* Constructor. Used to accept an IServiceSubSystemConfiguration before RSE
* 3.0
*
* @since 3.0
*/
public FactoryServiceElement(IHost host, ISubSystemConfiguration factory) public FactoryServiceElement(IHost host, ISubSystemConfiguration factory)
{ {
super(host, null); super(host, null);
@ -51,6 +57,12 @@ public class FactoryServiceElement extends ServiceElement
return _factory.getDescription(); return _factory.getDescription();
} }
/**
* Return the subsystem configuration related to this service element. Used
* to return an IServiceSubSystemConfiguration before RSE 3.0.
*
* @since 3.0
*/
public ISubSystemConfiguration getFactory() public ISubSystemConfiguration getFactory()
{ {
return _factory; return _factory;

View file

@ -15,9 +15,15 @@ import org.eclipse.rse.core.model.ISubSystemConfigurator;
/** /**
* Interface that all subsystem configuration supplied pages contributed to the New Connection wizard must implement. * Interface that all subsystem configuration supplied pages contributed to the
* New Connection wizard must implement. Moved from Core to UI in RSE 3.0
*
* @see org.eclipse.rse.ui.wizards.AbstractSystemNewConnectionWizardPage * @see org.eclipse.rse.ui.wizards.AbstractSystemNewConnectionWizardPage
* @see org.eclipse.rse.ui.view.SubSystemConfigurationAdapter#getNewConnectionWizardPages(org.eclipse.rse.core.subsystems.ISubSystemConfiguration, org.eclipse.jface.wizard.IWizard) * @see org.eclipse.rse.ui.view.SubSystemConfigurationAdapter#
* getNewConnectionWizardPages
* (org.eclipse.rse.core.subsystems.ISubSystemConfiguration,
* org.eclipse.jface.wizard.IWizard)
* @since 3.0
*/ */
public interface ISystemNewConnectionWizardPage extends ISubSystemConfigurator { public interface ISystemNewConnectionWizardPage extends ISubSystemConfigurator {

View file

@ -436,7 +436,11 @@ public class RSEDefaultNewConnectionWizard extends RSEAbstractNewConnectionWizar
} }
/** /**
* Return the first additional page to show when user presses Next on the main page * Return the first additional page to show when user presses Next on the
* main page. In RSE 3.0, the ISystemNewConnectionWizardPage return type was
* moved from org.eclipse.rse.core into a UI plugin.
*
* @since 3.0
*/ */
protected ISystemNewConnectionWizardPage getFirstAdditionalPage() { protected ISystemNewConnectionWizardPage getFirstAdditionalPage() {
if ((subsystemConfigurationSuppliedWizardPages != null) && (subsystemConfigurationSuppliedWizardPages.length > 0)) { if ((subsystemConfigurationSuppliedWizardPages != null) && (subsystemConfigurationSuppliedWizardPages.length > 0)) {

View file

@ -38,19 +38,22 @@ public class RSEWizardSelectionTreePatternFilter extends PatternFilter {
/** /**
* Constructor.<br> * Constructor.<br>
* Creates a new pattern filter instance with the passed in * Creates a new pattern filter instance with the passed in wizard page
* wizard page associated as parent. * associated as parent.
* *
* @param page The parent wizard page or <code>null</code>. * @param page The parent wizard page or <code>null</code>.
* @since 3.0
*/ */
public RSEWizardSelectionTreePatternFilter(WizardPage page) { public RSEWizardSelectionTreePatternFilter(WizardPage page) {
parentPage = page; parentPage = page;
} }
/** /**
* Returns the associated parent wizard parent. * Returns the associated parent wizard parent.
* *
* @return The parent wizard page or <code>null</code> if none. * @return The parent wizard page or <code>null</code> if none.
* @since 3.0
*/ */
protected WizardPage getParentWizardPage() { protected WizardPage getParentWizardPage() {
return parentPage; return parentPage;

View file

@ -837,36 +837,45 @@ implements IAdaptable, ISubSystem, ISystemFilterPoolReferenceManagerProvider
// Methods for encoding and decoding remote objects for drag and drop, and clipboard copy // Methods for encoding and decoding remote objects for drag and drop, and clipboard copy
// -------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------
// --------------
// Methods for encoding and decoding remote objects for drag and drop, and
// clipboard copy
// ------------------------------------------------------------------------
// --------------
/** /**
* Return the remote object that corresponds to the specified unique ID. * Return the remote object that corresponds to the specified unique ID.
* <p> * <p>
* Since the abstract subsystem implementation does not know anything * Since the abstract subsystem implementation does not know anything about
* about the specific kinds of resources managed by concrete * the specific kinds of resources managed by concrete implementations, this
* implementations, this method can only resolve filter references. * method can only resolve filter references.
* </p><p> * </p>
* <strong>subsystem implementations must override this method * <p>
* in order to resolve IDs for the remote objects they manage, * <strong>subsystem implementations must override this method in order to
* to support drag and drop, clipboard copy and other remote object * resolve IDs for the remote objects they manage, to support drag and drop,
* resolving schemes.</strong> * clipboard copy and other remote object resolving schemes.</strong>
* Extenders that want to support filters should call * Extenders that want to support filters should call
* <code>super.getObjectWithAbsoluteName(key)</code> * <code>super.getObjectWithAbsoluteName(key)</code> when they do not find a
* when they do not find a reference for the key themselves. * reference for the key themselves.
* </p> * </p>
* @see org.eclipse.rse.core.subsystems.IRemoteObjectResolver#getObjectWithAbsoluteName(String, IProgressMonitor)
* *
* @param key the unique id of the remote object. * @see org.eclipse.rse.core.subsystems.IRemoteObjectResolver#
* Must not be <code>null</code>. * getObjectWithAbsoluteName(String, IProgressMonitor)
*
* @param key the unique id of the remote object. Must not be
* <code>null</code>.
* @param monitor the progress monitor * @param monitor the progress monitor
* @return the remote object instance, or <code>null</code> if no * @return the remote object instance, or <code>null</code> if no object is
* object is found with the given id. * found with the given id.
* @throws Exception in case an error occurs contacting the remote * @throws Exception in case an error occurs contacting the remote system
* system while retrieving the requested remote object. * while retrieving the requested remote object. Extenders are
* Extenders are encouraged to throw {@link SystemMessageException} * encouraged to throw {@link SystemMessageException} in order to
* in order to support good user feedback in case of errors. * support good user feedback in case of errors. Since exceptions
* Since exceptions should only occur while retrieving new * should only occur while retrieving new remote objects during
* remote objects during startup, clients are typically allowed * startup, clients are typically allowed to ignore these exceptions
* to ignore these exceptions and treat them as if the remote * and treat them as if the remote object were simply not there.
* object were simply not there. * @since 3.0
*/ */
public Object getObjectWithAbsoluteName(String key, IProgressMonitor monitor) throws Exception public Object getObjectWithAbsoluteName(String key, IProgressMonitor monitor) throws Exception
{ {
@ -3182,34 +3191,47 @@ implements IAdaptable, ISubSystem, ISystemFilterPoolReferenceManagerProvider
/* Service Subsystem support */ /* Service Subsystem support */
/** /**
* Perform the subsystem specific processing required to complete a subsystem configuration switch for a * Perform the subsystem specific processing required to complete a
* service subsystem. The subsystem will typically query this configuration for interesting properties or * subsystem configuration switch for a service subsystem. The subsystem
* policies. It should also reset any state to a fresh start. * will typically query this configuration for interesting properties or
* This supplied implementation does nothing. Subclasses may override if they implement a service subsystem. * policies. It should also reset any state to a fresh start. This supplied
* @param newConfiguration the configuration this subsystem should use from this point. * implementation does nothing. Subclasses may override if they implement a
* service subsystem.
*
* @param newConfiguration the configuration this subsystem should use from
* this point.
* @since 3.0
*/ */
protected void internalSwitchSubSystemConfiguration(ISubSystemConfiguration newConfiguration) { protected void internalSwitchSubSystemConfiguration(ISubSystemConfiguration newConfiguration) {
} }
/** /**
* Determine if a service subsystem is capable of switching to this new configuration. * Determine if a service subsystem is capable of switching to this new
* This is usually a test of this configuration's type against the type expected by this subsystem. * configuration. This is usually a test of this configuration's type
* This supplied implementation returns false. Subclasses should override if they implement a service subsystem. * against the type expected by this subsystem. This supplied implementation
* returns false. Subclasses should override if they implement a service
* subsystem.
*
* @param configuration the configuration to which this subsystem may switch * @param configuration the configuration to which this subsystem may switch
* @return true if this subsystem is capable of switching to this configuration, false otherwise. This implementation * @return true if this subsystem is capable of switching to this
* returns false. * configuration, false otherwise. This implementation returns false.
* @see ISubSystem#canSwitchTo(ISubSystemConfiguration) * @see ISubSystem#canSwitchTo(ISubSystemConfiguration)
* @since 3.0
*/ */
public boolean canSwitchTo(ISubSystemConfiguration configuration) { public boolean canSwitchTo(ISubSystemConfiguration configuration) {
return false; return false;
} }
/** /**
* Switch to use another subsystem configuration. This default implementation will test if the subsystem is a * Switch to use another subsystem configuration. This default
* service subsystem and if the subsystem is compatible with the suggested configuration. If it is the switch will * implementation will test if the subsystem is a service subsystem and if
* be performed and internalSwitchSubSystemConfiguration will be called. * the subsystem is compatible with the suggested configuration. If it is
* the switch will be performed and internalSwitchSubSystemConfiguration
* will be called.
*
* @see ISubSystem#switchServiceFactory(ISubSystemConfiguration) * @see ISubSystem#switchServiceFactory(ISubSystemConfiguration)
* @see #internalSwitchSubSystemConfiguration(ISubSystemConfiguration) * @see #internalSwitchSubSystemConfiguration(ISubSystemConfiguration)
* @since 3.0
*/ */
public void switchServiceFactory(final ISubSystemConfiguration config) { public void switchServiceFactory(final ISubSystemConfiguration config) {
if (config != getSubSystemConfiguration() && canSwitchTo(config)) { if (config != getSubSystemConfiguration() && canSwitchTo(config)) {
@ -3227,9 +3249,12 @@ implements IAdaptable, ISubSystem, ISystemFilterPoolReferenceManagerProvider
/** /**
* Return the service type for this subsystem. * Return the service type for this subsystem.
* @return the default implementation returns null. Subclasses that implement service subsystems *
* should return a type as specified in the interface. * @return the default implementation returns null. Subclasses that
* @see org.eclipse.rse.core.subsystems.ISubSystem#getServiceType() * implement service subsystems should return a type as specified in the
* interface.
* @see ISubSystem#getServiceType()
* @since 3.0
*/ */
public Class getServiceType() { public Class getServiceType() {
return null; return null;

View file

@ -960,25 +960,33 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Creates a new subsystem instance that is associated with the given connection object. * Creates a new subsystem instance that is associated with the given
* SystemRegistryImpl calls this when a new connection is created, and appliesToSystemType returns true. * connection object. SystemRegistryImpl calls this when a new connection is
* created, and appliesToSystemType returns true.
* <p> * <p>
* This method doe sthe following: * This method doe sthe following:
* <ul> * <ul>
* <li>calls {@link #createSubSystemInternal(IHost)} to create the subsystem * <li>calls {@link #createSubSystemInternal(IHost)} to create the subsystem
* <li>does initialization of common attributes * <li>does initialization of common attributes
* <li>if {@link #supportsFilters()}, creates a {@link org.eclipse.rse.core.filters.ISystemFilterPoolReferenceManager} for the * <li>if {@link #supportsFilters()}, creates a {@link
* org.eclipse.rse.core.filters.ISystemFilterPoolReferenceManager} for the
* subsystem to manage references to filter pools * subsystem to manage references to filter pools
* <li>if (@link #supportsServerLaunchProperties()}, calls {@link #createServerLauncher(IConnectorService)}, to create * <li>if (@link #supportsServerLaunchProperties()}, calls {@link
* the server launcher instance to associate with this subsystem.}. * #createServerLauncher(IConnectorService)}, to create the server launcher
* <li>calls {@link #initializeSubSystem(ISubSystem, ISubSystemConfigurator[])} so subclasses can * instance to associate with this subsystem.}.
* do their thing to initialize the subsystem. * <li>calls {@link #initializeSubSystem(ISubSystem,
* ISubSystemConfigurator[])} so subclasses can do their thing to initialize
* the subsystem.
* <li>finally, saves the subsystem to disk. * <li>finally, saves the subsystem to disk.
* </ul> * </ul>
*
* @param conn The connection to create a subsystem for * @param conn The connection to create a subsystem for
* @param creatingConnection true if we are creating a connection, false if just creating * @param creatingConnection true if we are creating a connection, false if
* another subsystem for an existing connection. * just creating another subsystem for an existing connection.
* @param configurators configurators that inject properties into this new subsystem or null if there are none * @param configurators configurators that inject properties into this new
* subsystem or null if there are none. Used to take
* ISystemNewConnectionWizardPage[] before RSE 3.0.
* @since 3.0
*/ */
public ISubSystem createSubSystem(IHost conn, boolean creatingConnection, ISubSystemConfigurator[] configurators) public ISubSystem createSubSystem(IHost conn, boolean creatingConnection, ISubSystemConfigurator[] configurators)
{ {
@ -1193,12 +1201,17 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
public abstract ISubSystem createSubSystemInternal(IHost conn); public abstract ISubSystem createSubSystemInternal(IHost conn);
/** /**
* Initialize subsystems after creation (<i>Overridable</i>). * Initialize subsystems after creation (<i>Overridable</i>). The default
* The default behavior is to add a reference to the default filter pool for this subsystem configuration, * behavior is to add a reference to the default filter pool for this
* if there is one. Typically subclasses call <samp>super().initializeSubSystem(...)</samp> * subsystem configuration, if there is one. Typically subclasses call
* to get this default behavior, then extend it. * <samp>super().initializeSubSystem(...)</samp> to get this default
* behavior, then extend it.
*
* @param ss - The subsystem that was created via createSubSystemInternal * @param ss - The subsystem that was created via createSubSystemInternal
* @param configurators an array of {@link ISubSystemConfigurator} used to inject values into this subsystem or null if there are none * @param configurators an array of {@link ISubSystemConfigurator} used to
* inject values into this subsystem or null if there are none. Used to
* take ISystemNewConnectionWizardPage[] before RSE 3.0
* @since 3.0
*/ */
protected void initializeSubSystem(ISubSystem ss, ISubSystemConfigurator[] configurators) { protected void initializeSubSystem(ISubSystem ss, ISubSystemConfigurator[] configurators) {
if (supportsFilters()) { if (supportsFilters()) {
@ -1422,8 +1435,12 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Overridable entry for child classes to supply their own flavour of ISystemFilterPoolWrapperInformation for * Overridable entry for child classes to supply their own flavor of
* the new filter wizards. * ISystemFilterPoolWrapperInformation for the new filter wizards.
*
* @return an ISystemFilterPoolWrapperInformation instead of a
* SystemFilterPoolWrapperInformation since 3.0
* @since 3.0
*/ */
protected ISystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation() protected ISystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation()
{ {
@ -2776,11 +2793,11 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Return true if deferred queries are supported. * Return true if deferred queries are supported. By default, they are
* By default, they are supported. Override for different behavior. * supported. Override for different behavior.
* *
* @return <code>true</code> if deferred queries are supported. * @return <code>true</code> if deferred queries are supported.
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#supportsDeferredQueries() * @see ISubSystemConfiguration#supportsDeferredQueries()
*/ */
public boolean supportsDeferredQueries() public boolean supportsDeferredQueries()
{ {
@ -2792,44 +2809,65 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
*/ */
/** /**
* This default implementation does nothing. * {@inheritDoc}
* Service subsystems must override as defined in the interface. * <p>
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#setConnectorService(org.eclipse.rse.core.model.IHost, org.eclipse.rse.core.subsystems.IConnectorService) * This default implementation does nothing. Service subsystems must
* override as defined in the interface.
*
* @see ISubSystemConfiguration#setConnectorService(IHost,
* IConnectorService)
* @since org.eclipse.rse.core 3.0
*/ */
public void setConnectorService(IHost host, IConnectorService connectorService) { public void setConnectorService(IHost host, IConnectorService connectorService) {
} }
/** /**
* This default implementation returns null. * {@inheritDoc}
* Service subsystem configurations must override as defined in the interface. * <p>
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#getConnectorService(org.eclipse.rse.core.model.IHost) * This default implementation returns <code>null</code>. Service subsystem
* configurations must override as defined in the interface.
*
* @see ISubSystemConfiguration#getConnectorService(IHost)
* @since org.eclipse.rse.core 3.0
*/ */
public IConnectorService getConnectorService(IHost host) { public IConnectorService getConnectorService(IHost host) {
return null; return null;
} }
/** /**
* This default implementation returns null. * {@inheritDoc}
* Service subsystem configurations must override as defined in the interface. * <p>
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#getServiceType() * This default implementation returns <code>null</code>. Service subsystem
* configurations must override as defined in the interface.
*
* @see ISubSystemConfiguration#getServiceType()
* @since org.eclipse.rse.core 3.0
*/ */
public Class getServiceType() { public Class getServiceType() {
return null; return null;
} }
/** /**
* This default implementation returns null. * {@inheritDoc}
* Service subsystem configurations must override as defined in the interface. * <p>
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#getServiceImplType() * This default implementation returns <code>null</code>. Service subsystem
* configurations must override as defined in the interface.
*
* @see ISubSystemConfiguration#getServiceImplType()
* @since org.eclipse.rse.core 3.0
*/ */
public Class getServiceImplType() { public Class getServiceImplType() {
return null; return null;
} }
/** /**
* This default implementation returns null. * {@inheritDoc}
* Service subsystem configurations must override as defined in the interface. * <p>
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#getService(org.eclipse.rse.core.model.IHost) * This default implementation returns <code>null</code>. Service subsystem
* configurations must override as defined in the interface.
*
* @see ISubSystemConfiguration#getService(IHost)
* @since org.eclipse.rse.core 3.0
*/ */
public IService getService(IHost host) { public IService getService(IHost host) {
return null; return null;