org.apache.tools.ant.util

Class XMLFragment

Implemented Interfaces:
Cloneable, DynamicElementNS
Known Direct Subclasses:
EchoXML

public class XMLFragment
extends ProjectComponent
implements DynamicElementNS

Use this class as a nested element if you want to get a literal DOM fragment of something nested into your task/type.

This is useful for tasks that want to deal with the "real" XML from the build file instead of objects.

Code heavily influenced by code written by Dominique Devienne.

Since:
Ant 1.7

Nested Class Summary

class
XMLFragment.Child
An object to handle (recursively) nested elements.

Field Summary

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

XMLFragment()
Constructor for XMLFragment object.

Method Summary

void
addText(String s)
Add nested text, expanding properties as we go
Object
createDynamicElement(String uri, String name, String qName)
Creates a nested element.
DocumentFragment
getFragment()

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

XMLFragment

public XMLFragment()
Constructor for XMLFragment object.

Method Details

addText

public void addText(String s)
Add nested text, expanding properties as we go
Parameters:
s - the text to add

createDynamicElement

public Object createDynamicElement(String uri,
                                   String name,
                                   String qName)
Creates a nested element.
Specified by:
createDynamicElement in interface DynamicElementNS
Parameters:
uri - the uri of the nested element
name - the localname of the nested element
qName - the qualified name of the nested element
Returns:
an object that the element is applied to

getFragment

public DocumentFragment getFragment()
Returns:
the DocumentFragment that corresponds to the nested structure.