com.inet.gradle.setup.util

Class XmlFileBuilder<T extends AbstractSetupTask>

java.lang.Object

com.inet.gradle.setup.util.XmlFileBuilder<T>

Type Parameters:

T - The SetupBuilder Task.

public class XmlFileBuilder<T extends AbstractSetupTask>
extends java.lang.Object

Build an XML.

Field Summary

Fields

Modifier and Type	Field and Description
java.io.File	buildDir
org.w3c.dom.Document	doc
SetupBuilder	setup
T	task
java.io.File	xmlFile

Constructor Summary

Constructors

Constructor and Description
XmlFileBuilder(T task, SetupBuilder setup, java.io.File xmlFile, java.io.File buildDir, java.net.URL template)

Method Summary

Modifier and Type	Method and Description
void	addAttributeIfNotExists(org.w3c.dom.Element el, java.lang.String name, java.lang.String value) Add a attribute if not exists.
void	addNodeText(org.w3c.dom.Element el, java.lang.String text) Adds Text content to a node
org.w3c.dom.Element	createChild(org.w3c.dom.Node parent, java.lang.String name, boolean append)
org.w3c.dom.Element	getOrCreateChild(org.w3c.dom.Node parent, java.lang.String name)
org.w3c.dom.Element	getOrCreateChild(org.w3c.dom.Node parent, java.lang.String name, boolean append)
org.w3c.dom.Element	getOrCreateChild(org.w3c.dom.Node parent, java.lang.String name, java.lang.String textNodeValue, boolean append) Returns or creates a child node with a text node entry only
org.w3c.dom.Element	getOrCreateChildById(org.w3c.dom.Node parent, java.lang.String name, java.lang.String id)
org.w3c.dom.Element	getOrCreateChildById(org.w3c.dom.Node parent, java.lang.String name, java.lang.String id, boolean append)
org.w3c.dom.Element	getOrCreateChildByKeyValue(org.w3c.dom.Node parent, java.lang.String name, java.lang.String key, java.lang.String value)
org.w3c.dom.Element	getOrCreateChildByKeyValue(org.w3c.dom.Node parent, java.lang.String name, java.lang.String key, java.lang.String value, boolean append) Get or create a child element.
void	save() Save the XML file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

task

public final T extends AbstractSetupTask task

setup

public final SetupBuilder setup

xmlFile

public final java.io.File xmlFile

buildDir

public final java.io.File buildDir

doc

public final org.w3c.dom.Document doc

Constructor Detail

XmlFileBuilder

public XmlFileBuilder(T task,
                      SetupBuilder setup,
                      java.io.File xmlFile,
                      java.io.File buildDir,
                      java.net.URL template)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

save

public void save()
          throws java.lang.Exception

Save the XML file

Throws:

java.lang.Exception - if any error occur

addAttributeIfNotExists

public void addAttributeIfNotExists(org.w3c.dom.Element el,
                                    java.lang.String name,
                                    java.lang.String value)

Add a attribute if not exists.

Parameters:

el - the element/node in the XML

name - the name of the attribute

value - the value

addNodeText

public void addNodeText(org.w3c.dom.Element el,
                        java.lang.String text)

Adds Text content to a node

Parameters:

el - Node

text - content

getOrCreateChild

public org.w3c.dom.Element getOrCreateChild(org.w3c.dom.Node parent,
                                            java.lang.String name)

getOrCreateChild

public org.w3c.dom.Element getOrCreateChild(org.w3c.dom.Node parent,
                                            java.lang.String name,
                                            boolean append)

getOrCreateChild

public org.w3c.dom.Element getOrCreateChild(org.w3c.dom.Node parent,
                                            java.lang.String name,
                                            java.lang.String textNodeValue,
                                            boolean append)

Returns or creates a child node with a text node entry only

Parameters:

parent - the parent node to attach to

name - the name of the node

textNodeValue - the textnode value of the node

append - if it should be appended or set in first position

Returns:

the new element

createChild

public org.w3c.dom.Element createChild(org.w3c.dom.Node parent,
                                       java.lang.String name,
                                       boolean append)

getOrCreateChildById

public org.w3c.dom.Element getOrCreateChildById(org.w3c.dom.Node parent,
                                                java.lang.String name,
                                                java.lang.String id)

getOrCreateChildById

public org.w3c.dom.Element getOrCreateChildById(org.w3c.dom.Node parent,
                                                java.lang.String name,
                                                java.lang.String id,
                                                boolean append)

getOrCreateChildByKeyValue

public org.w3c.dom.Element getOrCreateChildByKeyValue(org.w3c.dom.Node parent,
                                                      java.lang.String name,
                                                      java.lang.String key,
                                                      java.lang.String value)

getOrCreateChildByKeyValue

public org.w3c.dom.Element getOrCreateChildByKeyValue(org.w3c.dom.Node parent,
                                                      java.lang.String name,
                                                      java.lang.String key,
                                                      java.lang.String value,
                                                      boolean append)

Get or create a child element.

Parameters:

parent - the parent node in which we search and create

name - The tag name of the element

key - the name of an attribute, can't be null

value - the value, can be null for not existing

append - true, append at end of the children; false, add at top of the children

Returns:

the create of find Element