1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-04 15:45:25 +02:00

[cleanup] format and javadoc

This commit is contained in:
David Dykstal 2006-09-20 14:53:32 +00:00
parent e8c6ee58df
commit 96a5cfd3e6

View file

@ -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);
}