From edd93470527bce2e21fb03cbc888f3714752aeed Mon Sep 17 00:00:00 2001 From: Kushal Munir < kmunir@ca.ibm.com> Date: Fri, 25 May 2007 02:52:53 +0000 Subject: [PATCH] [179937] Update documentation for methods to get and set encoding. --- .../src/org/eclipse/rse/core/model/Host.java | 15 ++++++++------- .../src/org/eclipse/rse/core/model/IHost.java | 17 +++++++++-------- 2 files changed, 17 insertions(+), 15 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 2862e923ce8..e8e88ec13ac 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,11 +521,11 @@ public class Host extends RSEModelObject implements IHost { } /** - * The default encoding of the host. If checkRemote is false, returns the encoding that was not set by querying a remote system - * (for example, an encoding set by a user). If checkRemote is true, it first checks to see if there is an encoding that was set - * without querying a remote system, and if an encoding does not exist, then it returns the encoding that was set by querying a remote system. - * @param checkRemote false to get the encoding that was obtained by not querying the remote system, true to also check - * the encoding, if needed, that was set by querying a remote system. + * 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. * @see #setDefaultEncoding(String, boolean) */ @@ -556,9 +556,10 @@ public class Host extends RSEModelObject implements IHost { } /** - * Sets the default encoding of the host. The encoding can be set by querying the remote system or by some other means (for example, by a user). + * 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 querying the remote system, or false otherwise. + * @param fromRemote true if the encoding is set by the client after querying the remote system, or false otherwise. * @see #getDefaultEncoding(boolean) */ public void setDefaultEncoding(String encoding, boolean fromRemote) { diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IHost.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IHost.java index c67e8171fbe..756ade4c9e0 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IHost.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IHost.java @@ -189,20 +189,21 @@ public interface IHost extends IAdaptable, IRSEModelObject { boolean isPromptable(); /** - * The default encoding of the host. If checkRemote is false, returns the encoding that was not set by querying a remote system - * (for example, an encoding set by a user). If checkRemote is true, it first checks to see if there is an encoding that was set - * without querying a remote system, and if an encoding does not exist, then it returns the encoding that was set by querying a remote system. - * @param checkRemote false to get the encoding that was obtained by not querying the remote system, true to also check - * the encoding, if needed, that was set by querying a remote system. + * 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. * @see #setDefaultEncoding(String, boolean) */ - public String getDefaultEncoding(boolean checkRemote); + public String getDefaultEncoding(boolean fromRemote); /** - * Sets the default encoding of the host. The encoding can be set by querying the remote system or by some other means (for example, by a user). + * 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 querying the remote system, or false otherwise. + * @param fromRemote true if the encoding is set by the client after querying the remote system, or false otherwise. * @see #getDefaultEncoding(boolean) */ public void setDefaultEncoding(String encoding, boolean fromRemote);