Package org.eclipse.core.resources

Interface IProjectDescription

  • public interface IProjectDescription
    A project description contains the meta-data required to define a project. In effect, a project description is a project's "content".
    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.

    • Field Detail

      • DESCRIPTION_FILE_NAME

        static final String DESCRIPTION_FILE_NAME
        Constant that denotes the name of the project description file (value ".project"). The handle of a project's description file is project.getFile(DESCRIPTION_FILE_NAME). The project description file is located in the root of the project's content area.
        Since:
        2.0
        See Also:
        Constant Field Values

    • Method Detail

      • getBuildConfigReferences

        IBuildConfiguration[] getBuildConfigReferences​(String configName)
        Returns the build configurations referenced by the specified configuration for the described project.

        These references are persisted by the workspace in a private location outside the project description file, and as such will not be shared when a project is exported or persisted in a repository. As such clients are always responsible for setting these references when a project is created or recreated.

        The referenced build configurations need not exist in the workspace. The result will not contain duplicates. The order of the references is preserved from the call to setBuildConfigReferences(String, IBuildConfiguration[]). Returns an empty array if the provided config doesn't dynamically reference any other build configurations, or the given config does not exist in this description.

        Parameters:
        configName - the configuration in the described project to get the references for
        Returns:
        a list of dynamic build configurations
        Since:
        3.7
        See Also:
        setBuildConfigReferences(String, IBuildConfiguration[])

      • getBuildSpec

        ICommand[] getBuildSpec()
        Returns the list of build commands to run when building the described project. The commands are listed in the order in which they are to be run.
        Returns:
        the list of build commands for the described project

      • getComment

        String getComment()
        Returns the descriptive comment for the described project.
        Returns:
        the comment for the described project

      • getDynamicReferences

        IProject[] getDynamicReferences()
        Returns the dynamic project references for the described project. Dynamic project references can be used instead of simple project references in cases where the reference information is computed dynamically be a third party. These references are persisted by the workspace in a private location outside the project description file, and as such will not be shared when a project is exported or persisted in a repository. A client using project references is always responsible for setting these references when a project is created or recreated.

        The returned projects need not exist in the workspace. The result will not contain duplicates. Returns an empty array if there are no dynamic project references on this description.

        Returns:
        a list of projects
        Since:
        3.0
        See Also:
        getBuildConfigReferences(String), getReferencedProjects(), setDynamicReferences(IProject[])

      • getLocation

        @Deprecated
