mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-03 07:05:24 +02:00
Code Issues Wiki Activity

Update Javadoc

Browse source
This commit is contained in:
Martin Oberhuber 2007-05-25 13:23:40 +00:00
parent c07f6306ff
commit 0b712e48d1
2 changed files with 33 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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) {

37
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IHost.java
View file

@ -189,21 +189,38 @@ public interface IHost extends IAdaptable, IRSEModelObject {
boolean isPromptable();
/**
* 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.
* <p>
* If fromRemote is <code>false</code>, returns an encoding preference
* specified locally without querying the remote system (for example,
* an encoding set by a user).
* If fromRemote is <code>true</code>, 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.
* </p>
* @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 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 <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.
* Set the default encoding of the host.
* <p>
* 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).
* </p>
* @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 (e.g. setting a local user preference).
* @see #getDefaultEncoding(boolean)
*/
public void setDefaultEncoding(String encoding, boolean fromRemote);