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

[196942][doc] Add Javadoc forbidding extenders to override getName() etc. on SubSystemConfiguration

Browse source
This commit is contained in:
Martin Oberhuber 2007-07-23 14:18:56 +00:00
parent 56980c97bd
commit 1cd25b2fef
2 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfiguration.java
View file

@ -29,6 +29,15 @@ import org.eclipse.rse.core.model.IRSEPersistableContainer;
import org.eclipse.rse.core.model.ISystemNewConnectionWizardPage; import org.eclipse.rse.core.model.ISystemNewConnectionWizardPage;
import org.eclipse.rse.core.model.ISystemProfile; import org.eclipse.rse.core.model.ISystemProfile;
/**
* Subsystem Configuration interface.
*
* <p>
* This interface is not intended to be implemented by clients. Subsystem
* configuration implementations must subclass {@link SubSystemConfiguration}
* rather than implementing this interface directly.
* </p>
*/
public interface ISubSystemConfiguration extends ISystemFilterPoolManagerProvider, IRSEPersistableContainer { public interface ISubSystemConfiguration extends ISystemFilterPoolManagerProvider, IRSEPersistableContainer {
// --------------------------------- // ---------------------------------
// CONSTANTS... // CONSTANTS...

23
rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
View file

@ -470,6 +470,9 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
/** /**
* Return vendor of this subsystem configuration. * Return vendor of this subsystem configuration.
* This comes from the xml "vendor" attribute of the extension point. * This comes from the xml "vendor" attribute of the extension point.
*
* <b>Do not override this method</b>, it will likely be declared
* <tt>final</tt> in the next release.
*/ */
public String getVendor() public String getVendor()
{ {
@ -479,6 +482,9 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
/** /**
* Return name of this subsystem configuration. * Return name of this subsystem configuration.
* This comes from the xml "name" attribute of the extension point. * This comes from the xml "name" attribute of the extension point.
*
* <b>Do not override this method</b>, it will likely be declared
* <tt>final</tt> in the next release.
*/ */
public String getName() public String getName()
{ {
@ -488,6 +494,9 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
/** /**
* Return name of this subsystem configuration. * Return name of this subsystem configuration.
* This comes from the xml "description" attribute of the extension point. * This comes from the xml "description" attribute of the extension point.
*
* <b>Do not override this method</b>, it will likely be declared
* <tt>final</tt> in the next release.
*/ */
public String getDescription() public String getDescription()
{ {
@ -497,6 +506,9 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
/** /**
* Return unique id of this subsystem configuration. * Return unique id of this subsystem configuration.
* This comes from the xml "id" attribute of the extension point. * This comes from the xml "id" attribute of the extension point.
*
* <b>Do not override this method</b>, it will likely be declared
* <tt>final</tt> in the next release.
*/ */
public String getId() public String getId()
{ {
@ -505,14 +517,25 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
/** /**
* Return the category this subsystem configuration subscribes to. * Return the category this subsystem configuration subscribes to.
* This comes from the xml "category" attribute of the extension point.
* @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories * @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories
*
* <b>Do not override this method</b>, it will likely be declared
* <tt>final</tt> in the next release.
*/ */
public String getCategory() public String getCategory()
{ {
return proxy.getCategory(); return proxy.getCategory();
} }
/** /**
* Return the system types this subsystem configuration supports. * Return the system types this subsystem configuration supports.
* These come from static declaration in the
* <tt>org.eclipse.rse.core.subsystemConfigurations</tt> and
* <tt>org.eclipse.rse.core.systemTypes</tt> extension points.
*
* <b>Do not override this method</b>, it will likely be declared
* <tt>final</tt> in the next release.
*/ */
public IRSESystemType[] getSystemTypes() public IRSESystemType[] getSystemTypes()
{ {