1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-04 14:55:41 +02:00

[releng][cleanup] Fix @since tags according to API Tooling

This commit is contained in:
Martin Oberhuber 2008-06-04 08:42:13 +00:00
parent ea0adaea28
commit e13dc52133
12 changed files with 415 additions and 363 deletions

View file

@ -123,6 +123,7 @@ public interface IUniversalDataStoreConstants
public static final String TYPE_QUALIFIED_CLASSNAME = "fullClassName"; //$NON-NLS-1$ public static final String TYPE_QUALIFIED_CLASSNAME = "fullClassName"; //$NON-NLS-1$
// permissions commands // permissions commands
/** @since org.eclipse.rse.services.dstore 3.0 */
public static final String C_QUERY_FILE_PERMISSIONS = "C_QUERY_FILE_PERMISSIONS"; //$NON-NLS-1$ public static final String C_QUERY_FILE_PERMISSIONS = "C_QUERY_FILE_PERMISSIONS"; //$NON-NLS-1$
/** @since org.eclipse.rse.services.dstore 3.0 */ /** @since org.eclipse.rse.services.dstore 3.0 */
public static final String C_SET_FILE_PERMISSIONS = "C_SET_FILE_PERMISSIONS"; //$NON-NLS-1$ public static final String C_SET_FILE_PERMISSIONS = "C_SET_FILE_PERMISSIONS"; //$NON-NLS-1$

View file

