Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Dykstal2008-04-22 22:11:49 +0000
committerDavid Dykstal2008-04-22 22:11:49 +0000
commitf5612b4b2c883e3f0dd5b72c7f941e98b6e30280 (patch)
tree5049b94844c5919630906e03c01ac1a4fa6eb3cb
parentd8cdbd6f911573f834140a6190568db347fda299 (diff)
downloadorg.eclipse.tm-f5612b4b2c883e3f0dd5b72c7f941e98b6e30280.tar.gz
org.eclipse.tm-f5612b4b2c883e3f0dd5b72c7f941e98b6e30280.tar.xz
org.eclipse.tm-f5612b4b2c883e3f0dd5b72c7f941e98b6e30280.zip
[226561][apidoc] Add API markup to RSE Javadocs where extend / implement is allowed
https://bugs.eclipse.org/bugs/show_bug.cgi?id=226561
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java3
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceHelpers.java6
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java2
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolSelectionValidator.java3
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapper.java3
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapperInformation.java2
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java6
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterReference.java7
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/Logger.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/LoggerFactory.java4
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOM.java3
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNode.java5
-rw-r--r--rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNodeAttribute.java5
25 files changed, 88 insertions, 20 deletions
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java
index fe7218398..41773c5e5 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java
@@ -6,6 +6,7 @@
*
* Contributors:
* David Dykstal (IBM) - [225988] need API to mark persisted profiles as migrated
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*********************************************************************************/
package org.eclipse.rse.core;
@@ -15,6 +16,8 @@ package org.eclipse.rse.core;
* org.eclipse.rse.core
*
* @since org.eclipse.rse.core 3.0
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement this interface is not intended to be implemented by clients
*/
public interface IRSECoreStatusCodes {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceHelpers.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceHelpers.java
index 23c02d0e2..13f17b10a 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceHelpers.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceHelpers.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core;
@@ -34,7 +34,9 @@ import org.eclipse.core.runtime.IStatus;
/**
* A class with helper methods for working with the underlying Eclipse resources
- * needed for filters, filter pools and filter pool managers.
+ * needed for filters, filter pools and filter pool managers.
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
*/
public class SystemResourceHelpers implements FileFilter
{
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java
index 83c69d1be..58f28e1cb 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java
@@ -15,6 +15,7 @@
* David Dykstal (IBM) - cleanup format and javadoc
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -29,6 +30,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* Subsystems are responsible for interpreting the filters. Filters, in and
* of themselves, provide no interpretation of themselves when applied
* to the resources managed by a subsystem.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations already present in the framwork.
*/
public interface ISystemFilter extends IRSEReferencedObject, ISystemFilterContainer, IRSEModelObject {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java
index 87adc55ac..6d5af3992 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java
@@ -13,6 +13,7 @@
*
* Contributors:
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -21,6 +22,9 @@ import org.eclipse.rse.core.model.IRSEPersistableContainer;
/**
* Filter containers are any objects that contain filters.
* This includes filter pools and filters themselves.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterContainer extends IRSEPersistableContainer {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java
index d6af1e378..2cf113dc4 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -31,6 +31,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* This interface captures those common methods, and both
* SystemFilterReference and SystemFilterPoolReference
* implement this interface and hence these methods.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterContainerReference {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java
index e317956e4..970e92034 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java
@@ -14,6 +14,7 @@
* Contributors:
* David Dykstal (IBM) - cleanup - format and javadoc
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -24,6 +25,9 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencedObject;
/**
* This interface represents a system filter pool, which is a means of
* grouping filters to be referenced together.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java
index 6975da01b..79b0721c0 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java
@@ -16,6 +16,7 @@
* cleaned javadoc for renameSystemFilterPool
* David Dykstal (IBM) - [222270] clean up interfaces in org.eclipse.rse.core.filters
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -32,6 +33,7 @@ import org.eclipse.rse.core.model.ISystemProfile;
* filter related activity through a single point like this, we can ensure that
* all changes are saved to disk, and events are fired properly.
*
+ * @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISystemFilterPoolManager extends IRSEPersistableContainer {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java
index 8aeafcc7e..b3d98b574 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -32,6 +32,8 @@ import org.eclipse.core.runtime.IAdaptable;
* in order to fire events to update its GUI. So this interface captures those
* callbacks that done to the provider for every interesting event. Should you
* not care about these, supply empty shells for these methods.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISystemFilterPoolManagerProvider extends IAdaptable {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java
index 2f6f0fece..f43348a44 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java
@@ -11,7 +11,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
********************************************************************************/
package org.eclipse.rse.core.filters;
@@ -24,6 +24,9 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencingObject;
* level, while subsystems contain references to one or more pools. A pool can be referenced
* by multiple connections. Pools don't go away until explicitly deleted by the user, regardless
* of their reference count.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterPoolReference extends IRSEPersistableReferencingObject, ISystemFilterContainerReference, IRSEModelObject {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java
index 705d30375..81df1f21b 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -25,6 +25,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* a filter pool. This class builds on the parent class SystemPersistableReferenceManager,
* offering convenience versions of the parent methods that are typed to the
* classes in the filters framework.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterPoolReferenceManager extends IRSEBasePersistableReferenceManager {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java
index b1dc5589b..3858c4f65 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -30,6 +30,9 @@ package org.eclipse.rse.core.filters;
* in order to fire events to update its GUI. So this interface captures those
* callbacks that done to the provider for every interesting event. Should you
* not care about these, supply empty shells for these methods.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterPoolReferenceManagerProvider {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolSelectionValidator.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolSelectionValidator.java
index 974e74558..a5cfcf05f 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolSelectionValidator.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolSelectionValidator.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -22,6 +22,7 @@ import org.eclipse.rse.services.clientserver.messages.SystemMessage;
/**
* An interface required if you wish to be called back by the
* system filter wizard, when the user selects a target filter pool.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ISystemFilterPoolSelectionValidator {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapper.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapper.java
index a828e5f7c..c3305690f 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapper.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapper.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -20,6 +20,7 @@ package org.eclipse.rse.core.filters;
/**
* The system filter wizard allows callers to pass a list of wrapper objects
* for the user to select a filter pool.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ISystemFilterPoolWrapper {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapperInformation.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapperInformation.java
index ca669534a..36b4630e9 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapperInformation.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapperInformation.java
@@ -13,6 +13,7 @@
*
* Contributors:
* David McKnight (IBM) - [225506] [api][breaking] RSE UI leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -26,6 +27,7 @@ package org.eclipse.rse.core.filters;
* <p>
* This is all encapsulated in this interface. There is also a class offered
* that implements all this and is populated via setters.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ISystemFilterPoolWrapperInformation {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.java
index 23f38f9f4..c43464563 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -25,6 +25,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
/**
* Represents a shadow or reference to a system filter.
* Such references are only transient, not savable to disk.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterReference extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java
index f730ff9dc..bec18d498 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java
@@ -8,12 +8,18 @@
* Contributors:
* IBM Corporation - initial API and implementation
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
import org.eclipse.rse.core.model.ISystemProfile;
import org.eclipse.rse.logging.Logger;
+/**
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
+ */
public interface ISystemFilterStartHere {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java
index 24363b0d9..f9e4a0bf2 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java
@@ -13,6 +13,7 @@
*
* Contributors:
* Martin Oberhuber (Wind River) - Cleanup Javadoc.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -27,6 +28,9 @@ import org.eclipse.rse.core.references.IRSEBaseReferencedObject;
* than a string, and its up to each consumer to know what to do with it. Generally,
* a filter string edit pane is designed to prompt the user for the contents of the
* string in a domain-friendly way.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterString extends IRSEBaseReferencedObject, IAdaptable, IRSEModelObject {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java
index a5edf72f2..ba0c96572 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.core.filters;
@@ -22,6 +22,9 @@ import org.eclipse.rse.core.references.IRSEBaseReferencingObject;
/**
* Represents a reference to a filter string.
* Needed so the UI can show the same filter string multiple times.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
*/
public interface ISystemFilterStringReference extends IRSEBaseReferencingObject {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterReference.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterReference.java
index 977b54a44..69e807299 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterReference.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterReference.java
@@ -13,6 +13,7 @@
* Contributors:
* David Dykstal (IBM) - 142806: refactoring persistence framework
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
********************************************************************************/
package org.eclipse.rse.core.filters;
@@ -44,9 +45,9 @@ import org.eclipse.rse.internal.core.filters.SystemFilterStringReference;
* if it is possible for the same filter to show up in different places in
* the tree, then we must create shadows for each place it shows up.
* </ol>
- */
-/**
- * @lastgen class SystemFilterReferenceImpl extends SystemReferencingObjectImpl implements IAdaptable, SystemFilterReference, SystemReferencingObject {}
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * Use the factory method {@link #createSystemFilterReference(ISubSystem, ISystemFilterContainerReference, ISystemFilter, boolean)}.
*/
public class SystemFilterReference extends SystemReferencingObject implements IAdaptable, ISystemFilterReference {
private SystemFilterContainerReferenceCommonMethods containerHelper = null;
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.java
index ff8b8b558..f07b7cfbd 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.java
@@ -6,6 +6,7 @@
*
* Contributors:
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*********************************************************************************/
package org.eclipse.rse.core.filters;
@@ -14,7 +15,8 @@ import org.eclipse.rse.internal.core.filters.SystemFilterSimple;
/**
* Utilities to be used in the construction and manipulation of filters.
- * @noextend
+ * @noextend This interface is not intended to be extended by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
*/
public class SystemFilterUtil {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/Logger.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/Logger.java
index 38fd59cef..e3a0546c4 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/Logger.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/Logger.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.logging;
@@ -71,6 +71,9 @@ import org.eclipse.rse.internal.logging.LogListener;
* }<br>
* <br>
*
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * Use {@link LoggerFactory} to create instances.
*/
public class Logger implements IPropertyChangeListener {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/LoggerFactory.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/LoggerFactory.java
index 28dc97e6c..57ba55f02 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/LoggerFactory.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/LoggerFactory.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.logging;
@@ -26,6 +26,8 @@ import org.eclipse.core.runtime.Plugin;
* Keep in mind that this factory class follows the singleton model.<br>
* ie: once an instance of a Logger class for a given plugin is created,
* it will always be reused.
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
*/
public class LoggerFactory {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOM.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOM.java
index 0703801ae..66bbf99ac 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOM.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOM.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.persistence.dom;
@@ -22,6 +22,7 @@ import org.eclipse.rse.core.model.ISystemProfile;
/**
* This class is the root node of an RSE DOM. Each
* RSEDOM represents the properties of a profile to persist.
+ * @noextend This class is not intended to be subclassed by clients.
*/
public class RSEDOM extends RSEDOMNode {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNode.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNode.java
index 6e47f2c86..38c212956 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNode.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNode.java
@@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.persistence.dom;
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
+/**
+ * @noextend This class is not intended to be subclassed by clients.
+ */
public class RSEDOMNode implements Serializable {
private static final long serialVersionUID = 1L; // This should be updated if there is a schema change.
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNodeAttribute.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNodeAttribute.java
index 65eefe63e..2598e0136 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNodeAttribute.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNodeAttribute.java
@@ -12,13 +12,16 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/
package org.eclipse.rse.persistence.dom;
import java.io.Serializable;
+/**
+ * @noextend This class is not intended to be subclassed by clients.
+ */
public class RSEDOMNodeAttribute implements Serializable {
private static final long serialVersionUID = 1L;
private String _key;

Back to the top