mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-03 23:25:26 +02:00
[cleanup] Fix Javadoc
This commit is contained in:
Martin Oberhuber
parent
70335f5e8d
commit
5b15779ff6
3 changed files with 56 additions and 49 deletions
|
|
@ -39,7 +39,7 @@ import org.eclipse.rse.ui.RSEUIPlugin;
|
|||
*
|
||||
* This class existed in RSE 1.0, was made "internal" for RSE 2.0 and restored
|
||||
* as API for RSE 3.0.
|
||||
*
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
public abstract class SystemAbstractAPIProvider
|
||||
|
|
@ -64,7 +64,9 @@ public abstract class SystemAbstractAPIProvider
|
|||
*/
|
||||
protected SystemMessageObject nullObject = null;
|
||||
/**
|
||||
* @since org.eclipse.rse.ui 3.0 renamed from canceledObject
|
||||
* This field was renamed from canceledObject in RSE 3.0.
|
||||
*
|
||||
* @since org.eclipse.rse.ui 3.0
|
||||
* @deprecated don't use this field
|
||||
*/
|
||||
protected SystemMessageObject cancelledObject = null;
|
||||
|
|
@ -119,21 +121,23 @@ public abstract class SystemAbstractAPIProvider
|
|||
errorObject = new SystemMessageObject(RSEUIPlugin.getPluginMessage(ISystemMessages.MSG_EXPAND_FAILED),ISystemMessageObject.MSGTYPE_ERROR, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* <i>Callable by subclasses. Do not override.</i><br>
|
||||
/**
|
||||
* In getChildren, return <samp>checkForEmptyList(children, parent,
|
||||
* true/false)</samp> versus your array directly. This method checks for a
|
||||
* null array which is not allowed and replaces it with an empty array. If
|
||||
* true is passed then it returns the "Empty list" message object if the
|
||||
* array is null or empty
|
||||
* array is null or empty.
|
||||
* <p>
|
||||
* <i>Callable by subclasses. Do not override.</i> <br>
|
||||
*
|
||||
* @param children The list of children.
|
||||
* @param parent The parent for the children.
|
||||
* @param returnNullMsg <code>true</code> if an "Empty List" message
|
||||
* should be returned.
|
||||
* @param returnNullMsg <code>true</code> if an "Empty List" message should
|
||||
* be returned.
|
||||
* @return The list of children, a list with the "Empty List" message object
|
||||
* or an empty list.
|
||||
* @noextend This method is not intended to be extended by clients.
|
||||
* or an empty list.
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients.
|
||||
*/
|
||||
protected Object[] checkForEmptyList(Object[] children, Object parent, boolean returnNullMsg) {
|
||||
if ((children == null) || (children.length == 0)) {
|
||||
|
|
|
|||
|
|
@ -480,10 +480,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
* Return vendor of this subsystem configuration. This comes from the xml
|
||||
* "vendor" attribute of the extension point.
|
||||
*
|
||||
* @noextend This method is not intended to be extended by clients. It will
|
||||
* likely be declared <tt>final</tt> in the next release in
|
||||
* order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients. It will likely be declared <tt>final</tt> in the next
|
||||
* release in order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*/
|
||||
public String getVendor()
|
||||
{
|
||||
|
|
@ -494,10 +494,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
* Return name of this subsystem configuration. This comes from the xml
|
||||
* "name" attribute of the extension point.
|
||||
*
|
||||
* @noextend This method is not intended to be extended by clients. It will
|
||||
* likely be declared <tt>final</tt> in the next release in
|
||||
* order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients. It will likely be declared <tt>final</tt> in the next
|
||||
* release in order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*/
|
||||
public String getName()
|
||||
{
|
||||
|
|
@ -508,10 +508,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
* Return name of this subsystem configuration. This comes from the xml
|
||||
* "description" attribute of the extension point.
|
||||
*
|
||||
* @noextend This method is not intended to be extended by clients. It will
|
||||
* likely be declared <tt>final</tt> in the next release in
|
||||
* order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients. It will likely be declared <tt>final</tt> in the next
|
||||
* release in order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*/
|
||||
public String getDescription()
|
||||
{
|
||||
|
|
@ -522,10 +522,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
* Return unique id of this subsystem configuration. This comes from the xml
|
||||
* "id" attribute of the extension point.
|
||||
*
|
||||
* @noextend This method is not intended to be extended by clients. It will
|
||||
* likely be declared <tt>final</tt> in the next release in
|
||||
* order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients. It will likely be declared <tt>final</tt> in the next
|
||||
* release in order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*/
|
||||
public String getId()
|
||||
{
|
||||
|
|
@ -538,10 +538,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
*
|
||||
* @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories
|
||||
*
|
||||
* @noextend This method is not intended to be extended by clients. It will
|
||||
* likely be declared <tt>final</tt> in the next release in
|
||||
* order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients. It will likely be declared <tt>final</tt> in the next
|
||||
* release in order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*/
|
||||
public String getCategory()
|
||||
{
|
||||
|
|
@ -553,11 +553,11 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
* from static declaration in the
|
||||
* <tt>org.eclipse.rse.core.subsystemConfigurations</tt> and
|
||||
* <tt>org.eclipse.rse.core.systemTypes</tt> extension points.
|
||||
*
|
||||
* @noextend This method is not intended to be extended by clients. It will
|
||||
* likely be declared <tt>final</tt> in the next release in
|
||||
* order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*
|
||||
* @nooverride This method is not intended to be re-implemented or extended
|
||||
* by clients. It will likely be declared <tt>final</tt> in the next
|
||||
* release in order to ensure consistency with static xml markup in the
|
||||
* extension.
|
||||
*/
|
||||
public IRSESystemType[] getSystemTypes()
|
||||
{
|
||||
|
|
@ -979,7 +979,7 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
* the subsystem.
|
||||
* <li>finally, saves the subsystem to disk.
|
||||
* </ul>
|
||||
*
|
||||
*
|
||||
* @param conn The connection to create a subsystem for
|
||||
* @param creatingConnection true if we are creating a connection, false if
|
||||
* just creating another subsystem for an existing connection.
|
||||
|
|
|
|||
|
|
@ -158,22 +158,25 @@ public class StandardCredentialsProvider extends AbstractCredentialsProvider {
|
|||
}
|
||||
|
||||
/**
|
||||
* @noimplement
|
||||
* Acquires the credentials (userid and password) for this connector service.
|
||||
* The search order for the password is as follows:</p>
|
||||
* Acquires the credentials (userid and password) for this connector
|
||||
* service. The search order for the password is as follows:
|
||||
* </p>
|
||||
* <ol>
|
||||
* <li>First check if the password is already known by this
|
||||
* connector service and that it is still valid.
|
||||
* <li>If password not known then look in the password
|
||||
* store and verify that it is still valid.
|
||||
* <li>If a valid password is not found or is to be reacquired
|
||||
* then prompt the user
|
||||
* <li>First check if the password is already known by this connector
|
||||
* service and that it is still valid.
|
||||
* <li>If password not known then look in the password store and verify that
|
||||
* it is still valid.
|
||||
* <li>If a valid password is not found or is to be re-acquired then prompt
|
||||
* the user
|
||||
* </ol>
|
||||
* @param reacquire if true then present the prompt even
|
||||
* if the password was found and is valid.
|
||||
* @throws OperationCanceledException if user is prompted and user
|
||||
* cancels that prompt or if {@link #isSuppressed()} is true.
|
||||
* @since 3.0 throws {@link OperationCanceledException} rather than {@link InterruptedException}
|
||||
*
|
||||
* @param reacquire if true then present the prompt even if the password was
|
||||
* found and is valid.
|
||||
* @throws OperationCanceledException if user is prompted and user cancels
|
||||
* that prompt or if {@link #isSuppressed()} is true. Before RSE 3.0,
|
||||
* the method would have thrown {@link InterruptedException} in that
|
||||
* case.
|
||||
* @since 3.0
|
||||
*/
|
||||
public final void acquireCredentials(boolean reacquire) throws OperationCanceledException {
|
||||
if (isSuppressed()) {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue