| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE html |
| PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html lang="en-us" xml:lang="en-us"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <!-- /******************************************************************************* |
| * Copyright (c) 2000, 2005 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ --> |
| <link rel="stylesheet" type="text/css" href="../../org.eclipse.wtp.doc.user/common.css" /> |
| |
| <title>getProjectData</title> |
| </head> |
| <body id="tantgetp"><a name="tantgetp"><!-- --></a> |
| <h1 class="topictitle1">getProjectData</h1> |
| <div><p>This task gets the specified project information.</p> |
| <div class="section"><p><span class="uicontrol">Parameters</span></p> |
| |
| <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" valign="top" width="22.64808362369338%" id="d0e20">Attribute</th> |
| <th align="left" valign="top" width="56.79442508710801%" id="d0e22">Description</th> |
| <th align="left" valign="top" width="20.557491289198605%" id="d0e24">Required</th> |
| </tr> |
| </thead> |
| <tbody><tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">ProjectName</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">The name of the project</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">Yes</td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">Basedir (deprecated)</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">The fully qualified project basedir (typically X:\MYINSTALLDIR\MYWORKSPACE\MYPROJECT)</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No (deprecated).</td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">ProjectProperty (deprecated)</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">Property name to receive the project name</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No (deprecated), default is <em>projectName</em> </td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">WorkspaceProperty</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">Property name to receive the workspace path</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No, default is <em>workspaceName</em></td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">LocationProperty</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">Property name to receive the project location</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No, default is <em>locationName</em></td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">NatureProperty</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">Property name to receive the project nature</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No, default is <em>natureName</em></td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">hasSpecifiedNature</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">The name of a project nature to be tested</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No, no default (only enter a value if you want to test |
| if the project also has that specific nature)</td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">hasSpecifiedNatureProperty</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">Property name to receive true (or false) if the project |
| has (or does not have) the specified nature</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">Yes, if <em>hasSpecifiedNature</em> is present</td> |
| </tr> |
| <tr><td align="left" valign="top" width="22.64808362369338%" headers="d0e20 ">FailOnError</td> |
| <td align="left" valign="top" width="56.79442508710801%" headers="d0e22 ">Will cause the build to fail if the operation cannot complete |
| successfully (such as specifying an invalid project)</td> |
| <td align="left" valign="top" width="20.557491289198605%" headers="d0e24 ">No, default is <em>true</em></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <p><span class="uicontrol">Examples</span></p> |
| <ul><li>Retrieve and display current project information: <pre><getProjectData projectName=${myProject} |
| hasSpecifiedNature="Java" |
| hasSpecifiedNatureProperty="isSpecifiedPropertyPresent" |
| failOnError="false" /> |
| <echo message="getProjectData: projectName=${projectName} |
| nature=${natureName} |
| workspace=${workspaceName} |
| location=${locationName} |
| JavaNature="${isSpecifiedNaturePresent}" /> </pre> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div> |
| <div class="familylinks"> |
| <div class="parentlink"><strong>Parent topic:</strong> <a href="../topics/ph-antgeneral.html" title="">General Ant tasks</a></div> |
| </div> |
| <div class="reltasks"><strong>Related tasks</strong><br /> |
| <div><a href="../topics/tantcapturebuildmessages.html" title="This task captures Ant build messages and allows them to be searched or displayed, and allows conditional Ant build failures depending on whether or not a specified string is in the captured build messages.">captureBuildMessages</a></div> |
| <div><a href="../topics/tantcompilew.html" title="This task compiles the entire workspace. It performs the same action as javac. While this task is running, all the validation and other builders are turned of">compileWorkspace</a></div> |
| <div><a href="../topics/tantgetj.html" title="This task gets the error count for the last internal javac compilation of the specified project.">getJavacErrorCount</a></div> |
| <div><a href="../topics/tantproj.html" title="This task builds the specified project.">projectBuild</a></div> |
| <div><a href="../topics/tantprojectgeterrors.html" title="This task gets the errors for the specified project. It is a subset of the projectBuild task (it does not do a build, it just gets project errors regardless of how they were created)">projectGetErrors</a></div> |
| <div><a href="../topics/tantprojectimport.html" title="This task imports an existing file system project into a workspace.">projectImport</a></div> |
| <div><a href="../topics/tantprojectsetbuild.html" title="This task builds a set of Eclipse projects using an existing Eclipse team Project Set File ("PSF"). The PSF must have been first created using an Eclipse team "Project Set Export" command, and then the task projectSetImport must have been used to import those projects into a workspace.">projectSetBuild</a></div> |
| <div><a href="../topics/tantprojectsetimport.html" title="This task imports an existing Eclipse team Project Set File (PSF) into a workspace. The PSF must have been first created using an Eclipse team "Project Set Export" command.">projectSetImport</a></div> |
| <div><a href="../topics/tantsetd.html" title="This task sets the internal Java compilation debug level, and returns the current settings.">setDebugInfo</a></div> |
| <div><a href="../topics/tantworkspacebuild.html" title="This task builds the entire workspace.">workspaceBuild</a></div> |
| <div><a href="../topics/tantworkspacegeterrors.html" title="This task gets the errors for the entire workspace. It is a subset of the workspaceBuild task (it does not do a build, it just gets workspace errors regardless of how they were created).">workspaceGetErrors</a></div> |
| <div><a href="../topics/tantworkspacepreferencefile.html" title="This task reads a property file containing Eclipse workspace preferences and sets those preferences.">workspacePreferenceFile</a></div> |
| <div><a href="../topics/tantworkspacepreferenceget.html" title="This task gets Eclipse workspace preferences.">workspacePreferenceGet</a></div> |
| <div><a href="../topics/tantworkspacepreferenceset.html" title="This task sets Eclipse workspace preferences.">workspacePreferenceSet</a></div> |
| </div> |
| </div></body> |
| </html> |
