Package edu.umd.cs.findbugs.xml

Class OutputStreamXMLOutput

  • All Implemented Interfaces:
    XMLOutput
    public class OutputStreamXMLOutput
extends java.lang.Object
implements XMLOutput
    Write XML to an output stream.
    Author:
    David Hovemeyer

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAttribute​(java.lang.String name, java.lang.String value)
      Add an attribute to a started tag.
      void beginDocument()
      Begin the XML document.
      void closeTag​(java.lang.String tagName)
      Close tag with given name.
      void finish()
      Finish writing XML output, closing any underlying resources (such as output streams).
      void flush()  
      void openCloseTag​(java.lang.String tagName)
      Open and close tag with given name.
      void openCloseTag​(java.lang.String tagName, XMLAttributeList attributeList)
      Open and close tag with given name and given attributes.
      void openTag​(java.lang.String tagName)
      Open a tag with given name.
      void openTag​(java.lang.String tagName, XMLAttributeList attributeList)
      Open a tag with given name and given attributes.
      void startTag​(java.lang.String tagName)
      Start a tag, with the intention of adding attributes.
      void stopTag​(boolean close)
      End a started tag.
      void writeCDATA​(java.lang.String cdata)
      Write a CDATA section to the XML document.
      void writeText​(java.lang.String text)
      Write text to the XML document.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • OutputStreamXMLOutput

        public OutputStreamXMLOutput​(@WillCloseWhenClosed
                             java.io.OutputStream os)
        Constructor.
        Parameters:
        os - OutputStream to write XML output to

      • OutputStreamXMLOutput

        public OutputStreamXMLOutput​(@WillCloseWhenClosed
                             java.io.Writer writer)
        Constructor.
        Parameters:
        writer - Writer to write XML output to

      • OutputStreamXMLOutput

        public OutputStreamXMLOutput​(@WillCloseWhenClosed
                             java.io.OutputStream os,
                             java.lang.String stylesheet)
        Constructor.
        Parameters:
        os - OutputStream to write XML output to
        stylesheet - name of stylesheet

      • OutputStreamXMLOutput

        public OutputStreamXMLOutput​(@WillCloseWhenClosed
                             java.io.Writer writer,
                             java.lang.String stylesheet)

    • Method Detail

      • beginDocument

        public void beginDocument()
                   throws java.io.IOException
        Description copied from interface: XMLOutput
        Begin the XML document.
        Specified by:
        beginDocument in interface XMLOutput
        Throws:
        java.io.IOException

      • openTag

        public void openTag​(java.lang.String tagName)
             throws java.io.IOException
        Description copied from interface: XMLOutput
        Open a tag with given name.
        Specified by:
        openTag in interface XMLOutput
        Parameters:
        tagName - the tag name
        Throws:
        java.io.IOException

      • openTag

        public void openTag​(java.lang.String tagName,
                    XMLAttributeList attributeList)
             throws java.io.IOException
        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
        Throws:
        java.io.IOException

      • openCloseTag

        public void openCloseTag​(java.lang.String tagName)
                  throws java.io.IOException
        Description copied from interface: XMLOutput
        Open and close tag with given name.
        Specified by:
        openCloseTag in interface XMLOutput
        Parameters:
        tagName - the tag name
        Throws:
        java.io.IOException

      • openCloseTag

        public void openCloseTag​(java.lang.String tagName,
                         XMLAttributeList attributeList)
                  throws java.io.IOException
        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
        Throws:
        java.io.IOException

      • startTag

        public void startTag​(java.lang.String tagName)
              throws java.io.IOException
        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
        Throws:
        java.io.IOException

      • addAttribute

        public void addAttribute​(java.lang.String name,
                         java.lang.String value)
                  throws java.io.IOException
        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.
        Throws:
        java.io.IOException

      • stopTag

        public void stopTag​(boolean close)
             throws java.io.IOException
        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.
        Throws:
        java.io.IOException

      • closeTag

        public void closeTag​(java.lang.String tagName)
              throws java.io.IOException
        Description copied from interface: XMLOutput
        Close tag with given name.
        Specified by:
        closeTag in interface XMLOutput
        Parameters:
        tagName - the tag name
        Throws:
        java.io.IOException

      • writeText

        public void writeText​(java.lang.String text)
               throws java.io.IOException
        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
        Throws:
        java.io.IOException

      • writeCDATA

        public void writeCDATA​(java.lang.String cdata)
                throws java.io.IOException
        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
        Throws:
        java.io.IOException

      • flush

        public void flush()
           throws java.io.IOException
        Throws:
        java.io.IOException

      • finish

        @DischargesObligation
public void finish()
            throws java.io.IOException
        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
        Throws:
        java.io.IOException