mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-03 23:25:26 +02:00
[cleanup] Get rid of @noextend on interfaces
This commit is contained in:
Martin Oberhuber
parent
24b78c6c94
commit
86a6dd5d70
15 changed files with 24 additions and 34 deletions
|
|
@ -10,7 +10,7 @@
|
|||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - cleanup format and javadoc
|
||||
* 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.
|
||||
* Filter pools are referenced by subsystems.
|
||||
* Subsystems are responsible for interpreting the filters. Filters, in and
|
||||
* of themselves, provide no interpretation of themselves when applied
|
||||
* to the resources managed by a subsystem.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations already present in the framwork.
|
||||
* Filter pools are referenced by subsystems. Subsystems are responsible for
|
||||
* interpreting the filters. Filters, in and of themselves, provide no
|
||||
* interpretation of themselves when applied to the resources managed by a
|
||||
* subsystem.
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients. The
|
||||
* allowable implementations already present in the framework.
|
||||
*/
|
||||
|
||||
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
|
||||
* children.
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @return the value of the '<em>Nested Filters</em>' containment
|
||||
* reference list.
|
||||
* @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
|
||||
* reference list.
|
||||
*
|
||||
*
|
||||
* @return the value of the '<em>Strings</em>' containment reference
|
||||
* list.
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@ import org.eclipse.rse.core.model.IRSEPersistableContainer;
|
|||
/**
|
||||
* Filter containers are any objects that contain filters.
|
||||
* This includes filter pools and filters themselves.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -31,7 +31,6 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
|
|||
* This interface captures those common methods, and both
|
||||
* SystemFilterReference and SystemFilterPoolReference
|
||||
* implement this interface and hence these methods.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencedObject;
|
|||
/**
|
||||
* This interface represents a system filter pool, which is a means of
|
||||
* grouping filters to be referenced together.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -33,7 +33,6 @@ import org.eclipse.rse.core.model.ISystemProfile;
|
|||
* filter related activity through a single point like this, we can ensure that
|
||||
* all changes are saved to disk, and events are fired properly.
|
||||
*
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
*/
|
||||
public interface ISystemFilterPoolManager extends IRSEPersistableContainer {
|
||||
|
|
|
|||
|
|
@ -32,7 +32,6 @@ import org.eclipse.core.runtime.IAdaptable;
|
|||
* in order to fire events to update its GUI. So this interface captures those
|
||||
* callbacks that done to the provider for every interesting event. Should you
|
||||
* not care about these, supply empty shells for these methods.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
*/
|
||||
public interface ISystemFilterPoolManagerProvider extends IAdaptable {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
* by multiple connections. Pools don't go away until explicitly deleted by the user, regardless
|
||||
* of their reference count.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
|
|||
* a filter pool. This class builds on the parent class SystemPersistableReferenceManager,
|
||||
* offering convenience versions of the parent methods that are typed to the
|
||||
* classes in the filters framework.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -30,7 +30,6 @@ package org.eclipse.rse.core.filters;
|
|||
* in order to fire events to update its GUI. So this interface captures those
|
||||
* callbacks that done to the provider for every interesting event. Should you
|
||||
* not care about these, supply empty shells for these methods.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* 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;
|
||||
|
||||
/**
|
||||
* Represents a shadow or reference to a system filter.
|
||||
* Such references are only transient, not savable to disk.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
* Represents a shadow or reference to a system filter. Such references are only
|
||||
* transient, not savable to disk.
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients. The
|
||||
* allowable implementations are already present in the framework.
|
||||
*/
|
||||
public interface ISystemFilterReference extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@ import org.eclipse.rse.core.model.ISystemProfile;
|
|||
import org.eclipse.rse.logging.Logger;
|
||||
|
||||
/**
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
* a filter string edit pane is designed to prompt the user for the contents of the
|
||||
* string in a domain-friendly way.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@ import org.eclipse.rse.core.references.IRSEBaseReferencingObject;
|
|||
/**
|
||||
* Represents a reference to a filter string.
|
||||
* Needed so the UI can show the same filter string multiple times.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The allowable implementations are already present in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/*********************************************************************************
|
||||
* Copyright (c) 2008 IBM Corporation. All rights reserved.
|
||||
* 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
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
|
||||
|
|
@ -15,11 +15,13 @@ import org.eclipse.rse.internal.core.filters.SystemFilterSimple;
|
|||
|
||||
/**
|
||||
* 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.
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public class SystemFilterUtil {
|
||||
|
||||
|
||||
public static ISystemFilter makeSimpleFilter(String name) {
|
||||
return new SystemFilterSimple(name);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -31,7 +31,6 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
|
|||
* An IHost holds information identifying a remote system. It also logically contains
|
||||
* ISubSystem objects, although this containment is achievable programmatically versus via
|
||||
* 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.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue