mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-20 06:35:50 +02:00
Code Issues Wiki Activity

[cleanup] Get rid of @noextend on interfaces

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

41
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IProperty.java
View file

@ -1,15 +1,15 @@
/******************************************************************************** /********************************************************************************
* Copyright (c) 2006, 2008 IBM Corporation. All rights reserved. * Copyright (c) 2006, 2008 IBM Corporation. All rights reserved.
* This program and the accompanying materials are made available under the terms * This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is * of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html * available at http://www.eclipse.org/legal/epl-v10.html
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - added javadoc * David Dykstal (IBM) - added javadoc
* David Dykstal (IBM) - [150939] added read-only attribute * David Dykstal (IBM) - [150939] added read-only attribute
@ -23,17 +23,16 @@ 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.
*/ */
public interface IProperty { public interface IProperty {
/** /**
* @return the name of the property. * @return the name of the property.
*/ */
public String getKey(); public String getKey();
/** /**
* Sets the displayable label of the property. * Sets the displayable label of the property.
* @param label the label for this property. * @param label the label for this property.
@ -47,22 +46,22 @@ public interface IProperty {
/** /**
* Sets the value of this property. * Sets the value of this property.
* May raise a runtime exception if the new value of the property is * May raise a runtime exception if the new value of the property is
* not compatible with its type. * not compatible with its type.
* @param value the new value for this property. * @param value the new value for this property.
*/ */
public void setValue(String value); public void setValue(String value);
/** /**
* @return the value of this property * @return the value of this property
*/ */
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);
@ -73,16 +72,16 @@ public interface IProperty {
/** /**
* Sets the "enabled" presentation attribute of this property. * Sets the "enabled" presentation attribute of this property.
* This is an attribute that can be used to drive the presentation of this * This is an attribute that can be used to drive the presentation of this
* property and does not otherwise affect how this property can be used. * property and does not otherwise affect how this property can be used.
* Properties are enabled by default. * Properties are enabled by default.
* @param flag true if the property is to be enabled. * @param flag true if the property is to be enabled.
*/ */
public void setEnabled(boolean flag); public void setEnabled(boolean flag);
/** /**
* Retrieves the "enabled" presentation attribute of this property. * Retrieves the "enabled" presentation attribute of this property.
* This is an attribute that can be used to drive the presentation of this * This is an attribute that can be used to drive the presentation of this
* property and does not otherwise affect how this property can be used. * property and does not otherwise affect how this property can be used.
* @return true if the property is enabled. * @return true if the property is enabled.
*/ */
@ -90,7 +89,7 @@ public interface IProperty {
/** /**
* Sets the "read-only" presentation attribute of this property. * Sets the "read-only" presentation attribute of this property.
* This is an attribute that can be used to drive the presentation of this * This is an attribute that can be used to drive the presentation of this
* property and does not otherwise affect how this property can be used. * property and does not otherwise affect how this property can be used.
* Properties are read-write by default. * Properties are read-write by default.
* @param flag true if the property is to be read-only. * @param flag true if the property is to be read-only.
@ -99,7 +98,7 @@ public interface IProperty {
/** /**
* Retrieves the "read-only" presentation attribute of this property. * Retrieves the "read-only" presentation attribute of this property.
* This is an attribute that can be used to drive the presentation of this * This is an attribute that can be used to drive the presentation of this
* property and does not otherwise affect how this property can be used. * property and does not otherwise affect how this property can be used.
* @return true if the property is read-only. * @return true if the property is read-only.
*/ */

98
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertySet.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* Martin Oberhuber (Wind River) - Added Javadoc. * Martin Oberhuber (Wind River) - Added Javadoc.
* David McKnight (IBM) - [217715] [api] RSE property sets should support nested property sets * David McKnight (IBM) - [217715] [api] RSE property sets should support nested property sets
@ -23,91 +23,90 @@ import java.util.Map;
/** /**
* A Property Set stores key/value pairs, where the keys * A Property Set stores key/value pairs, where the keys
* are Strings and the values are an {@link IProperty}, * are Strings and the values are an {@link IProperty},
* of a type declared by an {@link IPropertyType}. * of a type declared by an {@link IPropertyType}.
* *
* The Property Set is identified by a name. * The Property Set is identified by a name.
* By default, the type of each property is of type String, and * By default, the type of each property is of type String, and
* in fact each value can be retrieved in String representation. * in fact each value can be retrieved in String representation.
* *
* 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.
*/ */
public interface IPropertySet extends IPropertySetContainer { public interface IPropertySet extends IPropertySetContainer {
/** /**
* The key used to store the description of the Property Set. * The key used to store the description of the Property Set.
* This is no longer used and should not be referenced except for * This is no longer used and should not be referenced except for
* compatibility reasons. * compatibility reasons.
*/ */
public static final String DESCRIPTION_KEY = "description"; //$NON-NLS-1$ public static final String DESCRIPTION_KEY = "description"; //$NON-NLS-1$
/** /**
* Return the name of this Property Set. * Return the name of this Property Set.
* @return String name of the Property Set. * @return String name of the Property Set.
*/ */
public String getName(); public String getName();
/** /**
* Return the description of this Property Set. * Return the description of this Property Set.
* *
* Note that in order to set the description, you need to call * Note that in order to set the description, you need to call
* <code>addProperty(IPropertySet.DESCRIPTION_KEY, "Description");</code> * <code>addProperty(IPropertySet.DESCRIPTION_KEY, "Description");</code>
* *
* @return Description of the Property Set, * @return Description of the Property Set,
* or <code>null</code> in case no description has been set. * or <code>null</code> in case no description has been set.
*/ */
public String getDescription(); public String getDescription();
/** /**
* Sets the description property of the property set. * Sets the description property of the property set.
* Fully equivalent to * Fully equivalent to
* <code>addProperty(IPropertySet.DESCRIPTION_KEY, description);</code> * <code>addProperty(IPropertySet.DESCRIPTION_KEY, description);</code>
* @param description the string describing this property set. * @param description the string describing this property set.
*/ */
public void setDescription(String description); public void setDescription(String description);
/** /**
* Return the {@link IProperty} associated with the given key. * Return the {@link IProperty} associated with the given key.
* *
* If the key is not in the set, <code>null</code> is returned. * If the key is not in the set, <code>null</code> is returned.
* *
* @param key String key for Property * @param key String key for Property
* @return requested Property, * @return requested Property,
* or <code>null</code> if the key is not found in the set. * or <code>null</code> if the key is not found in the set.
*/ */
public IProperty getProperty(String key); public IProperty getProperty(String key);
/** /**
* Return the String representation of a Property. * Return the String representation of a Property.
* *
* Provided that the key is found in the set, this is a shortcut * Provided that the key is found in the set, this is a shortcut
* for getProperty(key).getValue(). If the key is not in the set, * for getProperty(key).getValue(). If the key is not in the set,
* <code>null</code> is returned. * <code>null</code> is returned.
* *
* @param key String key for Property * @param key String key for Property
* @return String value of requested Property, * @return String value of requested Property,
* or <code>null</code> if the key is not found in the set. * or <code>null</code> if the key is not found in the set.
*/ */
public String getPropertyValue(String key); public String getPropertyValue(String key);
/** /**
* Return the list of Property Keys in this Set. * Return the list of Property Keys in this Set.
* *
* Provided that the Set has a description, the * Provided that the Set has a description, the
* @link{DESCRIPTION_KEY} key will also be in the list. * @link{DESCRIPTION_KEY} key will also be in the list.
* The interface defines no particular ordering for the * The interface defines no particular ordering for the
* keys. * keys.
* *
* @return String array of Property keys. * @return String array of Property keys.
*/ */
public String[] getPropertyKeys(); public String[] getPropertyKeys();
/** /**
* Return the type of the property identified by the given key. * Return the type of the property identified by the given key.
* *
* @param key String key for Property * @param key String key for Property
* @return Type of requested Property, * @return Type of requested Property,
* or <code>null</code> if the key is not found in the set. * or <code>null</code> if the key is not found in the set.
@ -122,22 +121,22 @@ public interface IPropertySet extends IPropertySetContainer {
/** /**
* Set all the Properties of this set. * Set all the Properties of this set.
* *
* @param map a Map of String to {@link IProperty} associations. * @param map a Map of String to {@link IProperty} associations.
*/ */
public void setProperties(Map map); public void setProperties(Map map);
/** /**
* Add a Property with String value to the set. * Add a Property with String value to the set.
* *
* In case a Property already exist for the given key, it will be overwritten * In case a Property already exist for the given key, it will be overwritten
* by the new value, note that this will <b>not</b> change the Property's type, * by the new value, note that this will <b>not</b> change the Property's type,
* so if the key identifies an integer Property but you set it to String value * so if the key identifies an integer Property but you set it to String value
* "foo" the resulting Property Set will be inconsistent. * "foo" the resulting Property Set will be inconsistent.
* *
* If the Property does not yet exist in the set, a new key will be added and * If the Property does not yet exist in the set, a new key will be added and
* the new Property will be of type "String". * the new Property will be of type "String".
* *
* @param key Key to add * @param key Key to add
* @param value Value to add * @param value Value to add
* @return The added Property * @return The added Property
@ -146,10 +145,10 @@ public interface IPropertySet extends IPropertySetContainer {
/** /**
* Add a typed Property to the set. * Add a typed Property to the set.
* *
* In case a Property already exists for the given key, it will be * In case a Property already exists for the given key, it will be
* removed and replaced by the new one. * removed and replaced by the new one.
* *
* @param key Key to add * @param key Key to add
* @param value Value to add * @param value Value to add
* @param type Type of the Property to add * @param type Type of the Property to add
@ -159,17 +158,18 @@ public interface IPropertySet extends IPropertySetContainer {
/** /**
* Remove a Property from the set. * Remove a Property from the set.
* *
* @param key The key to remove * @param key The key to remove
* @return <code>true</code> if the Property has been removed, * @return <code>true</code> if the Property has been removed,
* or <code>false</code> if the key has not been part of the set. * or <code>false</code> if the key has not been part of the set.
*/ */
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);

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertySetContainer.java
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.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertyType.java
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.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IRSECallback.java
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 {

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IRSEPersistableContainer.java
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.
*/ */

21
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISubSystemConfigurationCategories.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement * David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
*******************************************************************************/ *******************************************************************************/
@ -18,23 +18,24 @@
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 {
/** /**
* Job subsystems * Job subsystems
*/ */
public static final String SUBSYSTEM_CATEGORY_JOBS = "jobs"; //$NON-NLS-1$ public static final String SUBSYSTEM_CATEGORY_JOBS = "jobs"; //$NON-NLS-1$
/** /**
* File subsystems * File subsystems
*/ */
public static final String SUBSYSTEM_CATEGORY_FILES = "files"; //$NON-NLS-1$ public static final String SUBSYSTEM_CATEGORY_FILES = "files"; //$NON-NLS-1$
/** /**
* Command subsystems * Command subsystems
*/ */
public static final String SUBSYSTEM_CATEGORY_CMDS = "commands"; //$NON-NLS-1$ public static final String SUBSYSTEM_CATEGORY_CMDS = "commands"; //$NON-NLS-1$

14
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISubSystemConfigurator.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [168976][api] move ISystemNewConnectionWizardPage from core to UI * David Dykstal (IBM) - [168976][api] move ISystemNewConnectionWizardPage from core to UI
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement * David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
@ -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 {
@ -33,7 +35,7 @@ public interface ISubSystemConfigurator {
* Return the subsystem configuration associated with these properties. * Return the subsystem configuration associated with these properties.
*/ */
public ISubSystemConfiguration getSubSystemConfiguration(); public ISubSystemConfiguration getSubSystemConfiguration();
/** /**
* Apply the values herein to a subsystem. * Apply the values herein to a subsystem.
* @param ss the subystem to be affected. * @param ss the subystem to be affected.

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemContainer.java
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.

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemHostPool.java
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.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemMessageObject.java
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.
*/ */

14
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemModifiableContainer.java
View file

@ -1,9 +1,9 @@
/********************************************************************************* /*********************************************************************************
* Copyright (c) 2008 IBM Corporation. All rights reserved. * Copyright (c) 2008 IBM Corporation. All rights reserved.
* This program and the accompanying materials are made available under the terms * This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is * of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html * available at http://www.eclipse.org/legal/epl-v10.html
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement * David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
@ -13,12 +13,14 @@ 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 {
/** /**
* Cache contents of a certain type. * Cache contents of a certain type.
* @param type the contents type. * @param type the contents type.

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfile.java
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.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java
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.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemResourceSet.java
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.
*/ */

19
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/PropertyType.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - added javadoc, minor changes * David Dykstal (IBM) - added javadoc, minor changes
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement * David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
@ -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 {
@ -39,7 +38,7 @@ public class PropertyType implements IPropertyType {
private PropertyType(int type) { private PropertyType(int type) {
_type = type; _type = type;
} }
/** /**
* Returns an instance of boolean property type. * Returns an instance of boolean property type.
* @return IPropertyType * @return IPropertyType
@ -47,7 +46,7 @@ public class PropertyType implements IPropertyType {
public static IPropertyType getBooleanPropertyType() { public static IPropertyType getBooleanPropertyType() {
return _booleanPropertyType; return _booleanPropertyType;
} }
/** /**
* Returns an instance of integer property type. * Returns an instance of integer property type.
* @return IPropertyType * @return IPropertyType
@ -66,7 +65,7 @@ public class PropertyType implements IPropertyType {
/** /**
* Returns an instance of enum property type. * Returns an instance of enum property type.
* @param values String[] array of allowed enumerator values. * @param values String[] array of allowed enumerator values.
* @return IPropertyType * @return IPropertyType
*/ */
public static IPropertyType getEnumPropertyType(String[] values) { public static IPropertyType getEnumPropertyType(String[] values) {

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferenceManager.java
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.
*/ */

48
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java
View file

@ -1,15 +1,15 @@
/******************************************************************************** /********************************************************************************
* Copyright (c) 2002, 2008 IBM Corporation. All rights reserved. * Copyright (c) 2002, 2008 IBM Corporation. All rights reserved.
* This program and the accompanying materials are made available under the terms * This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is * of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html * available at http://www.eclipse.org/legal/epl-v10.html
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
********************************************************************************/ ********************************************************************************/
@ -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 {

41
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencingObject.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
*******************************************************************************/ *******************************************************************************/
@ -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 {
/** /**

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencedObject.java
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.
*/ */

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java
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.
*/ */

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencedObject.java
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.
*/ */

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencingObject.java
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.
*/ */

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencedObject.java
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.
*/ */

2
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencingObject.java
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.
*/ */

26
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObject.java
View file

@ -1,15 +1,15 @@
/******************************************************************************** /********************************************************************************
* Copyright (c) 2002, 2008 IBM Corporation. All rights reserved. * Copyright (c) 2002, 2008 IBM Corporation. All rights reserved.
* This program and the accompanying materials are made available under the terms * This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is * of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html * available at http://www.eclipse.org/legal/epl-v10.html
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
@ -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 {

17
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObjectHelper.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
@ -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 {

28
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObject.java
View file

@ -1,15 +1,15 @@
/******************************************************************************** /********************************************************************************
* Copyright (c) 2002, 2008 IBM Corporation and others. All rights reserved. * Copyright (c) 2002, 2008 IBM Corporation and others. All rights reserved.
* This program and the accompanying materials are made available under the terms * This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is * of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html * available at http://www.eclipse.org/legal/epl-v10.html
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType * Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
@ -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;

21
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObjectHelper.java
View file

@ -7,10 +7,10 @@
* *
* Initial Contributors: * Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer * The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir, * component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
@ -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 {
@ -33,7 +36,7 @@ public class SystemReferencingObjectHelper {
/** /**
* Default constructor. * Default constructor.
* @param caller the reference that this object is helping. * @param caller the reference that this object is helping.
*/ */
public SystemReferencingObjectHelper(IRSEBaseReferencingObject caller) { public SystemReferencingObjectHelper(IRSEBaseReferencingObject caller) {
super(); super();