org.eclipse.ant.core/schema/antProperties.exsd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.11 - (download) (annotate)
Wed Sep 13 20:33:25 2006 UTC (3 years, 2 months ago) by darins
Branch: MAIN
CVS Tags: v20091118, v20060925, v20080509, v20090505, v20081124, v20070511, R3_3_1_1, v20070426, v20091109, v20080514-1542, v20090112-1500, v20090511, v20090706, v20080128, v20091028_r34x_264388, v20071004, v20080512-1620, v20090817, v20090520, v20090504, v20090203, v20061023, v20090320, v20090323, R3_4, R3_5, R3_3, v20080908, v20081117, v20080319, v20080318, v20070315, v20070312, v20070128, pre_R3_3, v20070318, v20070416, v20091109_r342, v20080707, v20091012, v20090428, v20090429, v20081201, v20080425, v20080721, v20080303, v20080508-1600, v20070409, v20091110_r342, v20091109_r352, v20091008-1330, v20090413, v20080630, v20060918, v20081103, v20070522, v20091110_r352, v20070729, v20080818, v20090817_r351, v20090406, v20071212, R3_5_1, v20080529, v20070227, v20070423, R3_3_1, R3_3_2, v20061211, R3_4_2, R3_4_1, v20070110, v20070219, v20070826, HEAD
Branch point for: R3_4_maintenance, R3_5_maintenance
Changes since 1.10: +4 -4 lines
Bug 156621 - Wrong name for interface in ant extension documentation
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.ant.core">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.ant.core" id="antProperties" name="Ant Properties"/>
      </appInfo>
      <documentation>
         Allows plug-ins to define Ant properties for use in Ant build files.
      </documentation>
   </annotation>

   <element name="extension">
      <complexType>
         <sequence>
            <element ref="antProperty" minOccurs="0" maxOccurs="unbounded"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  a fully qualified identifier of the target extension point
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  an optional identifier of the extension instance
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  an optional name of the extension instance
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="antProperty">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="name"/>
         </appInfo>
      </annotation>
      <complexType>
         <attribute name="name" type="string" use="required">
            <annotation>
               <documentation>
                  The name of the property.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="value" type="string">
            <annotation>
               <documentation>
                  The value of the property. If a value is provided here, the &quot;class&quot; attribute is ignored.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="class" type="string">
            <annotation>
               <documentation>
                  If there is no &apos;value&apos; attribute provided, this class is called to return the dynamic value for the Ant property.  If &lt;code&gt;null&lt;/code&gt; is returned, the value is not set.
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.ant.core.IAntPropertyValueProvider"/>
               </appInfo>
            </annotation>
         </attribute>
         <attribute name="headless" type="boolean">
            <annotation>
               <documentation>
                  indicates whether this property is suitable for use in a &quot;headless&quot; Ant environment. If running headless and the attribute is &quot;false&quot;, the property will not be set and any specified &lt;code&gt;org.eclipse.ant.core.IAntPropertyValueProvider&lt;/code&gt; will not be instantiated. The implied value is &lt;code&gt;true&lt;/code&gt;, when not specified.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="eclipseRuntime" type="boolean">
            <annotation>
               <documentation>
                  indicates whether this property should only be considered when run in the same VM as Eclipse. The implied value is &lt;code&gt;true&lt;/code&gt;, when not specified.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         3.0
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         The following is an example of an Ant properties extension point: 
&lt;p&gt;
&lt;pre&gt;
   &lt;extension point=&quot;org.eclipse.ant.core.antProperties&quot;&gt;
      &lt;antProperty name=&quot;eclipse.home&quot;
           class=&quot;org.eclipse.ant.internal.core.AntPropertyValueProvider&quot;/&gt;
      &lt;antProperty name=&quot;eclipse.running&quot;
           value=&quot;true&quot;/&gt;
   &lt;/extension&gt; 
&lt;/pre&gt;
&lt;/p&gt;
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiInfo"/>
      </appInfo>
      <documentation>
         The class named in the &lt;samp&gt;class&lt;/samp&gt; property must implement the &lt;samp&gt;org.eclipse.ant.core.IAntPropertyValueProvider&lt;/samp&gt; interface.
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         The platform uses this mechanism to set the Ant property eclipse.home to the Eclipse installation directory and to set the eclipse.running property.
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="copyright"/>
      </appInfo>
      <documentation>
         Copyright (c) 2000, 2006 IBM Corporation and others.&lt;br&gt;
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 
&lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
      </documentation>
   </annotation>

</schema>