XmlProperty

Description

Loads property values from a well-formed xml file. There are no other restrictions than "well-formed". You can choose the layout you want. For example this XML property file:

  <root>

    <properties>
      <foo>bar</foo>
    </properties>
  </root>

  root.properties.foo = bar

By default, this load does no processing of the input. In particular, unlike the Property task, property references (i.e., ${foo}) are not resolved.

Semantic Attributes

• Property references are resolved.
• The following attriubtes are treated differently:
  • id: The property is associated with the given id value.
  • location: The property is treated as a file location
  • refid: The property is set to the value of the referenced property.
  • value: The property is set to the value indicated.
• Path-like Structures can be defined by use of the following attributes:
  • pathid: The given id is used to identify a path. The nested XML tag name is ignored. Child elements can be used (XML tag names are ignored) to identify elements of the path.

For example, with semantic attribute processing enabled, this XML property file:

  <root>
    <properties>
      <foo location="bar"/>
      <quux>${root.properties.foo}</quux>
    </properties>

  </root>

  <property name="root.properties.foo" location="bar"/>
  <property name="root.properties.quux" value="${root.properties.foo}"/>

Parameters

Nested Elements

xmlcatalog

The <xmlcatalog> element is used to perform entity resolution.

Non-semantic Attributes

Here is an example xml file that does not have any semantic attributes.

   <root-tag myattr="true">
    <inner-tag someattr="val">Text</inner-tag>

    <a2><a3><a4>false</a4></a3></a2>
   </root-tag>

default loading

This entry in a build file:

   <xmlproperty file="somefile.xml"/>

   root-tag(myattr)=true
   root-tag.inner-tag=Text
   root-tag.inner-tag(someattr)=val
   root-tag.a2.a3.a4=false

collapseAttributes=false

This entry in a build file:

   <xmlproperty file="somefile.xml" collapseAttributes="true"/>

   root-tag.myattr=true
   root-tag.inner-tag=Text
   root-tag.inner-tag.someatt=val
   root-tag.a2.a3.a4=false

keepRoot=false

This entry in a build file:

   <xmlproperty file="somefile.xml" keepRoot="false"/>

   inner-tag=Text
   inner-tag(someattr)=val
   a2.a3.a4=false

Semantic Attributes

Here is an example xml file that has semantic attributes.

  <root-tag>
    <version value="0.0.1"/>
    <build folder="build">
      <classes id="build.classes" location="${build.folder}/classes"/>
      <reference refid="build.classes"/>

    </build>
    <compile>
      <classpath pathid="compile.classpath">
        <pathelement location="${build.classes}"/>
      </classpath>
    </compile>

    <run-time>
      <jars>*.jar</jars>
      <classpath pathid="run-time.classpath">
        <path refid="compile.classpath"/>
        <pathelement path="${run-time.jars}"/>

      </classpath>
    </run-time>
  </root-tag>

default loading (semanticAttributes=true)

This entry in a build file:

   <xmlproperty file="somefile.xml"
                semanticAttributes="true"/>

  <property name="version" value="0.0.1"/>
  <property name="build.folder" value="build"/>
  <property name="build.classes" location="${build.folder}/classes" 
   id="build.classes"/>
  <property name="build.reference" refid="build.classes"/>

  <property name="run-time.jars" value="*.jar/>

  <classpath id="compile.classpath">
    <pathelement location="${build.classes}"/>
  </classpath>

  <classpath id="run-time.classpath">
    <path refid="compile.classpath"/>

    <pathelement path="${run-time.jars}"/>
  </classpath>

includeSemanticAttribute="true"

This entry in a build file:

   <xmlproperty file="somefile.xml"
                semanticAttributes="true"
                includeSemanticAttribute="true"/>

  <property name="version.value" value="0.0.1"/>
  <property name="build.folder" value="build"/>
  <property name="build.classes.location" location="${build.folder}/classes"/>
  <property name="build.reference.refid" refid="build.location"/>

  <property name="run-time.jars" value="*.jar/>

  <classpath id="compile.classpath">
    <pathelement location="${build.classes}"/>
  </classpath>

  <classpath id="run-time.classpath">
    <path refid="compile.classpath"/>
    <pathelement path="${run-time.jars}"/>

  </classpath>

Source: Apache Ant

 Related Tips

• I have written a module. Can I sell it?
• 2D texture font - NeHe Tutorial JOGL Port
• 3D Human Animation Applet
• 3D lens flare with occlusion testing - NeHe Tutorial JOGL Port
• 3D shapes - NeHe Tutorial JOGL Port
• A model with a light which is moved by a modeling transformation
• A Morph object to animate a shape between two key shapes
• A red sphere using the Sphere utility class