From a2d40ccafa45992d51ad70fe5b3e651771f6275a Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Fri, 18 Apr 2008 09:19:53 +0000
Subject: [PATCH] [226969][cleanup] Use {@inheritDoc} rather than duplicating
comment
---
.../rse/core/AbstractRSESystemType.java | 3 +-
.../subsystems/AbstractConnectorService.java | 9 +---
.../AbstractDelegatingConnectorService.java | 11 +---
.../core/subsystems/IConnectorService.java | 50 +++++++++++--------
4 files changed, 33 insertions(+), 40 deletions(-)
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/AbstractRSESystemType.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/AbstractRSESystemType.java
index 07cdbde5a8b..c58d41fd9eb 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/AbstractRSESystemType.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/AbstractRSESystemType.java
@@ -158,8 +158,7 @@ public abstract class AbstractRSESystemType extends PlatformObject implements IR
}
/**
- * Tests whether the system type is currently enabled.
- *
+ * {@inheritDoc}
* @see IRSESystemType#isEnabled()
* @since org.eclipse.rse.core 3.0
*/
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractConnectorService.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractConnectorService.java
index 0c2df56e8c3..dc33b5a2006 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractConnectorService.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractConnectorService.java
@@ -478,9 +478,7 @@ public abstract class AbstractConnectorService extends RSEModelObject implements
}
/**
- * Sets the attribute for this connector service instance that denies a
- * password to be saved.
- *
+ * {@inheritDoc}
* @see IConnectorService#setDenyPasswordSave(boolean)
* @since org.eclipse.rse.core 3.0
*/
@@ -493,10 +491,7 @@ public abstract class AbstractConnectorService extends RSEModelObject implements
}
/**
- * Retrieves the value of the "DENY_PASSWORD_SAVE" property of this
- * connector service.
- *
- * @return true
if password saving is denied.
+ * {@inheritDoc}
* @see IConnectorService#getDenyPasswordSave()
* @since org.eclipse.rse.core 3.0
*/
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractDelegatingConnectorService.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractDelegatingConnectorService.java
index 902ed26de99..576b824cd2d 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractDelegatingConnectorService.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractDelegatingConnectorService.java
@@ -786,10 +786,7 @@ public abstract class AbstractDelegatingConnectorService implements IDelegatingC
}
/**
- * Sets the attribute for this connector service instance that denies a
- * password to be saved.
- *
- * @see IConnectorService#setDenyPasswordSave(boolean)
+ * {@inheritDoc}
* @since org.eclipse.rse.core 3.0
*/
public int setDenyPasswordSave(boolean deny) {
@@ -802,11 +799,7 @@ public abstract class AbstractDelegatingConnectorService implements IDelegatingC
}
/**
- * Retrieves the value of the "DENY_PASSWORD_SAVE" property of this
- * connector service. If the value has never been set, this will return
- * false.
- *
- * @return true if password saving is denied.
+ * {@inheritDoc}
* @since org.eclipse.rse.core 3.0
*/
public boolean getDenyPasswordSave() {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IConnectorService.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IConnectorService.java
index b4364da08f0..7d8eda577d2 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IConnectorService.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IConnectorService.java
@@ -85,21 +85,26 @@ public interface IConnectorService extends IRSEModelObject {
public boolean isConnected();
/**
- * Connects to the remote system.
- * @param monitor a monitor for tracking the progress and canceling a connect
- * operation.
- * @throws Exception an exception of there is a failure to connect.
- * Typically, this will be a {@link SystemMessageException}.
- * @since 3.0 throws an {@link OperationCanceledException} if the connect was cancelled by the user
+ * Connect to the remote system.
+ *
+ * @param monitor a monitor for tracking the progress and canceling a
+ * connect operation.
+ * @throws OperationCanceledException if the connect was cancelled by the
+ * user
+ * @throws Exception if there is a failure connecting. Typically, this will
+ * be a {@link SystemMessageException}.
+ * @since org.eclipse.rse.core 3.0 throws OperationCanceledException instead
+ * of InterruptedException
*/
public void connect(IProgressMonitor monitor) throws Exception;
/**
- * Disconnects from the remote system.
- * @param monitor a monitor for tracking the progress and canceling a disconnect
- * operation.
- * @throws Exception an exception of the disconnect fails.
- * Typically, this will be a {@link SystemMessageException}.
+ * Disconnect from the remote system.
+ *
+ * @param monitor a monitor for tracking the progress and canceling a
+ * disconnect operation.
+ * @throws Exception an exception of the disconnect fails. Typically, this
+ * will be a {@link SystemMessageException}.
*/
public void disconnect(IProgressMonitor monitor) throws Exception;
@@ -270,18 +275,19 @@ public interface IConnectorService extends IRSEModelObject {
public void clearCredentials();
/**
- * Acquire the credentials for this connector service.
- * Acquisition may be temporarily suppressed
- * by using the {@link #setSuppressed(boolean)}.
+ * Acquire the credentials for this connector service. Acquisition may be
+ * temporarily suppressed by using the {@link #setSuppressed(boolean)}.
*
- * Implementations may retain a remembered credentials or - * use this to acquire the credentials using some implementation defined means. + * Implementations may retain a remembered credentials or use this to + * acquire the credentials using some implementation defined means. *
- * Throws {@link OperationCanceledException} if acquisition of the - * credentials is cancelled or is being suppressed. - * @param refresh if true will force the connector service to discard - * any remembered value and reacquire the credentials. - * @since 3.0 throws OperationCanceledException instead of InterruptedException + * + * @param refresh if true will force the connector service to discard any + * remembered value and reacquire the credentials. + * @throws OperationCanceledException if acquisition of the credentials is + * cancelled or is being suppressed. + * @since org.eclipse.rse.core 3.0 throws OperationCanceledException instead + * of InterruptedException */ public void acquireCredentials(boolean refresh) throws OperationCanceledException; @@ -395,7 +401,7 @@ public interface IConnectorService extends IRSEModelObject { * false. If set to true, it will clear any saved passwords for this system * and not allow any further passwords to be stored. This property of a * system is persistent from session to session, but is not sharable. - * + * * @param deny If true, forget any saved passwords and do not allow any * others to be saved. If false, allow passwords to be saved in * the keyring.