com.day.cq.commons

Class SimpleXml.Element

java.lang.Object

com.day.cq.commons.SimpleXml.Element

Enclosing class:

SimpleXml

public class SimpleXml.Element
extends java.lang.Object

The SimpleXml.Element reperesents an XML element.

Method Summary

Modifier and Type	Method and Description
SimpleXml.Element	addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.String value, java.lang.String type) Adds a new attribute to the XML element.
SimpleXml.Element	attr(java.lang.String name, java.lang.String value) Adds a new attribute to the XML element.
SimpleXml.Element	attr(java.lang.String localName, java.lang.String name, java.lang.String value) Adds a new attribute to the XML element.
SimpleXml.Element	attr(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.String value, java.lang.String type) Adds a new attribute to the XML element.
SimpleXml.Element	attrs(java.lang.String[]... atts) Adds the specified attributes to the XML element.
SimpleXml	close() Explicitly closes the XML element.
boolean	hasCDATA() States whether the XML element has a CDATA block.
SimpleXml	open() Explicitly opens the XML element.
SimpleXml.Element	open(java.lang.String name) Opens and returns a new XML element with the specified name.
SimpleXml.Element	open(java.lang.String localName, java.lang.String name) Opens and returns a new XML element with the specified name.
SimpleXml.Element	open(java.lang.String name, java.lang.String content, boolean cdata) Opens and returns a new XML element with the specified name and content.
SimpleXml.Element	open(java.lang.String uri, java.lang.String localName, java.lang.String name) Opens and returns a new XML element with the specified name.
SimpleXml.Element	setCDATA(boolean cdata) Defines whether the XML element has a CDATA block.
SimpleXml.Element	setText(java.lang.String text, boolean cdata) Sets the content of the XML element.
SimpleXml.Element	text(java.lang.String text) Sets the content of the XML element.
SimpleXml.Element	text(java.lang.String text, boolean cdata) Sets the content of the XML element.

Methods inherited from class java.lang.Object

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

Method Detail

attr

public SimpleXml.Element attr(java.lang.String name,
                              java.lang.String value)

Adds a new attribute to the XML element. This method is a shorthand for addAttribute(String, String, String, String, String).

Parameters:

name - The name of the attribute

value - The value of the attribute

Returns:

The XML element

attr

public SimpleXml.Element attr(java.lang.String localName,
                              java.lang.String name,
                              java.lang.String value)

Adds a new attribute to the XML element. This method is a shorthand for addAttribute(String, String, String, String, String).

Parameters:

localName - The local name of the attribute

name - The name of the attribute

value - The value of the attribute

Returns:

The XML element

attr

public SimpleXml.Element attr(java.lang.String uri,
                              java.lang.String localName,
                              java.lang.String name,
                              java.lang.String value,
                              java.lang.String type)

Adds a new attribute to the XML element. This method is a shorthand for addAttribute(String, String, String, String, String).

Parameters:

uri - The URI of the attribute

localName - The local name of the attribute

name - The name of the attribute

value - The value of the attribute

type - The type of the attribute

Returns:

The XML element

attrs

public SimpleXml.Element attrs(java.lang.String[]... atts)

Adds the specified attributes to the XML element.

Parameters:

atts - The attributes

Returns:

The XML element

addAttribute

public SimpleXml.Element addAttribute(java.lang.String uri,
                                      java.lang.String localName,
                                      java.lang.String name,
                                      java.lang.String value,
                                      java.lang.String type)

Adds a new attribute to the XML element.

Parameters:

uri - The URI of the attribute

localName - The local name of the attribute

name - The name of the attribute

value - The value of the attribute

type - The type of the attribute

Returns:

The XML element

text

public SimpleXml.Element text(java.lang.String text)

Sets the content of the XML element. This method is a shorthand for setText(String, boolean).

Parameters:

text - The content

Returns:

The XML element

text

public SimpleXml.Element text(java.lang.String text,
                              boolean cdata)

Sets the content of the XML element. This method is a shorthand for setText(String, boolean).

Parameters:

text - The content

cdata - true if content should be in a CDATA block, false otherwise

Returns:

The XML element

setText

public SimpleXml.Element setText(java.lang.String text,
                                 boolean cdata)

Sets the content of the XML element.

Parameters:

text - The content

cdata - true if content should be in a CDATA block, false otherwise

Returns:

The XML element

setCDATA

public SimpleXml.Element setCDATA(boolean cdata)

Defines whether the XML element has a CDATA block.

Parameters:

cdata - true if the XML element has a CDATA block, false otherwise

Returns:

The XML element

open

public SimpleXml open()
               throws java.io.IOException

Explicitly opens the XML element. No more attributes can be added to the XML element after calling this method.

Returns:

The XML writer

Throws:

java.io.IOException - If output fails

open

public SimpleXml.Element open(java.lang.String name)
                       throws java.io.IOException

Opens and returns a new XML element with the specified name. This method can be used for chaining. It opens the current XML element, then calls its equivalent in SimpleXml.

Parameters:

name - The name of the XML element

Returns:

The XML element

Throws:

java.io.IOException - If output fails

See Also:

SimpleXml.open(String)

open

public SimpleXml.Element open(java.lang.String localName,
                              java.lang.String name)
                       throws java.io.IOException

Opens and returns a new XML element with the specified name. This method can be used for chaining. It opens the current XML element, then calls its equivalent in SimpleXml.

Parameters:

localName - The local name of the XML element

name - The name of the XML element

Returns:

The XML element

Throws:

java.io.IOException - If output fails

See Also:

SimpleXml.open(String, String)

open

public SimpleXml.Element open(java.lang.String uri,
                              java.lang.String localName,
                              java.lang.String name)
                       throws java.io.IOException

Opens and returns a new XML element with the specified name. This method can be used for chaining. It opens the current XML element, then calls its equivalent in SimpleXml.

Parameters:

uri - The URI of the XML element

localName - The local name of the XML element

name - The name of the XML element

Returns:

The XML element

Throws:

java.io.IOException - If output fails

See Also:

SimpleXml.open(String, String, String)

open

public SimpleXml.Element open(java.lang.String name,
                              java.lang.String content,
                              boolean cdata)
                       throws java.io.IOException

Opens and returns a new XML element with the specified name and content. This method can be used for chaining. It opens the current XML element, then calls its equivalent in SimpleXml.

Parameters:

name - The name of the XML element

content - The content of the XML element

cdata - true if content should be in a CDATA block, false otherwise

Returns:

The XML element

Throws:

java.io.IOException - If output fails

See Also:

SimpleXml.open(String, String, boolean)

close

public SimpleXml close()
                throws java.io.IOException

Explicitly closes the XML element. This method will write the XML element and consequently render it immutable.

Returns:

The XML writer

Throws:

java.io.IOException - If output fails

hasCDATA

public boolean hasCDATA()

States whether the XML element has a CDATA block.

Returns:

true if the XML element has a CDATA block, false otherwise