Interface StAXDialect

    • Method Detail

      • getName

        String getName()
        Get the name of this dialect.
        Returns:
        the name of the dialect
      • enableCDataReporting

        XMLInputFactory enableCDataReporting​(XMLInputFactory factory)
        Configure the given factory to enable reporting of CDATA sections by stream readers created from it. The example in the documentation of the XMLStreamReader.next() method suggests that even if the parser is non coalescing, CDATA sections should be reported as CHARACTERS events. Some implementations strictly follow the example, while for others it is sufficient to make the parser non coalescing.
        Parameters:
        factory - the factory to configure; this may be an already normalized factory or a "raw" factory object
        Returns:
        the factory with CDATA reporting enabled; this may be the original factory instance or a wrapper
        Throws:
        UnsupportedOperationException - if reporting of CDATA sections is not supported
      • disallowDoctypeDecl

        XMLInputFactory disallowDoctypeDecl​(XMLInputFactory factory)
        Configure the given factory to disallow DOCTYPE declarations. The effect of this is similar to the http://apache.org/xml/features/disallow-doctype-decl feature in Xerces. The factory instance returned by this method MUST satisfy the following requirements:
        • The factory or the reader implementation MUST throw an exception when requested to parse a document containing a DOCTYPE declaration. If the exception is not thrown by the factory, it MUST be thrown by the reader before the first XMLStreamConstants.START_ELEMENT event.
        • The parser MUST NOT attempt to load the external DTD subset or any other external entity.
        • The parser MUST protect itself against denial of service attacks based on deeply nested entity definitions present in the internal DTD subset. Ideally, the parser SHOULD NOT process the internal subset at all and throw an exception immediately when encountering the DOCTYPE declaration.
        This method is typically useful in the context of SOAP processing since a SOAP message must not contain a Document Type Declaration.
        Parameters:
        factory - the factory to configure; this may be an already normalized factory or a "raw" factory object
        Returns:
        the factory that disallows DOCTYPE declarations; this may be the original factory instance or a wrapper
      • makeThreadSafe

        XMLOutputFactory makeThreadSafe​(XMLOutputFactory factory)
        Deprecated.
        Make an XMLOutputFactory object thread safe. The implementation may do this either by configuring the factory or by creating a thread safe wrapper. The returned factory must be thread safe for all method calls that don't change the (visible) state, i.e. the properties, of the factory.
        Parameters:
        factory - the factory to make thread safe
        Returns:
        the thread safe factory
      • normalize

        XMLInputFactory normalize​(XMLInputFactory factory)
        Normalize an XMLInputFactory. This will make sure that the readers created from the factory conform to the StAX specifications.
        Parameters:
        factory - the factory to normalize
        Returns:
        the normalized factory
      • normalize

        XMLOutputFactory normalize​(XMLOutputFactory factory)
        Deprecated.
        Normalize an XMLOutputFactory. This will make sure that the writers created from the factory conform to the StAX specifications.
        Parameters:
        factory - the factory to normalize
        Returns:
        the normalized factory