mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-15 04:55:22 +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:10:53 +00:00
parent 24b78c6c94
commit 86a6dd5d70
15 changed files with 24 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java
View file

@ -10,7 +10,7 @@
* 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) - cleanup format and javadoc * David Dykstal (IBM) - cleanup format and javadoc
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
@ -26,13 +26,13 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
/** /**
* A filter consists of filter strings and may be contained in a filter pool. * A filter consists of filter strings and may be contained in a filter pool.
* Filter pools are referenced by subsystems. * Filter pools are referenced by subsystems. Subsystems are responsible for
* Subsystems are responsible for interpreting the filters. Filters, in and * interpreting the filters. Filters, in and of themselves, provide no
* of themselves, provide no interpretation of themselves when applied * interpretation of themselves when applied to the resources managed by a
* to the resources managed by a subsystem. * subsystem.
* @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 allowable implementations already present in the framwork. * allowable implementations already present in the framework.
*/ */
public interface ISystemFilter extends IRSEReferencedObject, ISystemFilterContainer, IRSEModelObject { public interface ISystemFilter extends IRSEReferencedObject, ISystemFilterContainer, IRSEModelObject {
@ -456,7 +456,7 @@ public interface ISystemFilter extends IRSEReferencedObject, ISystemFilterContai
* If this filter can contain child filters this will return the list of * If this filter can contain child filters this will return the list of
* children. * children.
* </p> * </p>
* *
* @return the value of the '<em>Nested Filters</em>' containment * @return the value of the '<em>Nested Filters</em>' containment
* reference list. * reference list.
* @see org.eclipse.rse.core.filters.ISystemFilter#getParentFilter * @see org.eclipse.rse.core.filters.ISystemFilter#getParentFilter
@ -488,7 +488,7 @@ public interface ISystemFilter extends IRSEReferencedObject, ISystemFilterContai
/** /**
* Returns the value of the '<em><b>Strings</b></em>' containment * Returns the value of the '<em><b>Strings</b></em>' containment
* reference list. * reference list.
* *
* @return the value of the '<em>Strings</em>' containment reference * @return the value of the '<em>Strings</em>' containment reference
* list. * list.
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java
View file

@ -22,7 +22,6 @@ import org.eclipse.rse.core.model.IRSEPersistableContainer;
/** /**
* Filter containers are any objects that contain filters. * Filter containers are any objects that contain filters.
* This includes filter pools and filters themselves. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java
View file

@ -31,7 +31,6 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* This interface captures those common methods, and both * This interface captures those common methods, and both
* SystemFilterReference and SystemFilterPoolReference * SystemFilterReference and SystemFilterPoolReference
* implement this interface and hence these methods. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java
View file

@ -25,7 +25,6 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencedObject;
/** /**
* This interface represents a system filter pool, which is a means of * This interface represents a system filter pool, which is a means of
* grouping filters to be referenced together. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java
View file

@ -33,7 +33,6 @@ import org.eclipse.rse.core.model.ISystemProfile;
* filter related activity through a single point like this, we can ensure that * filter related activity through a single point like this, we can ensure that
* all changes are saved to disk, and events are fired properly. * 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. * @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ISystemFilterPoolManager extends IRSEPersistableContainer { public interface ISystemFilterPoolManager extends IRSEPersistableContainer {

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java
View file

@ -32,7 +32,6 @@ import org.eclipse.core.runtime.IAdaptable;
* in order to fire events to update its GUI. So this interface captures those * 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 * callbacks that done to the provider for every interesting event. Should you
* not care about these, supply empty shells for these methods. * 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. * @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ISystemFilterPoolManagerProvider extends IAdaptable { public interface ISystemFilterPoolManagerProvider extends IAdaptable {

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java
View file

@ -24,7 +24,6 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencingObject;
* level, while subsystems contain references to one or more pools. A pool can be referenced * 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 * by multiple connections. Pools don't go away until explicitly deleted by the user, regardless
* of their reference count. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java
View file

@ -25,7 +25,6 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* a filter pool. This class builds on the parent class SystemPersistableReferenceManager, * a filter pool. This class builds on the parent class SystemPersistableReferenceManager,
* offering convenience versions of the parent methods that are typed to the * offering convenience versions of the parent methods that are typed to the
* classes in the filters framework. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java
View file

@ -30,7 +30,6 @@ package org.eclipse.rse.core.filters;
* in order to fire events to update its GUI. So this interface captures those * 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 * callbacks that done to the provider for every interesting event. Should you
* not care about these, supply empty shells for these methods. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

16
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.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 where extend / implement is allowed * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
*******************************************************************************/ *******************************************************************************/
@ -23,11 +23,11 @@ import org.eclipse.rse.core.references.IRSEReferencingObject;
import org.eclipse.rse.core.subsystems.ISubSystem; import org.eclipse.rse.core.subsystems.ISubSystem;
/** /**
* Represents a shadow or reference to a system filter. * Represents a shadow or reference to a system filter. Such references are only
* Such references are only transient, not savable to disk. * 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. * @noimplement This interface is not intended to be implemented by clients. The
* The allowable implementations are already present in the framework. * allowable implementations are already present in the framework.
*/ */
public interface ISystemFilterReference extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer { public interface ISystemFilterReference extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer {
/** /**

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java
View file

@ -16,7 +16,6 @@ import org.eclipse.rse.core.model.ISystemProfile;
import org.eclipse.rse.logging.Logger; 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java
View file

@ -28,7 +28,6 @@ import org.eclipse.rse.core.references.IRSEBaseReferencedObject;
* than a string, and its up to each consumer to know what to do with it. Generally, * 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 * a filter string edit pane is designed to prompt the user for the contents of the
* string in a domain-friendly way. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java
View file

@ -22,7 +22,6 @@ import org.eclipse.rse.core.references.IRSEBaseReferencingObject;
/** /**
* Represents a reference to a filter string. * Represents a reference to a filter string.
* Needed so the UI can show the same filter string multiple times. * 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. * @noimplement This interface is not intended to be implemented by clients.
* The allowable implementations are already present in the framework. * The allowable implementations are already present in the framework.
*/ */

10
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.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 where extend / implement is allowed * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
@ -15,11 +15,13 @@ import org.eclipse.rse.internal.core.filters.SystemFilterSimple;
/** /**
* Utilities to be used in the construction and manipulation of filters. * Utilities to be used in the construction and manipulation of filters.
* @noextend This interface is not intended to be extended by clients. *
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients. * @noinstantiate This class is not intended to be instantiated by clients.
* @since org.eclipse.rse.core 3.0
*/ */
public class SystemFilterUtil { public class SystemFilterUtil {
public static ISystemFilter makeSimpleFilter(String name) { public static ISystemFilter makeSimpleFilter(String name) {
return new SystemFilterSimple(name); return new SystemFilterSimple(name);
} }

1
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IHost.java
View file

@ -31,7 +31,6 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* An IHost holds information identifying a remote system. It also logically contains * An IHost holds information identifying a remote system. It also logically contains
* ISubSystem objects, although this containment is achievable programmatically versus via * ISubSystem objects, although this containment is achievable programmatically versus via
* object oriented containment. * object oriented containment.
* @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.
*/ */