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

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

Browse source
This commit is contained in:
Martin Oberhuber 2008-06-04 08:48:58 +00:00
parent e13dc52133
commit 8c6050dbe2
7 changed files with 200 additions and 183 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/SystemEncodingUtil.java
View file

@ -76,12 +76,12 @@ public class SystemEncodingUtil {
/**
* Change the default encoding provider.
*
* This is a system-wide change, and clients will not be notified
* of changed default encodings due to changing the provider. Therefore,
* changing the provider should be done only once during early system
* startup.
* This is a system-wide change, and clients will not be notified of changed
* default encodings due to changing the provider. Therefore, changing the
* provider should be done only once during early system startup.
*
* @param p the new encoding provider.
* @since 3.0
*/
public void setDefaultEncodingProvider(DefaultEncodingProvider p) {
_defaultEncodingProvider = p;
@ -89,10 +89,11 @@ public class SystemEncodingUtil {
/**
* Returns the local default encoding as provided by the default encoding
* provider. This method should be called after RSE startup is complete
* in order to get the proper default workspace encoding.
* provider. This method should be called after RSE startup is complete in
* order to get the proper default workspace encoding.
*
* @return the local default encoding
* @since 3.0
*/
public String getLocalDefaultEncoding() {
return _defaultEncodingProvider.getLocalDefaultEncoding();

6
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/SystemOperationMonitor.java
View file

@ -13,6 +13,12 @@
package org.eclipse.rse.services.clientserver;
/**
* A monitor to support cancellation of operations in an environment
* where Eclipse IProgressMonitor is not available.
*
* @since 3.0
*/
public class SystemOperationMonitor implements ISystemOperationMonitor
{
private boolean cancelled = false;

28
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/SystemReentrantMutex.java
View file

@ -18,27 +18,26 @@ import java.util.LinkedList;
import java.util.List;
/**
* A SystemMutex Exclusion Lock for Threads that need to access a resource
* in a serialized manner.
* If the request for the lock is running on the same thread who is currently holding the lock,
* it will "borrow" the lock, and the call to waitForLock() will go through.
* An SystemOperationMonitor is accepted
* in order to support cancellation when waiting for the SystemMutex.
* This is a clone for org.eclipse.rse.services.Mutex with some modification to make sure the
* sequential calls to waitForLock() method in the same thread will not be blocked.
* A reentrant Exclusion Lock for Threads that need to access a resource in a
* serialized manner. If the request for the lock is running on the same thread
* who is currently holding the lock, it will "borrow" the lock, and the call to
* waitForLock() will go through. A SystemOperationMonitor is accepted in order
* to support cancellation when waiting for the Mutex. This is a clone of
* {@link org.eclipse.rse.services.Mutex} with some modification to make sure the
* sequential calls to waitForLock() method in the same thread will not be
* blocked.
*
* Usage Example:
* <code>
* private SystemMutex fooMutex = new SystemMutex();
* Usage Example: <code>
* private SystemReentrantMutex fooMutex = new SystemReentrantMutex();
* boolean doFooSerialized()(ISystemOperationMonitor monitor) {
* int mutexLockStatus = SystemMutex.LOCK_STATUS_NOLOCK;
* int mutexLockStatus = SystemReentrantMutex.LOCK_STATUS_NOLOCK;
* mutexLockStatus = fooMutex.waitForLock(monitor, 1000);
* if (SystemMutex.LOCK_STATUS_NOLOCK != mutexLockStatus) {
* if (mutexLockStatus != SystemReentrantMutex.LOCK_STATUS_NOLOCK) {
* try {
* return doFoo();
* } finally {
* //We only release the mutex if we acquire it, not borrowed it.
* if (SystemMutex.LOCK_STATUS_AQUIRED == mutexLockStatus)
* if (mutexLockStatus == SystemReentrantMutex.LOCK_STATUS_AQUIRED)
* {
* fooMutex.release();
* }
@ -48,6 +47,7 @@ import java.util.List;
* }
* </code>
*
* @since 3.0
*/
public class SystemReentrantMutex {

4
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/archiveutils/SystemTgzHandler.java
View file

@ -19,7 +19,9 @@ import java.util.zip.GZIPOutputStream;
import org.eclipse.rse.internal.services.clientserver.archiveutils.TgzFile;
/**
* handler class for .tar.gz and .tgz files
* Handler class for .tar.gz and .tgz files.
*
* @since 3.0
*/
public class SystemTgzHandler extends SystemTarHandler {

5
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/CommonMessages.java
View file

@ -17,7 +17,10 @@ package org.eclipse.rse.services.clientserver.messages;
import org.eclipse.osgi.util.NLS;
/**
* Externalized Strings for common messages that all clients can use.
* @since 3.0
*/
public class CommonMessages extends NLS {
private static String BUNDLE_NAME = "org.eclipse.rse.services.clientserver.messages.CommonMessages";//$NON-NLS-1$

6
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SimpleSystemMessage.java
View file

@ -21,7 +21,11 @@ import java.io.StringWriter;
import org.eclipse.core.runtime.IStatus;
/**
* An RSE SystemMessage that can be created from Strings (without XML parsing).
*
* @since 3.0
*/
public class SimpleSystemMessage extends SystemMessage {
private String _pluginId;

1
rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/shells/AbstractHostShellOutputReader.java
View file

@ -104,6 +104,7 @@ public abstract class AbstractHostShellOutputReader extends Thread implements I
}
}
/** @since 3.0 */
protected final synchronized void startIfNotAlive() {
if (!isAlive()) {
start();