mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-03 15:15:25 +02:00
[179937] Update documentation for methods to get and set encoding.
This commit is contained in:
parent
62ec8d72f9
commit
edd9347052
2 changed files with 17 additions and 15 deletions
|
@ -521,11 +521,11 @@ public class Host extends RSEModelObject implements IHost {
|
|||
}
|
||||
|
||||
/**
|
||||
* The default encoding of the host. If checkRemote is <code>false</code>, returns the encoding that was not set by querying a remote system
|
||||
* (for example, an encoding set by a user). If checkRemote is <code>true</code>, 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 <code>false</code> to get the encoding that was obtained by not querying the remote system, <code>true</code> to also check
|
||||
* the encoding, if needed, that was set by querying a remote system.
|
||||
* 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.
|
||||
* @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 <code>null</code> to erase the current encoding.
|
||||
* @param fromRemote <code>true</code> if the encoding is set by querying the remote system, or <code>false</code> otherwise.
|
||||
* @param fromRemote <code>true</code> if the encoding is set by the client after querying the remote system, or <code>false</code> otherwise.
|
||||
* @see #getDefaultEncoding(boolean)
|
||||
*/
|
||||
public void setDefaultEncoding(String encoding, boolean fromRemote) {
|
||||
|
|
|
@ -189,20 +189,21 @@ public interface IHost extends IAdaptable, IRSEModelObject {
|
|||
boolean isPromptable();
|
||||
|
||||
/**
|
||||
* The default encoding of the host. If checkRemote is <code>false</code>, returns the encoding that was not set by querying a remote system
|
||||
* (for example, an encoding set by a user). If checkRemote is <code>true</code>, 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 <code>false</code> to get the encoding that was obtained by not querying the remote system, <code>true</code> to also check
|
||||
* the encoding, if needed, that was set by querying a remote system.
|
||||
* 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.
|
||||
* @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 <code>null</code> to erase the current encoding.
|
||||
* @param fromRemote <code>true</code> if the encoding is set by querying the remote system, or <code>false</code> otherwise.
|
||||
* @param fromRemote <code>true</code> if the encoding is set by the client after querying the remote system, or <code>false</code> otherwise.
|
||||
* @see #getDefaultEncoding(boolean)
|
||||
*/
|
||||
public void setDefaultEncoding(String encoding, boolean fromRemote);
|
||||
|
|
Loading…
Add table
Reference in a new issue