Package com.prowidesoftware.swift.model.mx

Class XmlEventWriter

  • All Implemented Interfaces:
    javax.xml.stream.util.XMLEventConsumer, javax.xml.stream.XMLEventWriter
    public final class XmlEventWriter
extends java.lang.Object
implements javax.xml.stream.XMLEventWriter
    XMl writer for MX model classes.
    Since:
    7.8

    • Constructor Detail

      • XmlEventWriter

        public XmlEventWriter​(java.io.Writer baos,
                      java.lang.String defaultPrefix,
                      boolean includeXMLDeclaration,
                      java.lang.String rootElement,
                      EscapeHandler escapeHandler,
                      java.lang.String indent)
        Parameters:
        baos - output buffer to write
        defaultPrefix - optional prefix (empty by default) to used for all elements that are not binded to a specific prefix
        includeXMLDeclaration - true to include the XML declaration (true by default)
        rootElement - local name of the root element of the XML fragment to create, used to declare namespace
        escapeHandler - escape handler to use or null to use the default
        Since:
        9.1.7
        See Also:
        setPreferredPrefixes(Map)

    • Method Detail

      • add

        public void add​(javax.xml.stream.events.XMLEvent event)
         throws javax.xml.stream.XMLStreamException
        Specified by:
        add in interface javax.xml.stream.util.XMLEventConsumer
        Specified by:
        add in interface javax.xml.stream.XMLEventWriter
        Throws:
        javax.xml.stream.XMLStreamException

      • add

        public void add​(javax.xml.stream.XMLEventReader arg0)
        Specified by:
        add in interface javax.xml.stream.XMLEventWriter

      • close

        public void close()
        Specified by:
        close in interface javax.xml.stream.XMLEventWriter

      • flush

        public void flush()
           throws javax.xml.stream.XMLStreamException
        Specified by:
        flush in interface javax.xml.stream.XMLEventWriter
        Throws:
        javax.xml.stream.XMLStreamException

      • getNamespaceContext

        public javax.xml.namespace.NamespaceContext getNamespaceContext()
        Specified by:
        getNamespaceContext in interface javax.xml.stream.XMLEventWriter

      • setNamespaceContext

        public void setNamespaceContext​(javax.xml.namespace.NamespaceContext arg0)
        Specified by:
        setNamespaceContext in interface javax.xml.stream.XMLEventWriter

      • getPrefix

        public java.lang.String getPrefix​(java.lang.String arg0)
        Specified by:
        getPrefix in interface javax.xml.stream.XMLEventWriter

      • setDefaultNamespace

        public void setDefaultNamespace​(java.lang.String arg0)
        Specified by:
        setDefaultNamespace in interface javax.xml.stream.XMLEventWriter

      • setPrefix

        public void setPrefix​(java.lang.String arg0,
                      java.lang.String arg1)
        Specified by:
        setPrefix in interface javax.xml.stream.XMLEventWriter

      • getDefaultPrefix

        public java.lang.String getDefaultPrefix()
        Since:
        7.9.3

      • setDefaultPrefix

        public void setDefaultPrefix​(java.lang.String defaultPrefix)
        Since:
        7.9.3

      • getPeferredPrefixes

        @ProwideDeprecated(phase4=SRU2023)
@Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getPeferredPrefixes()
        Deprecated.
        use getPreferredPrefixes() instead

      • setPeferredPrefixes

        @ProwideDeprecated(phase4=SRU2023)
@Deprecated
public void setPeferredPrefixes​(java.util.Map<java.lang.String,​java.lang.String> preferredPrefixes)
        Deprecated.
        use setPreferredPrefixes(Map) instead

      • getPreferredPrefixes

        public java.util.Map<java.lang.String,​java.lang.String> getPreferredPrefixes()
        Since:
        9.0.2

      • setPreferredPrefixes

        public void setPreferredPrefixes​(java.util.Map<java.lang.String,​java.lang.String> preferredPrefixes)
        Custom optional prefix configuration, if provided, this prefixes will be used regardless of any other context namespaces and prefix configuration.
        Parameters:
        preferredPrefixes - a map with namespaceURIs as keys and prefixes as values
        Since:
        9.0.2

      • isIncludeXMLDeclaration

        public boolean isIncludeXMLDeclaration()
        Since:
        7.9.3

      • setIncludeXMLDeclaration

        public void setIncludeXMLDeclaration​(boolean includeXMLDeclaration)
        Since:
        7.9.3

      • getRootElement

        public java.lang.String getRootElement()
        Since:
        7.9.3

      • setRootElement

        public void setRootElement​(java.lang.String rootElement)
        Since:
        7.9.3

      • setPreserveQnamePrefixes

        public void setPreserveQnamePrefixes​(boolean preserveQnamePrefixes)
        Since:
        9.0.2