From 1cd25b2fef7e409eb22a46a447bbe334cac7a581 Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Mon, 23 Jul 2007 14:18:56 +0000
Subject: [PATCH] [196942][doc] Add Javadoc forbidding extenders to override
 getName() etc. on SubSystemConfiguration

---
 .../subsystems/ISubSystemConfiguration.java   |  9 ++++++++
 .../subsystems/SubSystemConfiguration.java    | 23 +++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfiguration.java
index 33d32c1965c..271058bee2e 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfiguration.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfiguration.java
@@ -29,6 +29,15 @@ import org.eclipse.rse.core.model.IRSEPersistableContainer;
 import org.eclipse.rse.core.model.ISystemNewConnectionWizardPage;
 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 {
 	// ---------------------------------
 	// CONSTANTS...
diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
index c118ff2c189..a24176c9921 100644
--- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
+++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
@@ -470,6 +470,9 @@ public abstract class SubSystemConfiguration  implements ISubSystemConfiguration
 	/**
 	 * Return vendor of this subsystem configuration.
 	 * 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()
 	{
@@ -479,6 +482,9 @@ public abstract class SubSystemConfiguration  implements ISubSystemConfiguration
 	/**
 	 * Return name of this subsystem configuration.
 	 * 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()
 	{
@@ -488,6 +494,9 @@ public abstract class SubSystemConfiguration  implements ISubSystemConfiguration
 	/**
 	 * Return name of this subsystem configuration.
 	 * 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()
 	{
@@ -497,6 +506,9 @@ public abstract class SubSystemConfiguration  implements ISubSystemConfiguration
 	/**
 	 * Return unique id of this subsystem configuration.
 	 * 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()
 	{
@@ -505,14 +517,25 @@ public abstract class SubSystemConfiguration  implements ISubSystemConfiguration
 	
 	/**
 	 * 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
+	 * 
+	 * <b>Do not override this method</b>, it will likely be declared
+	 * <tt>final</tt> in the next release.
 	 */
 	public String getCategory()
 	{
 		return proxy.getCategory();
 	}
+	
 	/**
 	 * 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()
 	{