# Ant Properties

###### Identifier:

org.eclipse.ant.core.antProperties

###### Since:

3.0

###### Description:

Allows plug-ins to define Ant properties for use in Ant build files.

###### Configuration Markup:

<!ELEMENT extension (antProperty*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance

<!ELEMENT antProperty EMPTY>

<!ATTLIST antProperty

name CDATA #REQUIRED

value CDATA #IMPLIED

class CDATA #IMPLIED

headless (true | false)

eclipseRuntime (true | false) >

- name - The name of the property.
- value - The value of the property. If a value is provided here, the "class" attribute is ignored.
- class - If there is no 'value' attribute provided, this class is called to return the dynamic value for the Ant property. If `null` is returned, the value is not set.
- headless - indicates whether this property is suitable for use in a "headless" Ant environment. If running headless and the attribute is "false", the property will not be set and any specified `org.eclipse.ant.core.IAntPropertyValueProvider` will not be instantiated. The implied value is `true`, when not specified.
- eclipseRuntime - indicates whether this property should only be considered when run in the same VM as Eclipse. The implied value is `true`, when not specified.

###### Examples:

The following is an example of an Ant properties extension point:

       <extension point="org.eclipse.ant.core.antProperties">
          <antProperty name="eclipse.home"
               class="org.eclipse.ant.internal.core.AntPropertyValueProvider"/>
          <antProperty name="eclipse.running"
               value="true"/>
       </extension>

###### API Information:

The class named in the `class` property must implement the `org.eclipse.ant.core.IAntPropertyValueProvider` interface.

###### Supplied Implementation:

The platform uses this mechanism to set the Ant property eclipse.home to the Eclipse installation directory and to set the eclipse.running property.

Copyright (c) 2000, 2006 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