mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-09-10 12:03:16 +02:00
Code Issues Wiki Activity

[cleanup] Fix missing @since tags

Browse source
This commit is contained in:
Martin Oberhuber 2008-03-31 08:31:48 +00:00
parent 00d19c7ee2
commit 535eca4bbd
2 changed files with 97 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemRemoteChangeEvent.java
View file

@ -1,13 +1,13 @@
/********************************************************************************
* Copyright (c) 2002, 2007 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
* 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
*
* 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:
@ -24,7 +24,7 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
* A change event passed to you when listening for remote resource changes.
* Note these are post-events, sent after the fact.
*/
public interface ISystemRemoteChangeEvent
public interface ISystemRemoteChangeEvent
{
/**
* Get the event type, such as {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents#SYSTEM_REMOTE_RESOURCE_CREATED}.
@ -34,41 +34,49 @@ public interface ISystemRemoteChangeEvent
public int getEventType();
/**
* Get the resource that this event applies to.
* Get the resource that this event applies to.
* It must either be the binary object of the resource, or the absolute name of the resource,
* or a List of absolute names of the resources
* @return the resource that this event applies to.
*/
public Object getResource();
/**
* Get the parent remote object for the affected remote object. This is not always known,
* but when it is (ie, non null) then it can be used to refresh all expanded occurrences of that parent
* @return the parent remote object of the affected resource,
* or <code>null</code> if not applicable.
* or <code>null</code> if not applicable.
*/
public Object getResourceParent();
/**
* Get the old name(s) of the resource(s), in the event of a resource rename, move or copy.
* Null for other event types.
* @return the old names of the resources in case of a rename event,
* or <code>null</code> if not applicable.
* Get the old name(s) of the resource(s), in the event of a resource
* rename, move or copy. Null for other event types.
*
* @return the old names of the resources in case of a rename event, or
* <code>null</code> if not applicable.
* @since org.eclipse.rse.core 3.0
*/
public String[] getOldNames();
/**
* Get the subsystem in which this resource resides.
* Get the subsystem in which this resource resides.
* This allows the search for impacts to be limited to subsystems
* of the same parent factory, and to connections with the same
* of the same parent factory, and to connections with the same
* hostname as the subsystem's connection.
* @return the subsystem in which this resource resides.
*/
public ISubSystem getSubSystem();
/**
* Returns the operation of this event if it's not implied by the event itself
* Returns the operation of this event if it's not implied by the event
* itself.
*
* @see ISystemRemoteChangeEvents#SYSTEM_REMOTE_OPERATION_COPY
* @see ISystemRemoteChangeEvents#SYSTEM_REMOTE_OPERATION_MOVE
*
* @return the operation that triggered this event
* @since org.eclipse.rse.core 3.0
*/
public String getOperation();
}

102
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemRegistry.java
View file

