Package com.day.cq.commons

Class SimpleXml.Element

java.lang.Object
com.day.cq.commons.SimpleXml.Element
Enclosing class:
SimpleXml
public class SimpleXml.Element extends Object
The SimpleXml.Element reperesents an XML element.

  • Method Details

    • attr

      public SimpleXml.Element attr(String name, 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(String localName, String name, 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(String uri, String localName, String name, String value, 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(String[]... atts)
      Adds the specified attributes to the XML element.
      Parameters:
      atts - The attributes
      Returns:
      The XML element

    • addAttribute

      public SimpleXml.Element addAttribute(String uri, String localName, String name, String value, 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(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(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(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 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:
      IOException - If output fails

    • open

      public SimpleXml.Element open(String name) throws 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:
      IOException - If output fails
      See Also:

    • open

      public SimpleXml.Element open(String localName, String name) throws 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:
      IOException - If output fails
      See Also:

    • open

      public SimpleXml.Element open(String uri, String localName, String name) throws 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:
      IOException - If output fails
      See Also:

    • open

      public SimpleXml.Element open(String name, String content, boolean cdata) throws 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:
      IOException - If output fails
      See Also:

    • close

      public SimpleXml close() throws IOException
      Explicitly closes the XML element. This method will write the XML element and consequently render it immutable.
      Returns:
      The XML writer
      Throws:
      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