From 96a5cfd3e636e5af61ee891721d2d99ee595302a Mon Sep 17 00:00:00 2001 From: David Dykstal Date: Wed, 20 Sep 2006 14:53:32 +0000 Subject: [PATCH] [cleanup] format and javadoc --- .../rse/core/model/ISystemProfileManager.java | 96 +++++++++++-------- 1 file changed, 57 insertions(+), 39 deletions(-) diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java index ba0031e688e..a51e42817fc 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java @@ -15,11 +15,9 @@ ********************************************************************************/ package org.eclipse.rse.core.model; + import java.util.Vector; - - - /** * A class that manages a list of SystemProfile objects. */ @@ -29,7 +27,6 @@ import java.util.Vector; public interface ISystemProfileManager { - /** * Create a new profile with the given name, and add to the list. * The name must be unique within the existing list. @@ -41,67 +38,93 @@ public interface ISystemProfileManager { * @return new profile, or null if name not unique. */ public ISystemProfile createSystemProfile(String name, boolean makeActive); + /** * Toggle an existing profile's state between active and inactive + * @param profile the profile to (in)activate + * @param makeActive the state to make this profile */ public void makeSystemProfileActive(ISystemProfile profile, boolean makeActive); + /** - * Get an array of all existing profiles. + * @return an array of all existing profiles. */ public ISystemProfile[] getSystemProfiles(); + /** - * Get an array of all existing profile names. + * @return an array of all existing profile names. */ - public String[] getSystemProfileNames(); + public String[] getSystemProfileNames(); + /** - * Get a vector of all existing profile names. + * @return a vector of all existing profile names. */ - public Vector getSystemProfileNamesVector(); + public Vector getSystemProfileNamesVector(); + /** * Get a profile given its name. + * @param name the name of the profile + * @return the profile */ public ISystemProfile getSystemProfile(String name); + /** - * Return the profiles identified via preferences as the active profiles... + * @return the profiles identified via preferences as the active profiles... */ public ISystemProfile[] getActiveSystemProfiles(); + /** - * Return the profile names currently selected by the user as his "active" profiles + * @return the profile names currently selected by the user as his "active" profiles */ public String[] getActiveSystemProfileNames(); + /** - * Return 0-based position of the given active profile within the list of active profiles. + * Get the index of a profile given its name. + * @param profileName the name of the profile to look for. + * @return 0-based position of the given active profile within the list of active profiles. */ public int getActiveSystemProfilePosition(String profileName); + /** - * Return the default private profile created at first touch. - * Will return null if it has been renamed! + * @return the default private profile created at first touch. + * Will return null if it has been renamed. */ public ISystemProfile getDefaultPrivateSystemProfile(); + /** - * Return the default team profile created at first touch. - * Will return null if it has been renamed! + * @return the default team profile created at first touch. + * Will return null if it has been renamed. */ public ISystemProfile getDefaultTeamSystemProfile(); + /** * Rename the given profile. + * @param profile the profile to rename + * @param newName the new profile name */ public void renameSystemProfile(ISystemProfile profile, String newName); + /** * Delete the given profile + * @param profile the name of the profile to delete. */ public void deleteSystemProfile(ISystemProfile profile); + /** * Clone the given profile + * @param profile the profile to clone + * @param newName the name of the new profile + * @return the new profile */ public ISystemProfile cloneSystemProfile(ISystemProfile profile, String newName); - /** - * Return true if the given profile is active - * @see ISystemProfile#isActive() - */ - public boolean isSystemProfileActive(String profileName); - + /** + * Get an indication of whether a profile is active or not. + * @param profileName the name of the profile to test + * @return true if the given profile is active + * @see ISystemProfile#isActive() + */ + public boolean isSystemProfileActive(String profileName); /** * @generated This field/method will be replaced during code generation @@ -109,22 +132,17 @@ public interface ISystemProfileManager { */ java.util.List getProfiles(); - - - -// /** -// * Reusable method to return a name validator for renaming a profile. -// * @param the current profile name on updates. Can be null for new profiles. Used -// * to remove from the existing name list the current connection. -// */ -// public ISystemValidator getProfileNameValidator(String profileName); -// /** -// * Reusable method to return a name validator for renaming a profile. -// * @param the current profile object on updates. Can be null for new profiles. Used -// * to remove from the existing name list the current connection. -// */ -// public ISystemValidator getProfileNameValidator(ISystemProfile profile); + // /** + // * Reusable method to return a name validator for renaming a profile. + // * @param the current profile name on updates. Can be null for new profiles. Used + // * to remove from the existing name list the current connection. + // */ + // public ISystemValidator getProfileNameValidator(String profileName); + // /** + // * Reusable method to return a name validator for renaming a profile. + // * @param the current profile object on updates. Can be null for new profiles. Used + // * to remove from the existing name list the current connection. + // */ + // public ISystemValidator getProfileNameValidator(ISystemProfile profile); - - } \ No newline at end of file