@ -775,54 +775,100 @@ public interface ISystemRegistry extends ISchedulingRule, IAdaptable, ISystemVie
/**
* Notify all listeners of a change to a remote resource such as a file.
* This one takes the information needed and creates the event for you.
* @param eventType - one of the constants from {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the resource as would be given by calling getAbsoluteName on its remote adapter
* @param resourceParent - the remote resource's parent object, or absolute name, if that is known. If it is non-null, this will aid in refreshing occurences of that parent.
* @param subsystem - the subsystem which contains this remote resource. This allows the search for impacts to be
* limited to subsystems of the same parent factory, and to connections with the same hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the absolute names of the resources prior to the operation
*
* @param eventType - one of the constants from
* {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the
* resource as would be given by calling getAbsoluteName on its
* remote adapter
* @param resourceParent - the remote resource's parent object, or absolute
* name, if that is known. If it is non-null, this will aid in
* refreshing occurrences of that parent.
* @param subsystem - the subsystem which contains this remote resource.
* This allows the search for impacts to be limited to subsystems
* of the same parent factory, and to connections with the same
* hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the
* absolute names of the resources prior to the operation
* @since org.eclipse.rse.core 3.0
*/
public void fireRemoteResourceChangeEvent(int eventType, Object resource, Object resourceParent, ISubSystem subsystem, String[] oldNames);
/**
* Notify all listeners of a change to a remote resource such as a file.
* This one takes the information needed and creates the event for you.
* @param eventType - one of the constants from {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the resource as would be given by calling getAbsoluteName on its remote adapter
* @param resourceParent - the remote resource's parent object, or absolute name, if that is known. If it is non-null, this will aid in refreshing occurences of that parent.
* @param subsystem - the subsystem which contains this remote resource. This allows the search for impacts to be
* limited to subsystems of the same parent factory, and to connections with the same hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the absolute names of the resources prior to the operation
* @param originatingViewer - optional. If set, this gives the viewer a clue that it should select the affected resource after refreshing its parent.
* This saves sending a separate event to reveal and select the new created resource on a create event, for example.
*
* @param eventType - one of the constants from
* {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the
* resource as would be given by calling getAbsoluteName on its
* remote adapter
* @param resourceParent - the remote resource's parent object, or absolute
* name, if that is known. If it is non-null, this will aid in
* refreshing occurrences of that parent.
* @param subsystem - the subsystem which contains this remote resource.
* This allows the search for impacts to be limited to subsystems
* of the same parent factory, and to connections with the same
* hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the
* absolute names of the resources prior to the operation
* @param originatingViewer - optional. If set, this gives the viewer a clue
* that it should select the affected resource after refreshing
* its parent. This saves sending a separate event to reveal and
* select the new created resource on a create event, for
* example.
* @since org.eclipse.rse.core 3.0
*/
public void fireRemoteResourceChangeEvent(int eventType, Object resource, Object resourceParent, ISubSystem subsystem, String[] oldNames, Object originatingViewer);
/**
* Notify all listeners of a change to a remote resource such as a file.
* This one takes the information needed and creates the event for you.
*
* @param operation - the operation for which this event was fired
* @param eventType - one of the constants from {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the resource as would be given by calling getAbsoluteName on its remote adapter
* @param resourceParent - the remote resource's parent object, or absolute name, if that is known. If it is non-null, this will aid in refreshing occurences of that parent.
* @param subsystem - the subsystem which contains this remote resource. This allows the search for impacts to be
* limited to subsystems of the same parent factory, and to connections with the same hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the absolute names of the resources prior to the operation
* @param eventType - one of the constants from
* {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the
* resource as would be given by calling getAbsoluteName on its
* remote adapter
* @param resourceParent - the remote resource's parent object, or absolute
* name, if that is known. If it is non-null, this will aid in
* refreshing occurrences of that parent.
* @param subsystem - the subsystem which contains this remote resource.
* This allows the search for impacts to be limited to subsystems
* of the same parent factory, and to connections with the same
* hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the
* absolute names of the resources prior to the operation
* @since org.eclipse.rse.core 3.0
*/
public void fireRemoteResourceChangeEvent(String operation, int eventType, Object resource, Object resourceParent, ISubSystem subsystem, String[] oldNames);
/**
* Notify all listeners of a change to a remote resource such as a file.
* This one takes the information needed and creates the event for you.
*
* @param operation - the operation for which this event was fired
* @param eventType - one of the constants from {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the resource as would be given by calling getAbsoluteName on its remote adapter
* @param resourceParent - the remote resource's parent object, or absolute name, if that is known. If it is non-null, this will aid in refreshing occurences of that parent.
* @param subsystem - the subsystem which contains this remote resource. This allows the search for impacts to be
* limited to subsystems of the same parent factory, and to connections with the same hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the absolute names of the resources prior to the operation
* @param originatingViewer - optional. If set, this gives the viewer a clue that it should select the affected resource after refreshing its parent.
* This saves sending a separate event to reveal and select the new created resource on a create event, for example.
* @param eventType - one of the constants from
* {@link org.eclipse.rse.core.events.ISystemRemoteChangeEvents}
* @param resource - the remote resource object, or absolute name of the
* resource as would be given by calling getAbsoluteName on its
* remote adapter
* @param resourceParent - the remote resource's parent object, or absolute
* name, if that is known. If it is non-null, this will aid in
* refreshing occurrences of that parent.
* @param subsystem - the subsystem which contains this remote resource.
* This allows the search for impacts to be limited to subsystems
* of the same parent factory, and to connections with the same
* hostname as the subsystem's connection.
* @param oldNames - on a rename, copy or move operation, these are the
* absolute names of the resources prior to the operation
* @param originatingViewer - optional. If set, this gives the viewer a clue
* that it should select the affected resource after refreshing
* its parent. This saves sending a separate event to reveal and
* select the new created resource on a create event, for
* example.
* @since org.eclipse.rse.core 3.0
*/
public void fireRemoteResourceChangeEvent(String operation, int eventType, Object resource, Object resourceParent, ISubSystem subsystem, String[] oldNames, Object originatingViewer);