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 f91f09539f8..0aca424a3ba 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
@@ -520,10 +520,9 @@ public class Host extends RSEModelObject implements IHost {
return result;
}
- /**
- * Returns the default encoding of the host.
- * @see IHost#getDefaultEncoding(boolean)
- * @see #setDefaultEncoding(String, boolean)
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.rse.core.model.IHost#getDefaultEncoding(boolean)
*/
public String getDefaultEncoding(boolean fromRemote) {
@@ -551,10 +550,9 @@ public class Host extends RSEModelObject implements IHost {
}
}
- /**
- * Sets the default encoding of the host.
- * @see IHost#setDefaultEncoding(String, boolean)
- * @see #getDefaultEncoding(boolean)
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.rse.core.model.IHost#setDefaultEncoding(java.lang.String, 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 756ade4c9e0..37b8b676db8 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,21 +189,38 @@ public interface IHost extends IAdaptable, IRSEModelObject {
boolean isPromptable();
/**
- * 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.
+ *
+ * If fromRemote is false
, returns an encoding preference
+ * specified locally without querying the remote system (for example,
+ * an encoding set by a user).
+ * If fromRemote is true
, it first checks to see if there is
+ * a local "overriding" encoding set by the client without querying the
+ * remote system, and if such a "local" encoding preference does not exist,
+ * returns the encoding that was set by the client by querying a remote system.
+ *
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 fromRemote);
/**
- * 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.
+ * Set the default encoding of the host.
+ * + * This method can 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, ornull
+ * to erase the current encoding.
+ * @param fromRemote true
if the encoding is set by the
+ * client after querying the remote system, or false
+ * otherwise (e.g. setting a local user preference).
* @see #getDefaultEncoding(boolean)
*/
public void setDefaultEncoding(String encoding, boolean fromRemote);