mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

Comment adjustment.

Browse source
This commit is contained in:
Sergey Prigogin 2011-03-07 02:01:25 +00:00
parent 3802443e35
commit d56a58314c
1 changed files with 120 additions and 111 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

113
core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java
View file

@ -21,27 +21,27 @@ import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.QualifiedName; import org.eclipse.core.runtime.QualifiedName;
/** /**
* this is the element representing configuration and thus this is the root element * This is the element representing configuration and thus this is the root element
* for configuration-specific settings * for configuration-specific settings
*
*/ */
public interface ICConfigurationDescription extends ICSettingContainer, ICSettingObject, ICSettingsStorage { public interface ICConfigurationDescription extends ICSettingContainer, ICSettingObject, ICSettingsStorage {
/** /**
* Returns whether or not this is an active configuration. * Returns whether or not this is an active configuration.
* Active configuratiuon is the one that is built by default. * Active configuration is the one that is built by default.
* This configuration is returned by the {@link ICProjectDescription#getActiveConfiguration()} call * This configuration is returned by the {@link ICProjectDescription#getActiveConfiguration()}
* call
* *
* @return boolean * @return boolean
*/ */
boolean isActive(); boolean isActive();
/** /**
* returns the human-readable configuration description * Returns the human-readable configuration description.
*/ */
String getDescription(); String getDescription();
/** /**
* sets the configuration description * Sets the configuration description
* *
* @param des * @param des
* @throws WriteAccessException when the configuration description is read-only * @throws WriteAccessException when the configuration description is read-only
@ -50,33 +50,34 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
void setDescription(String des) throws WriteAccessException; void setDescription(String des) throws WriteAccessException;
/** /**
* returns the project description this configuration belongs to * Returns the project description this configuration belongs to
*/ */
ICProjectDescription getProjectDescription(); ICProjectDescription getProjectDescription();
/** /**
* returns the "root" folder description * Returns the "root" folder description
* The root folder description is the default one used for the project root folder * The root folder description is the default one used for the project root folder
* The root folder description can not be null * The root folder description can not be null
*/ */
ICFolderDescription getRootFolderDescription(); ICFolderDescription getRootFolderDescription();
/** /**
* returns the complete set of folder descriptions defined for this configuration * Returns the complete set of folder descriptions defined for this configuration
* The folder description is the settings holder for the specified folder * The folder description is the settings holder for the specified folder
* @see ICFolderDescription * @see ICFolderDescription
*/ */
ICFolderDescription[] getFolderDescriptions(); ICFolderDescription[] getFolderDescriptions();
/** /**
* returns the complete set of file descriptions defined for this configuration * Returns the complete set of file descriptions defined for this configuration
* The file description is the settings holder for the specified file * The file description is the settings holder for the specified file
* @see ICFileDescription * @see ICFileDescription
*/ */
ICFileDescription[] getFileDescriptions(); ICFileDescription[] getFileDescriptions();
/** /**
* returns the complete set of file and folder descriptions (resource descriptions) defined for this configuration * Returns the complete set of file and folder descriptions (resource descriptions) defined
* for this configuration
* The resource description is the settings holder for the specified resource * The resource description is the settings holder for the specified resource
* @see ICResourceDescription * @see ICResourceDescription
* @see ICFileDescription * @see ICFileDescription
@ -88,17 +89,19 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
* Returns the resource description for the given path * Returns the resource description for the given path
* *
* @param path - project-relative workspace resource path * @param path - project-relative workspace resource path
* @param exactPath - when true the resource description of the given path is searched and if not found null is returned, * @param exactPath - when true the resource description of the given path is searched and if
* not found null is returned,
* if false, the resource description applicable for the given path is returned, * if false, the resource description applicable for the given path is returned,
* i.e. if the configuration contains resource descriptions of the following paths "" and "a/" * i.e. if the configuration contains resource descriptions of the following paths "" and "a/"
* getResourceDescription(new Path("a/b"), true) returns null * getResourceDescription(new Path("a/b"), true) returns null
* getResourceDescription(new Path("a/b"), false) returns the "a" folder description * getResourceDescription(new Path("a/b"), false) returns the "a" folder description
* @return {@link ICResourceDescription} that is either a {@link ICFolderDescription} or an {@link ICFileDescription} * @return {@link ICResourceDescription} that is either a {@link ICFolderDescription} or
* an {@link ICFileDescription}
*/ */
ICResourceDescription getResourceDescription(IPath path, boolean exactPath); ICResourceDescription getResourceDescription(IPath path, boolean exactPath);
/** /**
* removes the given resource description from the configuration * Removes the given resource description from the configuration
* *
* @param des * @param des
* @throws CoreException * @throws CoreException
@ -108,7 +111,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
void removeResourceDescription(ICResourceDescription des) throws CoreException, WriteAccessException; void removeResourceDescription(ICResourceDescription des) throws CoreException, WriteAccessException;
/** /**
* creates a new file description for the specified path * Creates a new file description for the specified path
* @param path project-relative file workspace path * @param path project-relative file workspace path
* @param base resource description from which settings will be coppied/inheritted * @param base resource description from which settings will be coppied/inheritted
* @throws CoreException * @throws CoreException
@ -118,7 +121,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICFileDescription createFileDescription(IPath path, ICResourceDescription base) throws CoreException, WriteAccessException; ICFileDescription createFileDescription(IPath path, ICResourceDescription base) throws CoreException, WriteAccessException;
/** /**
* creates a new folder description for the specified path * Creates a new folder description for the specified path
* @param path project-relative folder workspace path * @param path project-relative folder workspace path
* @param base resource description from which settings will be coppied/inheritted * @param base resource description from which settings will be coppied/inheritted
* @throws CoreException * @throws CoreException
@ -128,26 +131,29 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICFolderDescription createFolderDescription(IPath path, ICFolderDescription base) throws CoreException, WriteAccessException; ICFolderDescription createFolderDescription(IPath path, ICFolderDescription base) throws CoreException, WriteAccessException;
/** /**
* returns the ID of the build system used with this configuration * Returns the ID of the build system used with this configuration
* i.e. the id of extension contributing to the org.eclipse.cdt.core.CConfigurationDataProvider extension point * i.e. the id of extension contributing to the org.eclipse.cdt.core.CConfigurationDataProvider
* used with this configuration * extension point used with this configuration
* *
* @return String * @return String
*/ */
String getBuildSystemId(); String getBuildSystemId();
/** /**
* This method should be used by the build system only for gettings * This method should be used by the build system only for getting
* the build-system contributed CConfigurationData * the build-system contributed CConfigurationData
* @see CConfigurationDataProvider and the org.eclipse.cdt.core.CConfigurationDataProvider extension point * @see CConfigurationDataProvider and the org.eclipse.cdt.core.CConfigurationDataProvider
* extension point
*/ */
CConfigurationData getConfigurationData(); CConfigurationData getConfigurationData();
/** /**
* sets this cinfiguration as active * Sets this configuration as active
* this call is equivalent to {@link ICProjectDescription#setActiveConfiguration(ICConfigurationDescription)} * this call is equivalent to
* Active configuratiuon is the one that is built by default. * {@link ICProjectDescription#setActiveConfiguration(ICConfigurationDescription)}
* This configuration is returned by the {@link ICProjectDescription#getActiveConfiguration()} call * Active configuration is the one that is built by default.
* This configuration is returned by the {@link ICProjectDescription#getActiveConfiguration()}
* call
* *
* @throws WriteAccessException when the configuration description is read-only, * @throws WriteAccessException when the configuration description is read-only,
* see {@link CoreModel#getProjectDescription(org.eclipse.core.resources.IProject, boolean)} * see {@link CoreModel#getProjectDescription(org.eclipse.core.resources.IProject, boolean)}
@ -161,23 +167,24 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
* @throws WriteAccessException when the configuration description is read-only, * @throws WriteAccessException when the configuration description is read-only,
* see {@link CoreModel#getProjectDescription(org.eclipse.core.resources.IProject, boolean)} * see {@link CoreModel#getProjectDescription(org.eclipse.core.resources.IProject, boolean)}
* *
* @see CConfigurationDataProvider and the extension point org.eclipse.cdt.core.CConfigurationDataProvider * @see CConfigurationDataProvider and the extension point
* org.eclipse.cdt.core.CConfigurationDataProvider
*/ */
void setConfigurationData(String buildSystemId, CConfigurationData data) throws WriteAccessException; void setConfigurationData(String buildSystemId, CConfigurationData data) throws WriteAccessException;
/** /**
* returns whether or not the configuration description was modified * Returns whether or not the configuration description was modified
*/ */
boolean isModified(); boolean isModified();
/** /**
* returns the target platform settings for this configuration * Returns the target platform settings for this configuration
* @see ICTargetPlatformSetting * @see ICTargetPlatformSetting
*/ */
ICTargetPlatformSetting getTargetPlatformSetting(); ICTargetPlatformSetting getTargetPlatformSetting();
/** /**
* returns the source entries for this configuration * Returns the source entries for this configuration
* @see ICSourceEntry * @see ICSourceEntry
*/ */
ICSourceEntry[] getSourceEntries(); ICSourceEntry[] getSourceEntries();
@ -185,7 +192,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICSourceEntry[] getResolvedSourceEntries(); ICSourceEntry[] getResolvedSourceEntries();
/** /**
* sets the source entries for this configuration * Sets the source entries for this configuration
* *
* @param entries * @param entries
* *
@ -198,9 +205,9 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
* Returns a Map of configurations referenced by this configuration. Settings exported * Returns a Map of configurations referenced by this configuration. Settings exported
* by a project configuration are automatically picked up by any referencing configurations. * by a project configuration are automatically picked up by any referencing configurations.
* <p> * <p>
* This Map is keyed by project name with value equal to the referenced configuration's ID, or the * This Map is keyed by project name with value equal to the referenced configuration's ID, or
* empty string. The empty string is a special configuration value which indicates the reference * the empty string. The empty string is a special configuration value which indicates
* tracks the Active configuration in the referenced Project. * the reference tracks the Active configuration in the referenced Project.
* <p> * <p>
* If the current configuration does not reference any other configurations, * If the current configuration does not reference any other configurations,
* an empty map is returned. * an empty map is returned.
@ -231,7 +238,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
void setReferenceInfo(Map<String, String> refs) throws WriteAccessException; void setReferenceInfo(Map<String, String> refs) throws WriteAccessException;
/** /**
* returns an array of settings exported by this configuration * Returns an array of settings exported by this configuration
* in case some configurations refer (depend on) this configuration * in case some configurations refer (depend on) this configuration
* exported settings of this configuration get applied to those configurations * exported settings of this configuration get applied to those configurations
* @see ICExternalSetting * @see ICExternalSetting
@ -241,7 +248,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICExternalSetting[] getExternalSettings(); ICExternalSetting[] getExternalSettings();
/** /**
* creates/adds external setting to this configuration * Creates/adds external setting to this configuration
* in case some configurations refer (depend on) this configuration * in case some configurations refer (depend on) this configuration
* exported settings of this configuration get applied to those configurations * exported settings of this configuration get applied to those configurations
* @see ICExternalSetting * @see ICExternalSetting
@ -262,7 +269,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICSettingEntry entries[]) throws WriteAccessException; ICSettingEntry entries[]) throws WriteAccessException;
/** /**
* removes external setting from this configuration * Removes external setting from this configuration
* in case some configurations refer (depend on) this configuration * in case some configurations refer (depend on) this configuration
* exported settings of this configuration get applied to those configurations * exported settings of this configuration get applied to those configurations
* @see ICExternalSetting * @see ICExternalSetting
@ -277,7 +284,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
void removeExternalSetting(ICExternalSetting setting) throws WriteAccessException; void removeExternalSetting(ICExternalSetting setting) throws WriteAccessException;
/** /**
* removes all external settings from this configuration * Removes all external settings from this configuration
* in case some configurations refer (depend on) this configuration * in case some configurations refer (depend on) this configuration
* exported settings of this configuration get applied to those configurations * exported settings of this configuration get applied to those configurations
* @see ICExternalSetting * @see ICExternalSetting
@ -291,13 +298,13 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
void removeExternalSettings() throws WriteAccessException; void removeExternalSettings() throws WriteAccessException;
/** /**
* returns the build setting for this configuration * Returns the build setting for this configuration
* @see ICBuildSetting * @see ICBuildSetting
*/ */
ICBuildSetting getBuildSetting(); ICBuildSetting getBuildSetting();
/** /**
* returns the CDT variable contributor that represent information on the * Returns the CDT variable contributor that represent information on the
* CDT variables (Build Macros) contributed/used with this configuration * CDT variables (Build Macros) contributed/used with this configuration
* *
* @see ICdtVariablesContributor * @see ICdtVariablesContributor
@ -305,18 +312,20 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICdtVariablesContributor getBuildVariablesContributor(); ICdtVariablesContributor getBuildVariablesContributor();
/** /**
* the get/setSettionsProperty methods allow to associate the session properties mechanism on the configuration level * The get/setSettionsProperty methods allow to associate the session properties mechanism on
* session properties are not persisted and are not restored on the next eclipse session * the configuration level session properties are not persisted and are not restored on the next
* the scope of configuration session properties is the current configuration description, * eclipse session the scope of configuration session properties is the current configuration
* i.e. modifications to the properties are not applied until the setProjectDescription call * description, i.e. modifications to the properties are not applied until
* the setProjectDescription call
*/ */
Object getSessionProperty(QualifiedName name); Object getSessionProperty(QualifiedName name);
/** /**
* the get/setSettionsProperty methods allow to associate the session properties mechanism on the configuration level * The get/setSettionsProperty methods allow to associate the session properties mechanism on
* session properties are not persisted and are not restored on the next eclipse session * the configuration level session properties are not persisted and are not restored on the next
* the scope of configuration session properties is the current configuration description, * eclipse session the scope of configuration session properties is the current configuration
* i.e. modifications to the properties are not applied until the setProjectDescription call * description, i.e. modifications to the properties are not applied until
* the setProjectDescription call
* *
* @param name * @param name
* @param value * @param value
@ -324,7 +333,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
void setSessionProperty(QualifiedName name, Object value); void setSessionProperty(QualifiedName name, Object value);
/** /**
* sets the name for this configuration * Sets the name for this configuration
* *
* @param name * @param name
* @throws WriteAccessException when the configuration description is read-only * @throws WriteAccessException when the configuration description is read-only
@ -343,7 +352,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
boolean isPreferenceConfiguration(); boolean isPreferenceConfiguration();
/** /**
* convenience method to return a language setting for the file * Convenience method to return a language setting for the file
* with the specified project-relative path * with the specified project-relative path
* *
* @param path - file project relative path * @param path - file project relative path
@ -352,21 +361,21 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin
ICLanguageSetting getLanguageSettingForFile(IPath path, boolean ignoreExludeStatus); ICLanguageSetting getLanguageSettingForFile(IPath path, boolean ignoreExludeStatus);
/** /**
* sets the external setting providers to be used for the configuration * Sets the external setting providers to be used for the configuration
* *
* @param ids the ids of externalSettinsProvider extensions * @param ids the ids of externalSettinsProvider extensions
*/ */
void setExternalSettingsProviderIds(String ids[]); void setExternalSettingsProviderIds(String ids[]);
/** /**
* returns the ids of external setting providers used for the configuration * Returns the ids of external setting providers used for the configuration
* *
* @return the ids of externalSettinsProvider extensions * @return the ids of externalSettinsProvider extensions
*/ */
String[] getExternalSettingsProviderIds(); String[] getExternalSettingsProviderIds();
/** /**
* tells the configuration to update the given providers * Tells the configuration to update the given providers
* In case the specified ids contain provider ids not associated with the configuration, * In case the specified ids contain provider ids not associated with the configuration,
* those ids will be ignored and will NOT be added to the configuration settings * those ids will be ignored and will NOT be added to the configuration settings
* *