Package edu.umd.cs.findbugs.xml

Class Dom4JXMLOutput

java.lang.Object
edu.umd.cs.findbugs.xml.Dom4JXMLOutput
All Implemented Interfaces:
XMLOutput
public class Dom4JXMLOutput extends Object implements XMLOutput
XMLOutput class to build all or part of a dom4j tree.
Author:
David Hovemeyer
See Also:

  • Constructor Details

    • Dom4JXMLOutput

      public Dom4JXMLOutput(org.dom4j.Branch topLevel)
      Constructor.
      Parameters:
      topLevel - the Document or Element that is the root of the tree to be built

  • Method Details

    • beginDocument

      public void beginDocument()
      Description copied from interface: XMLOutput
      Begin the XML document.
      Specified by:
      beginDocument in interface XMLOutput

    • openTag

      public void openTag(String tagName)
      Description copied from interface: XMLOutput
      Open a tag with given name.
      Specified by:
      openTag in interface XMLOutput
      Parameters:
      tagName - the tag name

    • openTag

      public void openTag(String tagName, XMLAttributeList attributeList)
      Description copied from interface: XMLOutput
      Open a tag with given name and given attributes.
      Specified by:
      openTag in interface XMLOutput
      Parameters:
      tagName - the tag name
      attributeList - the attributes

    • openCloseTag

      public void openCloseTag(String tagName)
      Description copied from interface: XMLOutput
      Open and close tag with given name.
      Specified by:
      openCloseTag in interface XMLOutput
      Parameters:
      tagName - the tag name

    • openCloseTag

      public void openCloseTag(String tagName, XMLAttributeList attributeList)
      Description copied from interface: XMLOutput
      Open and close tag with given name and given attributes.
      Specified by:
      openCloseTag in interface XMLOutput
      Parameters:
      tagName - the tag name
      attributeList - the attributes

    • startTag

      public void startTag(String tagName)
      Description copied from interface: XMLOutput
      Start a tag, with the intention of adding attributes. Must be followed by stopTag after zero or more addAttribute calls.
      Specified by:
      startTag in interface XMLOutput
      Parameters:
      tagName - the tag name

    • addAttribute

      public void addAttribute(String name, String value)
      Description copied from interface: XMLOutput
      Add an attribute to a started tag. Must follow a call to startTag.
      Specified by:
      addAttribute in interface XMLOutput
      Parameters:
      name - the attribute name.
      value - the attribute value, unescaped.

    • stopTag

      public void stopTag(boolean close)
      Description copied from interface: XMLOutput
      End a started tag. Must follow a call to startTag.
      Specified by:
      stopTag in interface XMLOutput
      Parameters:
      close - true if the element has no content.

    • closeTag

      public void closeTag(String tagName)
      Description copied from interface: XMLOutput
      Close tag with given name.
      Specified by:
      closeTag in interface XMLOutput
      Parameters:
      tagName - the tag name

    • writeText

      public void writeText(String text)
      Description copied from interface: XMLOutput
      Write text to the XML document. XML metacharacters are automatically escaped.
      Specified by:
      writeText in interface XMLOutput
      Parameters:
      text - the text to write

    • writeCDATA

      public void writeCDATA(String cdata)
      Description copied from interface: XMLOutput
      Write a CDATA section to the XML document. The characters are not escaped in any way.
      Specified by:
      writeCDATA in interface XMLOutput
      Parameters:
      cdata - the character data to write

    • writeElementList

      public void writeElementList(String tagName, Collection<String> listValues)
      Add a list of Strings to document as elements with given tag name to the tree.
      Parameters:
      tagName - the tag name
      listValues - Collection of String values to add

    • write

      public void write(XMLWriteable obj)
      Add given object to the tree.
      Parameters:
      obj - the object

    • writeCollection

      public void writeCollection(Collection<? extends XMLWriteable> collection)
      Add a Collection of XMLWriteable objects to the tree.
      Parameters:
      collection - Collection of XMLWriteable objects

    • finish

      public void finish()
      Description copied from interface: XMLOutput
      Finish writing XML output, closing any underlying resources (such as output streams). A call to this method should always be made, even if one of the XML-generation methods throws an exception. Therefore, a call to this method should be performed in a finally block.
      Specified by:
      finish in interface XMLOutput