mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-09 18:56:02 +02:00
Code Issues Wiki Activity

[179937] Update API documentation in Host.

Browse source
This commit is contained in:
Kushal Munir 2007-05-25 13:03:04 +00:00
parent 934bcf1e0f
commit 09ae80cac7
1 changed files with 6 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/Host.java
View file

@ -521,15 +521,11 @@ public class Host extends RSEModelObject implements IHost {
}
/**
* The default encoding of the host. If fromRemote is <code>false</code>, 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 <code>true</code>, 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 <code>false</code> to get the encoding that was obtained by the client by not querying the remote system, <code>true</code> 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 <code>null</code> 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 <code>null</code> to erase the current encoding.
* @param fromRemote <code>true</code> if the encoding is set by the client after querying the remote system, or <code>false</code> otherwise.
* Sets the default encoding of the host.
* @see IHost#setDefaultEncoding(String, boolean)
* @see #getDefaultEncoding(boolean)
*/
public void setDefaultEncoding(String encoding, boolean fromRemote) {