mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-04 06:45:43 +02:00
[releng][cleanup] Fix @since tags according to API Tooling
This commit is contained in:
Martin Oberhuber
parent
c5774fd9f1
commit
2b1dd8f0b3
2 changed files with 133 additions and 83 deletions
|
|
@ -21,9 +21,13 @@ package org.eclipse.rse.core.events;
|
|||
import org.eclipse.rse.core.subsystems.ISubSystem;
|
||||
|
||||
/**
|
||||
* For listeners interested in changes with remote resources.
|
||||
* These events are designed to state what the change to the resource was, not to
|
||||
* optimize those events for a GUI (eg, a delete event versus a refresh event)
|
||||
* For listeners interested in changes with remote resources. These events are
|
||||
* designed to state what the change to the resource was, not to optimize those
|
||||
* events for a GUI (eg, a delete event versus a refresh event).
|
||||
*
|
||||
* In RSE 3.0, the concept of Operation type was added (See
|
||||
* {@link #setOperation(String)} and the new Constructors, and the oldNames
|
||||
* property was extended from a single String into a String array.
|
||||
*/
|
||||
public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
||||
{
|
||||
|
|
@ -52,15 +56,25 @@ public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
|||
this.subsystem = subsystem;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Constructor for a rename event.
|
||||
* @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,
|
||||
* or List of absoluteNames
|
||||
* @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, or List of absoluteNames
|
||||
* @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 3.0 replaced String oldName by String[] oldNames
|
||||
*/
|
||||
public SystemRemoteChangeEvent(int eventType, Object resource, Object resourceParent, ISubSystem subsystem, String[] oldNames)
|
||||
{
|
||||
|
|
@ -70,13 +84,23 @@ public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
|||
|
||||
/**
|
||||
* Constructor for non-rename event
|
||||
* @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,
|
||||
* or List of absoluteNames
|
||||
* @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 operation - the operation for which this event was fired. From
|
||||
* {@link ISystemRemoteChangeEvents#SYSTEM_REMOTE_OPERATION_COPY}
|
||||
* and related String constants
|
||||
* @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, or List of absoluteNames
|
||||
* @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.
|
||||
* @since 3.0
|
||||
*/
|
||||
public SystemRemoteChangeEvent(String operation, int eventType, Object resource, Object resourceParent, ISubSystem subsystem)
|
||||
{
|
||||
|
|
@ -90,14 +114,25 @@ public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
|||
|
||||
/**
|
||||
* Constructor for a rename event.
|
||||
* @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,
|
||||
* or List of absoluteNames
|
||||
* @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 operation - the operation for which this event was fired. From
|
||||
* {@link ISystemRemoteChangeEvents#SYSTEM_REMOTE_OPERATION_COPY}
|
||||
* and related String constants
|
||||
* @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, or List of absoluteNames
|
||||
* @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 3.0
|
||||
*/
|
||||
public SystemRemoteChangeEvent(String operation, int eventType, Object resource, Object resourceParent, ISubSystem subsystem, String[] oldNames)
|
||||
{
|
||||
|
|
@ -145,6 +180,8 @@ public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
|||
|
||||
/**
|
||||
* Reset the old names on a rename, move or copy event
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
public void setOldNames(String[] oldNames)
|
||||
{
|
||||
|
|
@ -190,7 +227,10 @@ public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the old name of the resource, in the event of a resource rename. Null for other event types.
|
||||
* Get the old name of the resource, in the event of a resource rename. Null
|
||||
* for other event types.
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
public String[] getOldNames()
|
||||
{
|
||||
|
|
@ -219,16 +259,23 @@ public class SystemRemoteChangeEvent implements ISystemRemoteChangeEvent
|
|||
}
|
||||
|
||||
|
||||
/**
|
||||
* @since 3.0
|
||||
* @param operation from
|
||||
* {@link ISystemRemoteChangeEvents#SYSTEM_REMOTE_OPERATION_COPY}
|
||||
* and related String constants
|
||||
*/
|
||||
public void setOperation(String operation){
|
||||
this.operation = operation;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the operation of this event if it's not implied by the event itself.
|
||||
* The operation can be optionally specified when the event is constructed.
|
||||
* By default this will return null.
|
||||
* Returns the operation of this event if it's not implied by the event
|
||||
* itself. The operation can be optionally specified when the event is
|
||||
* constructed. By default this will return null.
|
||||
*
|
||||
* @return the operation that triggered this event
|
||||
* @since 3.0
|
||||
*/
|
||||
public String getOperation() {
|
||||
return operation;
|
||||
|
|
|
|||
|
|
@ -27,10 +27,13 @@ import org.eclipse.rse.core.model.RSEModelObject;
|
|||
import org.eclipse.rse.internal.core.RSECoreMessages;
|
||||
|
||||
/**
|
||||
* Abstract class intended to be extended to provide a means for starting a remote server from
|
||||
* the client. DStore-based connector services use this to determine whether to start a sever via daemon, REXEC, or
|
||||
* some other mechanism. For systems that don't need to start remote servers from RSE, this is not
|
||||
* needed.
|
||||
* Abstract class intended to be extended to provide a means for starting a
|
||||
* remote server from the client. DStore-based connector services use this to
|
||||
* determine whether to start a sever via daemon, REXEC, or some other
|
||||
* mechanism. For systems that don't need to start remote servers from RSE, this
|
||||
* is not needed.
|
||||
*
|
||||
* @since 3.0 moved from non-API to API
|
||||
*/
|
||||
public abstract class ServerLauncher extends RSEModelObject implements IServerLauncherProperties, ILabeledObject
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue