From 09ae80cac7f3a92f57eafe6e16e582c7a219495d Mon Sep 17 00:00:00 2001
From: Kushal Munir < kmunir@ca.ibm.com>
Date: Fri, 25 May 2007 13:03:04 +0000
Subject: [PATCH] [179937] Update API documentation in Host.
---
.../src/org/eclipse/rse/core/model/Host.java | 18 ++++++------------
1 file changed, 6 insertions(+), 12 deletions(-)
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/Host.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/Host.java
index e8e88ec13ac..f91f09539f8 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/Host.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/Host.java
@@ -521,15 +521,11 @@ public class Host extends RSEModelObject implements IHost {
}
/**
- * The default encoding of the host. If fromRemote is false
, returns the encoding that was not set by the client by querying a remote system
- * (for example, an encoding set by a user). If fromRemote is true
, it first checks to see if there is an encoding that was set by the client
- * without querying a remote system, and if an encoding does not exist, then it returns the encoding that was set by the client by querying a remote system.
- * @param fromRemote false
to get the encoding that was obtained by the client by not querying the remote system, true
to also check
- * the encoding, if needed, that was set by the client after querying a remote system.
- * @return the default encoding of the host, or null
if no encoding was set.
+ * Returns the default encoding of the host.
+ * @see IHost#getDefaultEncoding(boolean)
* @see #setDefaultEncoding(String, boolean)
*/
- public String getDefaultEncoding(boolean checkRemote) {
+ public String getDefaultEncoding(boolean fromRemote) {
IPropertySet encPropertySet = getPropertySet(ENCODING_PROPERTY_SET);
@@ -544,7 +540,7 @@ public class Host extends RSEModelObject implements IHost {
}
else {
- if (!checkRemote) {
+ if (!fromRemote) {
return null;
}
else {
@@ -556,10 +552,8 @@ public class Host extends RSEModelObject implements IHost {
}
/**
- * Sets the default encoding of the host. It should only be called when no subsystem is connected.
- * The client has to obtain the encoding, either by querying the remote system or by some other means (for example, set by a user).
- * @param encoding the encoding of the host, or null
to erase the current encoding.
- * @param fromRemote true
if the encoding is set by the client after querying the remote system, or false
otherwise.
+ * Sets the default encoding of the host.
+ * @see IHost#setDefaultEncoding(String, boolean)
* @see #getDefaultEncoding(boolean)
*/
public void setDefaultEncoding(String encoding, boolean fromRemote) {