1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-20 22:55:51 +02:00

[cleanup] Get rid of @noextend on interfaces

This commit is contained in:
Martin Oberhuber 2008-04-24 00:22:18 +00:00
parent 86a6dd5d70
commit 3a3006d128
29 changed files with 200 additions and 214 deletions

View file

@ -23,7 +23,6 @@ package org.eclipse.rse.core.model;
* implement {@link IPropertySetContainer}. These would typically be model objects. * implement {@link IPropertySetContainer}. These would typically be model objects.
* Properties also have a type (see {@link IPropertyType}). * Properties also have a type (see {@link IPropertyType}).
* @see IRSEModelObject * @see IRSEModelObject
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* Use {@link Property} directly. * Use {@link Property} directly.
*/ */
@ -59,10 +58,10 @@ public interface IProperty {
public String getValue(); public String getValue();
/** /**
* Sets the type of this property. * Sets the type of this property. May raise an runtime exception if the
* May raise an runtime exception if the value of the property is not compatible * value of the property is not compatible with the new type.
* with the new type. *
* @param type * @param type the property type
*/ */
public void setType(IPropertyType type); public void setType(IPropertyType type);

View file

@ -32,7 +32,6 @@ import java.util.Map;
* *
* The key <code>"description"</code> is reserved for internal * The key <code>"description"</code> is reserved for internal
* use, to store the description of the Property set. * use, to store the description of the Property set.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* Use {@link PropertySet} directly. * Use {@link PropertySet} directly.
*/ */
@ -167,9 +166,10 @@ public interface IPropertySet extends IPropertySetContainer {
public boolean removeProperty(String key); public boolean removeProperty(String key);
/** /**
* Sets the container of this property set. Used to notify the * Sets the container of this property set. Used to notify the container of
* container of a change in a property. * a change in a property.
* @param container *
* @param container the property set container
*/ */
public void setContainer(IPropertySetContainer container); public void setContainer(IPropertySetContainer container);

View file

@ -22,7 +22,6 @@ package org.eclipse.rse.core.model;
* A property set container is capable of containing property sets. This interface allows for the * A property set container is capable of containing property sets. This interface allows for the
* addition, retrieval, and deletion of property sets from the container. A property set may have only * addition, retrieval, and deletion of property sets from the container. A property set may have only
* one container. * one container.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -19,7 +19,6 @@ package org.eclipse.rse.core.model;
/** /**
* Property types are used to type instances of {@link IProperty}. * Property types are used to type instances of {@link IProperty}.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* Use {@link PropertyType} directly. * Use {@link PropertyType} directly.
*/ */

View file

@ -17,7 +17,6 @@ import org.eclipse.core.runtime.IStatus;
/** /**
* Implement this class to create callbacks. * Implement this class to create callbacks.
* @noextend This interface is not intended to be extended by clients.
*/ */
public interface IRSECallback { public interface IRSECallback {

View file

@ -25,8 +25,6 @@ package org.eclipse.rse.core.model;
* An example of this is the SytemFilterPoolManager, which is itself not persisted, but * An example of this is the SytemFilterPoolManager, which is itself not persisted, but
* has this interface since it can be reconstructed from its ordering and exists * has this interface since it can be reconstructed from its ordering and exists
* in the parent chain from SystemFilterPool to SystemProfile. * in the parent chain from SystemFilterPool to SystemProfile.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -18,11 +18,12 @@
package org.eclipse.rse.core.model; package org.eclipse.rse.core.model;
/** /**
* Constants for pre-defined subsystem factory categories. * Constants for predefined subsystem factory categories. Use these in calls to
* Use these in calls to {@link org.eclipse.rse.core.model.ISystemRegistry#getHostsBySubSystemConfigurationCategory(String)}. * {@link org.eclipse.rse.core.model.ISystemRegistry#getHostsBySubSystemConfigurationCategory(String)}.
* @noextend This interface is not intended to be extended by clients. *
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* This is a constant interface. The individual items should be referenced directly. * This is a constant interface. The individual items should be
* referenced directly.
*/ */
public interface ISubSystemConfigurationCategories { public interface ISubSystemConfigurationCategories {
/** /**

View file

@ -23,9 +23,11 @@ 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. * @noimplement This is an internal interface for use in the framework.
* Potential clients should extend one of the implementations * Potential clients should extend one of the implementations or
* or implement one of the extensions. * implement one of the extensions.
* @since org.eclipse.rse.core 3.0
*/ */
public interface ISubSystemConfigurator { public interface ISubSystemConfigurator {

View file

@ -19,8 +19,6 @@ package org.eclipse.rse.core.model;
/** /**
* ISystemContainer is an interface implemented by objects that can contain remote resources. * ISystemContainer is an interface implemented by objects that can contain remote resources.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
* These can be extended by clients. * These can be extended by clients.

View file

@ -30,7 +30,6 @@ import org.eclipse.rse.core.IRSEUserIdConstants;
* that integrity of the host list is maintained even if multiple threads call * that integrity of the host list is maintained even if multiple threads call
* multiple methods in this interface concurrently. * multiple methods in this interface concurrently.
* </p> * </p>
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -19,7 +19,6 @@ package org.eclipse.rse.core.model;
/** /**
* This interface represents a message we wish to display as child node in the tree view. * This interface represents a message we wish to display as child node in the tree view.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -13,9 +13,11 @@ package org.eclipse.rse.core.model;
/** /**
* A modifiable container allows its contents to be set directly. * A modifiable container allows its contents to be set directly.
* @noextend This interface is not intended to be extended by clients. *
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients. The
* The standard implementations are included in the framework. * standard implementations are included in the framework.
*
* @since org.eclipse.rse.core 3.0
*/ */
public interface ISystemModifiableContainer extends ISystemContainer { public interface ISystemModifiableContainer extends ISystemContainer {

View file

@ -38,7 +38,6 @@ import org.eclipse.rse.persistence.IRSEPersistenceProvider;
* definitions to RSE. When made inactive, it those definition are no longer * definitions to RSE. When made inactive, it those definition are no longer
* available for use. * available for use.
* <p> * <p>
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -28,7 +28,6 @@ import org.eclipse.core.runtime.IStatus;
* processing is not desired. If events are necessary then the system registry * processing is not desired. If events are necessary then the system registry
* should be used. * should be used.
* *
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -25,7 +25,6 @@ import org.eclipse.rse.services.clientserver.messages.SystemMessage;
/** /**
* This interface is refers to a collection of any type of resources. The resources * This interface is refers to a collection of any type of resources. The resources
* may be remote RSE resources, or local workspace resources. * may be remote RSE resources, or local workspace resources.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* Extend {@link AbstractSystemResourceSet} instead. * Extend {@link AbstractSystemResourceSet} instead.
*/ */

View file

@ -19,11 +19,10 @@
package org.eclipse.rse.core.model; package org.eclipse.rse.core.model;
/** /**
* The standard implementation of {@link IPropertyType}. * The standard implementation of {@link IPropertyType}. Use the static factory
* methods to return instances.
*
* @noextend This class is not intended to be subclassed by clients. * @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
* The constructors are private.
* Use the static factory methods to return instances.
*/ */
public class PropertyType implements IPropertyType { public class PropertyType implements IPropertyType {

View file

@ -48,8 +48,6 @@ package org.eclipse.rse.core.references;
* and restore methods. If using MOF, and the containment of the manager class is modelled in * and restore methods. If using MOF, and the containment of the manager class is modelled in
* your own containing class, this will happen automatically when you use mof to save * your own containing class, this will happen automatically when you use mof to save
* your containing class instance. * your containing class instance.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -17,30 +17,30 @@
package org.eclipse.rse.core.references; package org.eclipse.rse.core.references;
/** /**
* Referenced objects are objects that have shadow objects (referencing objects) of them. * Referenced objects are objects that have shadow objects (referencing objects)
* Typically, references are created to enable a UI which does not allow the same * of them. Typically, references are created to enable a UI which does not
* real object to appear multiple times. In these cases, a unique reference object * allow the same real object to appear multiple times. In these cases, a unique
* is created for each unique instance of the real object. * reference object is created for each unique instance of the real object.
* <p> * <p>
* The parent interface IRSEReferencedObject captures the simple set of methods * The parent interface IRSEReferencedObject captures the simple set of methods
* an object that supports such a real object implement. * an object that supports such a real object implement.
* <p> * <p>
* This interface specializes that for the case of real objects that support references * This interface specializes that for the case of real objects that support
* that must be persisted. * references that must be persisted. Typically, we build the references in
* Typically, we build the references in memory at runtime to satisfy the UI. * memory at runtime to satisfy the UI. However, occasionally we build the list
* However, occassionally we build the list of references for a more permanent reason, * of references for a more permanent reason, such as when we let a user choose
* such as when we let a user choose a subset from a master list. * a subset from a master list.
* <p> * <p>
* When we persist such a reference, we can't persist the memory reference to the master * When we persist such a reference, we can't persist the memory reference to
* object. Instead, we persist the unique name of that object, and upon restoring * the master object. Instead, we persist the unique name of that object, and
* from disk we then resolve that into a runtime reference to a real memory object. * upon restoring from disk we then resolve that into a runtime reference to a
* real memory object.
* <p> * <p>
* This interface supplies the method to allow a referencing object to * This interface supplies the method to allow a referencing object to query
* query that unique name or key from this real object. * that unique name or key from this real object.
* @noextend This interface is not intended to be extended by clients. *
* The standard extensions are included in the framework. * @noimplement This interface is not intended to be implemented by clients. The
* @noimplement This interface is not intended to be implemented by clients. * standard implementations are included in the framework.
* The standard implementations are included in the framework.
*/ */
public interface IRSEBasePersistableReferencedObject extends IRSEBaseReferencedObject { public interface IRSEBasePersistableReferencedObject extends IRSEBaseReferencedObject {

View file

@ -18,28 +18,29 @@
package org.eclipse.rse.core.references; package org.eclipse.rse.core.references;
/** /**
* Referencing objects are shadows of real objects. Typically, shadows are created * Referencing objects are shadows of real objects. Typically, shadows are
* to enable a GUI which does not allow the same real object to appear multiple times. * created to enable a GUI which does not allow the same real object to appear
* In these cases, a unique shadow object is created for each unique instance of the * multiple times. In these cases, a unique shadow object is created for each
* real object. * unique instance of the real object.
* <p> * <p>
* The parent interface ISystemReferencingObject captures the simple set of methods * The parent interface ISystemReferencingObject captures the simple set of
* such a shadow must implement. * methods such a shadow must implement.
* <p> * <p>
* This interface specializes that for the case of references that must be persisted. * This interface specializes that for the case of references that must be
* Typically, we build the references in memory at runtime just to satisfy the GUI. * persisted. Typically, we build the references in memory at runtime just to
* However, occassionally we build the list of references for a more permanent reason, * satisfy the GUI. However, occasionally we build the list of references for a
* such as when we let a user choose a subset from a master list. * more permanent reason, such as when we let a user choose a subset from a
* master list.
* <p> * <p>
* When we persist such a reference, we can't persist the memory reference to the master * When we persist such a reference, we can't persist the memory reference to
* object. Instead, we persist the unique name or key of that object, and upon restoring * the master object. Instead, we persist the unique name or key of that object,
* from disk we then resolve that into a runtime reference to a real memory object. * and upon restoring from disk we then resolve that into a runtime reference to
* a real memory object.
* <p> * <p>
* This interface captures the methods to set and query that name or key. * This interface captures the methods to set and query that name or key.
* @noextend This interface is not intended to be extended by clients. *
* The standard extensions are included in the framework. * @noimplement This interface is not intended to be implemented by clients. The
* @noimplement This interface is not intended to be implemented by clients. * standard implementations are included in the framework.
* The standard implementations are included in the framework.
*/ */
public interface IRSEBasePersistableReferencingObject extends IRSEBaseReferencingObject { public interface IRSEBasePersistableReferencingObject extends IRSEBaseReferencingObject {
/** /**

View file

@ -19,8 +19,6 @@ package org.eclipse.rse.core.references;
/** /**
* Interface that any master object that is referenced must implement. * Interface that any master object that is referenced must implement.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -24,8 +24,6 @@ package org.eclipse.rse.core.references;
* real object. * real object.
* <p> * <p>
* This interface captures the simple set of methods such a shadow must implement. * This interface captures the simple set of methods such a shadow must implement.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -19,8 +19,6 @@ package org.eclipse.rse.core.references;
/** /**
* This is an object that can have shadow (reference) objects, which simply * This is an object that can have shadow (reference) objects, which simply
* point to this object, and a copy of this object's unique name or key (for storing on disk). * point to this object, and a copy of this object's unique name or key (for storing on disk).
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -34,8 +34,6 @@ package org.eclipse.rse.core.references;
* and manage the saving/restoring of that list. * and manage the saving/restoring of that list.
* <p> * <p>
* <b>YOU MUST OVERRIDE resolveReferencesAfterRestore IN YOUR REFERENCE MANAGER SUBCLASS</b> * <b>YOU MUST OVERRIDE resolveReferencesAfterRestore IN YOUR REFERENCE MANAGER SUBCLASS</b>
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -25,8 +25,6 @@ package org.eclipse.rse.core.references;
* <p> * <p>
* These references are not persistent. Persistent references are managed * These references are not persistent. Persistent references are managed
* by the subtype IRSEPersistableReferencedObject. * by the subtype IRSEPersistableReferencedObject.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -27,8 +27,6 @@ package org.eclipse.rse.core.references;
* <p> * <p>
* These references are not persistent. Persistent references are managed * These references are not persistent. Persistent references are managed
* by the subclass SystemPersistableReferencingObject. * by the subclass SystemPersistableReferencingObject.
* @noextend This interface is not intended to be extended by clients.
* The standard extensions are included in the framework.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework. * The standard implementations are included in the framework.
*/ */

View file

@ -20,13 +20,15 @@ package org.eclipse.rse.core.references;
import org.eclipse.rse.core.model.RSEModelObject; import org.eclipse.rse.core.model.RSEModelObject;
/** /**
* A class to encapsulate the operations required of an object which * A class to encapsulate the operations required of an object which supports
* supports references to it by other objects ({@link SystemReferencingObject}). * references to it by other objects ({@link SystemReferencingObject}). This
* This type of class needs to support maintaining an in-memory list of * type of class needs to support maintaining an in-memory list of all who
* all who reference it so that list can be following on delete and * reference it so that list can be following on delete and rename operations.
* rename operations. *
* @noextend This class is not intended to be subclassed by clients. * @noextend This class is not intended to be subclassed by clients. The
* The standard extensions are included in the framework. * standard extensions are included in the framework.
*
* @since org.eclipse.rse.core 3.0
*/ */
public abstract class SystemReferencedObject extends RSEModelObject implements IRSEReferencedObject { public abstract class SystemReferencedObject extends RSEModelObject implements IRSEReferencedObject {

View file

@ -21,11 +21,12 @@ package org.eclipse.rse.core.references;
import java.util.Vector; import java.util.Vector;
/** /**
* The class should be used by subclasses of {@link SystemReferencedObject} by instantiating it and delegating to it. * The class should be used by subclasses of {@link SystemReferencedObject} by
* @noextend This class is not intended to be subclassed by clients. * instantiating it and delegating to it.
* The standard extensions are included in the framework. *
* @noinstantiate This class is not intended to be instantiated by clients. * @noextend This class is not intended to be subclassed by clients. The
* The standard instances are created by the framework. * standard extensions are included in the framework.
* @since org.eclipse.rse.core 3.0
*/ */
public class SystemReferencedObjectHelper { public class SystemReferencedObjectHelper {

View file

@ -22,14 +22,16 @@ import org.eclipse.rse.core.model.RSEModelObject;
import org.eclipse.rse.internal.core.RSECoreMessages; import org.eclipse.rse.internal.core.RSECoreMessages;
/** /**
* A class to encapsulate the operations required of an object which * A class to encapsulate the operations required of an object which is merely a
* is merely a reference to another object, something we call a shadow. * reference to another object, something we call a shadow. Such shadows are
* Such shadows are needed to support a UI which displays the same * needed to support a UI which displays the same object in multiple places. To
* object in multiple places. To enable that, it is necessary not to * enable that, it is necessary not to use the same physical object in each UI
* use the same physical object in each UI representation as the UI * representation as the UI will only know how to update/refresh the first one
* will only know how to update/refresh the first one it finds. * it finds.
* @noextend This class is not intended to be subclassed by clients. *
* The standard extensions are included in the framework. * @noextend This class is not intended to be subclassed by clients. The
* standard extensions are included in the framework.
* @since org.eclipse.rse.core 3.0
*/ */
public abstract class SystemReferencingObject extends RSEModelObject implements IRSEReferencingObject { public abstract class SystemReferencingObject extends RSEModelObject implements IRSEReferencingObject {
private SystemReferencingObjectHelper helper = null; private SystemReferencingObjectHelper helper = null;

View file

@ -20,11 +20,14 @@ package org.eclipse.rse.core.references;
/** /**
* The class should be used by subclasses of {@link SystemReferencingObject} by instantiating it and delegating to it. * The class should be used by subclasses of {@link SystemReferencingObject} by
* @noextend This class is not intended to be subclassed by clients. * instantiating it and delegating to it.
* The standard extensions are included in the framework. *
* @noinstantiate This class is not intended to be instantiated by clients. * @noextend This class is not intended to be subclassed by clients. The
* The standard instances are created by the framework. * standard extensions are included in the framework.
* @noinstantiate This class is not intended to be instantiated by clients. The
* standard instances are created by the framework.
* @since org.eclipse.rse.core 3.0
*/ */
public class SystemReferencingObjectHelper { public class SystemReferencingObjectHelper {