Package org.jibx.runtime.impl

Class XMLWriterBase

    • Constructor Detail

      • XMLWriterBase

        public XMLWriterBase​(String[] uris)
        Constructor.
        Parameters:
        uris - ordered array of URIs for namespaces used in document (must be constant; the value in position 0 must always be the empty string "", and the value in position 1 must always be the XML namespace "http://www.w3.org/XML/1998/namespace")

      • XMLWriterBase

        public XMLWriterBase​(XMLWriterBase base,
                     String[] uris)
        Copy constructor. This initializes the extension namespace information from an existing instance.
        Parameters:
        base - existing instance
        uris - ordered array of URIs for namespaces used in document

    • Method Detail

      • writeMarkup

        protected abstract void writeMarkup​(String text)
                             throws IOException
        Write markup text to output. Markup text can be written directly to the output without the need for any escaping, but still needs to be properly encoded.
        Parameters:
        text - markup text to be written
        Throws:
        IOException - if error writing to document

      • writeMarkup

        protected abstract void writeMarkup​(char chr)
                             throws IOException
        Write markup character to output. Markup text can be written directly to the output without the need for any escaping, but still needs to be properly encoded.
        Parameters:
        chr - markup character to be written
        Throws:
        IOException - if error writing to document

      • writePrefix

        protected abstract void writePrefix​(int index)
                             throws IOException
        Write namespace prefix to output. This internal method is used to throw an exception when an undeclared prefix is used.
        Parameters:
        index - namespace URI index number
        Throws:
        IOException - if error writing to document

      • writeAttributeText

        protected abstract void writeAttributeText​(String text)
                                    throws IOException
        Write attribute text to output. This needs to write the text with any appropriate escaping.
        Parameters:
        text - attribute value text to be written
        Throws:
        IOException - if error writing to document

      • indent

        protected abstract void indent​(int bias)
                        throws IOException
        Request output indent with bias from current element nesting level. This is used internally for proper indenting in special cases.
        Parameters:
        bias - Bias
        Throws:
        IOException - on error writing to document

      • flagContent

        protected final void flagContent()
                          throws IOException
        Set up for writing any content to element. If the start tag for the element has not been closed, this will close it.
        Throws:
        IOException - on error writing to document

      • flagTextContent

        protected final void flagTextContent()
                              throws IOException
        Set up for writing text content to element. If the start tag for the element has not been closed, this will close it.
        Throws:
        IOException - on error writing to document

      • init

        public void init()
        Initialize writer.
        Specified by:
        init in interface IXMLWriter

      • writeXMLDecl

        public void writeXMLDecl​(String version,
                         String encoding,
                         String standalone)
                  throws IOException
        Write XML declaration to document. This can only be called before any other methods in the interface are called.
        Specified by:
        writeXMLDecl in interface IXMLWriter
        Parameters:
        version - XML version text
        encoding - text for encoding attribute (unspecified if null)
        standalone - text for standalone attribute (unspecified if null)
        Throws:
        IOException - on error writing to document

      • startTagOpen

        public void startTagOpen​(int index,
                         String name)
                  throws IOException
        Generate open start tag. This allows attributes to be added to the start tag, but must be followed by a closeStartTag() call.
        Specified by:
        startTagOpen in interface IXMLWriter
        Parameters:
        index - namespace URI index number
        name - unqualified element name
        Throws:
        IOException - on error writing to document

      • startTagNamespaces

        public void startTagNamespaces​(int index,
                               String name,
                               int[] nums,
                               String[] prefs)
                        throws IOException
        Generate start tag for element with namespaces. This creates the actual start tag, along with any necessary namespace declarations. Previously active namespace declarations are not duplicated. The tag is left incomplete, allowing other attributes to be added.
        Specified by:
        startTagNamespaces in interface IXMLWriter
        Parameters:
        index - namespace URI index number
        name - element name
        nums - array of namespace indexes defined by this element (must be constant, reference is kept until end of element)
        prefs - array of namespace prefixes mapped by this element (no null values, use "" for default namespace declaration)
        Throws:
        IOException - on error writing to document

      • startTagClosed

        public void startTagClosed​(int index,
                           String name)
                    throws IOException
        Generate closed start tag. No attributes or namespaces can be added to a start tag written using this call.
        Specified by:
        startTagClosed in interface IXMLWriter
        Parameters:
        index - namespace URI index number
        name - unqualified element name
        Throws:
        IOException - on error writing to document

      • endTag

        public void endTag​(int index,
                   String name)
            throws IOException
        Generate end tag.
        Specified by:
        endTag in interface IXMLWriter
        Parameters:
        index - namespace URI index number
        name - unqualified element name
        Throws:
        IOException - on error writing to document

      • writeDocType

        public void writeDocType​(String name,
                         String sys,
                         String pub,
                         String subset)
                  throws IOException
        Write DOCTYPE declaration to document.
        Specified by:
        writeDocType in interface IXMLWriter
        Parameters:
        name - root element name
        sys - system ID (null if none, must be non-null for public ID to be used)
        pub - public ID (null if none)
        subset - internal subset (null if none)
        Throws:
        IOException - on error writing to document

      • writePI

        public void writePI​(String target,
                    String data)
             throws IOException
        Write processing instruction to document.
        Specified by:
        writePI in interface IXMLWriter
        Parameters:
        target - processing instruction target name
        data - processing instruction data
        Throws:
        IOException - on error writing to document

      • flush

        public abstract void flush()
                    throws IOException
        Flush document output. Subclasses must implement this method to force all buffered output to be written. To assure proper handling of an open start tag they should first call flagContent().
        Specified by:
        flush in interface IXMLWriter
        Throws:
        IOException - on error writing to document

      • close

        public abstract void close()
                    throws IOException
        Close document output. Completes writing of document output, including closing the output medium.
        Specified by:
        close in interface IXMLWriter
        Throws:
        IOException - on error writing to document

      • reset

        public void reset()
        Reset to initial state for reuse. The writer is serially reusable, as long as this method is called to clear any retained state information between uses. It is automatically called when output is set.
        Specified by:
        reset in interface IXMLWriter
        Overrides:
        reset in class XMLWriterNamespaceBase