IPath getLocation()
        Deprecated.
        Since 3.2, project locations are not necessarily in the local file system. The more general getLocationURI() method should be used instead.
        Returns the local file system location for the described project. The path will be either an absolute file system path, or a relative path whose first segment is the name of a workspace path variable. null is returned if the default location should be used. This method will return null if this project is not located in the local file system.
        Returns:
        the location for the described project or null

      • getLocationURI

        URI getLocationURI()
        Returns the location URI for the described project. null is returned if the default location should be used.
        Returns:
        the location for the described project or null
        Since:
        3.2
        See Also:
        setLocationURI(URI)

      • getName

        String getName()
        Returns the name of the described project.
        Returns:
        the name of the described project

      • getNatureIds

        String[] getNatureIds()
        Returns the list of natures associated with the described project. Returns an empty array if there are no natures on this description.
        Returns:
        the list of natures for the described project
        See Also:
        setNatureIds(String[])

      • getReferencedProjects

        IProject[] getReferencedProjects()
        Returns the projects referenced by the described project. These references are persisted in the project description file (".project") and as such will be shared whenever the project is exported to another workspace. For references that are likely to change from one workspace to another, dynamic references should be used instead.

        The projects need not exist in the workspace. The result will not contain duplicates. Returns an empty array if there are no referenced projects on this description.

        Returns:
        a list of projects
        See Also:
        getDynamicReferences(), getBuildConfigReferences(String)

      • hasNature

        boolean hasNature​(String natureId)
        Returns whether the project nature specified by the given nature extension id has been added to the described project.
        Parameters:
        natureId - the nature extension identifier
        Returns:
        true if the described project has the given nature

      • newCommand

        ICommand newCommand()
        Returns a new build command.

        Note that the new command does not become part of this project description's build spec until it is installed via the setBuildSpec method.

        Returns:
        a new command
        See Also:
        setBuildSpec(ICommand[])

      • setActiveBuildConfig

        void setActiveBuildConfig​(String configName)
        Sets the active configuration for the described project.

        If a configuration with the specified name does not exist in the project then the first configuration in the project is treated as the active configuration.

        Parameters:
        configName - the configuration to set as the active or default
        Since:
        3.7

      • setBuildConfigs

        void setBuildConfigs​(String[] configNames)
        Sets the build configurations for the described project.

        The passed in names must all be non-null. Before they are set, duplicates are removed.

        All projects have one default build configuration, and it is impossible to configure the project to have no build configurations. If the input is null or an empty list, the current configurations are removed, and a default build configuration is (re-)added.

        Users must call IProject.setDescription(IProjectDescription, int, IProgressMonitor) before changes made to this description take effect.

        Parameters:
        configNames - the configurations to set for the described project
        Since:
        3.7
        See Also:
        IProject.getActiveBuildConfig(), IProject.getBuildConfigs(), setActiveBuildConfig(String)

      • setBuildConfigReferences

        void setBuildConfigReferences​(String configName,
                              IBuildConfiguration[] references)
        Sets the build configurations referenced by the specified configuration.

        The configuration to which references are being added needs to exist in this description, but the referenced projects and build configurations need not exist. A reference with null configuration name is resolved to the active build configuration on use. Duplicates will be removed. The order of the referenced build configurations is preserved. If the given configuration does not exist in this description then this has no effect.

        References at the build configuration level take precedence over references at the project level.

        Like dynamic references, these build configuration references are persisted as part of workspace metadata.

        Users must call IProject.setDescription(IProjectDescription, int, IProgressMonitor) before changes made to this description take effect.

        Parameters:
        configName - the configuration in the described project to set the references for
        references - list of build configuration references
        Since:
        3.7
        See Also:
        getBuildConfigReferences(String), IProject.setDescription(IProjectDescription, int, IProgressMonitor)

      • setLocation

        void setLocation​(IPath location)
        Sets the local file system location for the described project. The path must be either an absolute file system path, or a relative path whose first segment is the name of a defined workspace path variable. If null is specified, the default location is used.

        Setting the location on a description for a project which already exists has no effect; the new project location is ignored when the description is set on the already existing project. This method is intended for use on descriptions for new projects or for destination projects for copy and move.

        This operation maps the root folder of the project to the exact location provided. For example, if the location for project named "P" is set to the path c:\my_plugins\Project1, the file resource at workspace path /P/index.html would be stored in the local file system at c:\my_plugins\Project1\index.html.

        Parameters:
        location - the location for the described project or null
        See Also:
        getLocation()

      • setLocationURI

        void setLocationURI​(URI location)
        Sets the location for the described project. If null is specified, the default location is used.

        Setting the location on a description for a project which already exists has no effect; the new project location is ignored when the description is set on the already existing project. This method is intended for use on descriptions for new projects or for destination projects for copy and move.

        This operation maps the root folder of the project to the exact location provided. For example, if the location for project named "P" is set to the URI file://c:/my_plugins/Project1, the file resource at workspace path /P/index.html would be stored in the local file system at file://c:/my_plugins/Project1/index.html.

        Parameters:
        location - the location for the described project or null
        Since:
        3.2
        See Also:
        getLocationURI(), IWorkspace.validateProjectLocationURI(IProject, URI)

      • setName

        void setName​(String projectName)
        Sets the name of the described project.

        Setting the name on a description and then setting the description on the project has no effect; the new name is ignored.

        Creating a new project with a description name which doesn't match the project handle name results in the description name being ignored; the project will be created using the name in the handle.

        Parameters:
        projectName - the name of the described project
        See Also:
        IProject.setDescription(IProjectDescription, int, IProgressMonitor), getName()