@ -1601,6 +1601,9 @@ public class UniversalFileSystemMiner extends Miner {
} }
/**
* @since 3.0 made private method public
*/
public AbsoluteVirtualPath getAbsoluteVirtualPath(DataElement subject) { public AbsoluteVirtualPath getAbsoluteVirtualPath(DataElement subject) {
StringBuffer path = new StringBuffer(subject.getAttribute(DE.A_VALUE)); StringBuffer path = new StringBuffer(subject.getAttribute(DE.A_VALUE));
if (ArchiveHandlerManager.getInstance().isArchive( if (ArchiveHandlerManager.getInstance().isArchive(

View file

@ -44,6 +44,10 @@ public abstract class AbstractDStoreService extends AbstractService implements I
protected Map _cmdDescriptorMap; protected Map _cmdDescriptorMap;
protected DataElement _initializeStatus; protected DataElement _initializeStatus;
/**
* @since 3.0 got rid of ISystemMessageProvider argument
* @param dataStoreProvider
*/
public AbstractDStoreService(IDataStoreProvider dataStoreProvider) public AbstractDStoreService(IDataStoreProvider dataStoreProvider)
{ {
_dataStoreProvider = dataStoreProvider; _dataStoreProvider = dataStoreProvider;
@ -148,6 +152,7 @@ public abstract class AbstractDStoreService extends AbstractService implements I
return new DataElement[0]; return new DataElement[0];
} }
/** @since 3.0 */
protected List dsQueryCommandMulti(DataElement[] subjects, String[] commands, IProgressMonitor monitor) protected List dsQueryCommandMulti(DataElement[] subjects, String[] commands, IProgressMonitor monitor)
{ {
return dsQueryCommandMulti(subjects, null, commands, monitor); return dsQueryCommandMulti(subjects, null, commands, monitor);
@ -155,11 +160,13 @@ public abstract class AbstractDStoreService extends AbstractService implements I
/** /**
* Query multiple subjects in one shot * Query multiple subjects in one shot
*
* @param subjects the subjects to query * @param subjects the subjects to query
* @param commands the query commands * @param commands the query commands
* @param argses arguments for the command - may be null * @param argses arguments for the command - may be null
* @param monitor the progress monitor * @param monitor the progress monitor
* @return a list of DataElement[]s containing the results of each query * @return a list of DataElement[]s containing the results of each query
* @since 3.0
*/ */
protected List dsQueryCommandMulti(DataElement[] subjects, ArrayList[] argses, String[] commands, IProgressMonitor monitor) protected List dsQueryCommandMulti(DataElement[] subjects, ArrayList[] argses, String[] commands, IProgressMonitor monitor)
{ {

View file

@ -313,14 +313,16 @@ public class DStoreStatusMonitor implements IDomainListener
return status; return status;
} }
/**
* Returns the status of a running command for the specified cmd desciptor and subject. /**
* If there is no such command running, then null is returned. * Returns the status of a running command for the specified cmd desciptor
* * and subject. If there is no such command running, then null is returned.
* @param cmdDescriptor *
* @param subject * @param cmdDescriptor
* @return the status of the command. * @param subject
*/ * @return the status of the command.
* @since 3.0
*/
public DataElement getCommandStatus(DataElement cmdDescriptor, DataElement subject) public DataElement getCommandStatus(DataElement cmdDescriptor, DataElement subject)
{ {
synchronized (_workingStatuses){ synchronized (_workingStatuses){

View file

@ -82,6 +82,7 @@ public class DownloadListener implements IDomainListener
} }
} }
/** @since 3.0 */
public long getTotalLength() public long getTotalLength()
{ {
return _totalLength; return _totalLength;
@ -92,6 +93,7 @@ public class DownloadListener implements IDomainListener
return _isCancelled; return _isCancelled;
} }
/** @since 3.0 */
public boolean isDone() public boolean isDone()
{ {
return _isDone; return _isDone;

View file

@ -23,8 +23,10 @@ import org.eclipse.rse.core.model.ISystemRegistry;
import org.eclipse.rse.subsystems.files.core.subsystems.IRemoteFileSubSystem; import org.eclipse.rse.subsystems.files.core.subsystems.IRemoteFileSubSystem;
/** /**
* Decorates an input stream that was created in the service layer. * Decorates an input stream that was created in the service layer. The purpose
* The purpose of this class is to notify download after the stream is closed. * of this class is to notify download after the stream is closed.
*
* @since 3.0
*/ */
public class FileSubSystemInputStream extends InputStream { public class FileSubSystemInputStream extends InputStream {

View file

@ -23,9 +23,10 @@ import org.eclipse.rse.core.model.ISystemRegistry;
import org.eclipse.rse.subsystems.files.core.subsystems.IRemoteFileSubSystem; import org.eclipse.rse.subsystems.files.core.subsystems.IRemoteFileSubSystem;
/** /**
* Decorates an output stream that was created in the service layer. * Decorates an output stream that was created in the service layer. The purpose
* The purpose of this class is to notify upload after the stream is closed. * of this class is to notify upload after the stream is closed.
* *
* @since 3.0
*/ */
public class FileSubSystemOutputStream extends OutputStream { public class FileSubSystemOutputStream extends OutputStream {

View file

@ -108,6 +108,7 @@ public interface IRemoteFile extends IRemoteContainer, IRemotePropertyHolder, IS
/** /**
* Return the connection this remote file is from. * Return the connection this remote file is from.
* @since 3.0 renamed getSystemConnection() to getHost()
*/ */
public IHost getHost(); public IHost getHost();

View file

@ -333,9 +333,11 @@ public abstract class RemoteFile implements IRemoteFile, IAdaptable, Comparable
return ArchiveHandlerManager.getInstance().isArchive(file); return ArchiveHandlerManager.getInstance().isArchive(file);
} }
/** /**
* Return the connection this remote file is from. * Return the connection this remote file is from.
*/ *
* @since 3.0 renamed getSystemConnection() to getHost()
*/
public IHost getHost() public IHost getHost()
{ {
IRemoteFileSubSystem ss = _context.getParentRemoteFileSubSystem(); IRemoteFileSubSystem ss = _context.getParentRemoteFileSubSystem();
@ -1203,6 +1205,11 @@ public abstract class RemoteFile implements IRemoteFile, IAdaptable, Comparable
RemoteFileEncodingManager.getInstance().setEncoding(getHostName(), getAbsolutePath(), encoding); RemoteFileEncodingManager.getInstance().setEncoding(getHostName(), getAbsolutePath(), encoding);
} }
/**
* {@inheritDoc}
*
* @since 3.0
*/
public IHostFilePermissions getPermissions() { public IHostFilePermissions getPermissions() {
IHostFile hostFile = getHostFile(); IHostFile hostFile = getHostFile();
if (hostFile instanceof IHostFilePermissionsContainer){ if (hostFile instanceof IHostFilePermissionsContainer){

View file

@ -34,6 +34,9 @@ public class RemoteFileEmpty extends RemoteFile
super(new RemoteFileContext(null,null,null)); super(new RemoteFileContext(null,null,null));
} }
/**
* @since 3.0
*/
public String getAbsolutePath() public String getAbsolutePath()
{ {
return ""; //$NON-NLS-1$ return ""; //$NON-NLS-1$

View file

@ -167,6 +167,9 @@ public class RemoteFileRoot extends RemoteFile
return rootFile.getClassification(); return rootFile.getClassification();
} }
/**
* @since 3.0
*/
public String getAbsolutePath() public String getAbsolutePath()
{ {
return rootFile.getAbsolutePath(); return rootFile.getAbsolutePath();

View file

@ -881,11 +881,15 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi
} }
/** /**
* Return a list of all remote folders and files in the given folder. The list is not subsetted. * Return a list of all remote folders and files in the given folder. The
* list is not subsetted.
*
* @param parents The parent folders to list folders and files in * @param parents The parent folders to list folders and files in
* @param fileTypes - indicates whether to query files, folders, both or some other type * @param fileTypes - indicates whether to query files, folders, both or
* some other type
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] listMultiple(IRemoteFile[] parents, int[] fileTypes, IProgressMonitor monitor) throws SystemMessageException public IRemoteFile[] listMultiple(IRemoteFile[] parents, int[] fileTypes, IProgressMonitor monitor) throws SystemMessageException
{ {
@ -899,10 +903,14 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi
} }
/** /**
* Return a list of all remote folders and files in the given folder. The list is not subsetted. * Return a list of all remote folders and files in the given folder. The
* list is not subsetted.
*
* @param parents The parent folders to list folders and files in * @param parents The parent folders to list folders and files in
* @param fileType - indicates whether to query files, folders, both or some other type * @param fileType - indicates whether to query files, folders, both or some
* other type
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] listMultiple(IRemoteFile[] parents, int fileType, IProgressMonitor monitor) throws SystemMessageException public IRemoteFile[] listMultiple(IRemoteFile[] parents, int fileType, IProgressMonitor monitor) throws SystemMessageException
{ {
@ -916,9 +924,12 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi
} }
/** /**
* Return a list of all remote folders and files in the given folder. The list is not subsetted. * Return a list of all remote folders and files in the given folder. The
* list is not subsetted.
*
* @param parent The parent folder to list folders and files in * @param parent The parent folder to list folders and files in
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0 renamed from listFoldersAndFiles()
*/ */
public IRemoteFile[] list(IRemoteFile parent, IProgressMonitor monitor) throws SystemMessageException public IRemoteFile[] list(IRemoteFile parent, IProgressMonitor monitor) throws SystemMessageException
{ {
@ -926,10 +937,13 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi
} }
/** /**
* Return a list of all remote folders and files in the given folder. The list is not subsetted. * Return a list of all remote folders and files in the given folder. The
* list is not subsetted.
*
* @param parent The parent folder to list folders and files in * @param parent The parent folder to list folders and files in
* @param fileType the type of file * @param fileType the type of file
* @param monitor the monitor * @param monitor the monitor
* @since 3.0 using int fileType parameter
*/ */
public IRemoteFile[] list(IRemoteFile parent, int fileType, IProgressMonitor monitor) throws SystemMessageException public IRemoteFile[] list(IRemoteFile parent, int fileType, IProgressMonitor monitor) throws SystemMessageException
{ {
@ -939,12 +953,15 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi
/** /**
* Return a list of remote folders and files in the given folder. * Return a list of remote folders and files in the given folder.
* <p> * <p>
* The files part of the list is subsetted by the given file name filter. It can be null for no subsetting. * The files part of the list is subsetted by the given file name filter. It
* can be null for no subsetting.
* *
* @param parent The parent folder to list folders and files in * @param parent The parent folder to list folders and files in
* @param fileNameFilter The name pattern to subset the file list by, or null to return all files. * @param fileNameFilter The name pattern to subset the file list by, or
* null to return all files.
* @param fileType the type of file * @param fileType the type of file
* @param monitor the monitor * @param monitor the monitor
* @since 3.0 using int fileType parameter
*/ */
public IRemoteFile[] list(IRemoteFile parent, String fileNameFilter, int fileType, IProgressMonitor monitor) throws SystemMessageException public IRemoteFile[] list(IRemoteFile parent, String fileNameFilter, int fileType, IProgressMonitor monitor) throws SystemMessageException
{ {
@ -1018,9 +1035,12 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi
} }
/** /**
* <b>Overrideable</b> Override this method to provide optimized implementation * Given a set of fully qualified file or folder names, return an
* Given a set of fully qualified file or folder names, return an ISystemResourceSet object for it. * ISystemResourceSet object for it. <b>Overrideable</b> Override this
* method to provide optimized implementation
*
* @param folderOrFileNames Fully qualified folder or file names * @param folderOrFileNames Fully qualified folder or file names
* @since 3.0
*/ */
public IRemoteFile[] getRemoteFileObjects(String[] folderOrFileNames, IProgressMonitor monitor) throws SystemMessageException public IRemoteFile[] getRemoteFileObjects(String[] folderOrFileNames, IProgressMonitor monitor) throws SystemMessageException
{ {