Class XmlFactory

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.Versioned, Serializable

    public class XmlFactory
    extends com.fasterxml.jackson.core.JsonFactory
    Factory used for constructing FromXmlParser and ToXmlGenerator instances.

    Implements JsonFactory since interface for constructing XML backed parsers and generators is quite similar to dealing with JSON.

    Author:
    Tatu Saloranta (tatu.saloranta@iki.fi)
    See Also:
    Serialized Form
    • Field Detail

      • _xmlParserFeatures

        protected int _xmlParserFeatures
      • _xmlGeneratorFeatures

        protected int _xmlGeneratorFeatures
      • _cfgNameForTextElement

        protected String _cfgNameForTextElement
      • _jdkXmlInFactory

        protected transient String _jdkXmlInFactory
        Hiding place for JDK-serialization unthawed factories...
      • _jdkXmlOutFactory

        protected transient String _jdkXmlOutFactory
        Hiding place for JDK-serialization unthawed factories...
    • Constructor Detail

      • XmlFactory

        public XmlFactory()
        Default constructor used to create factory instances. Creation of a factory instance is a light-weight operation, but it is still a good idea to reuse limited number of factory instances (and quite often just a single instance): factories are used as context for storing some reused processing objects (such as symbol tables parsers use) and this reuse only works within context of a single factory instance.
      • XmlFactory

        public XmlFactory​(com.fasterxml.jackson.core.ObjectCodec oc)
      • XmlFactory

        protected XmlFactory​(com.fasterxml.jackson.core.ObjectCodec oc,
                             int xpFeatures,
                             int xgFeatures,
                             XMLInputFactory xmlIn,
                             XMLOutputFactory xmlOut,
                             String nameForTextElem)
      • XmlFactory

        protected XmlFactory​(XmlFactory src,
                             com.fasterxml.jackson.core.ObjectCodec oc)
        Since:
        2.2.1
    • Method Detail

      • copy

        public XmlFactory copy()
        Note: compared to base implementation by JsonFactory, here the copy will actually share underlying XML input and output factories, as there is no way to make copies of those.
        Overrides:
        copy in class com.fasterxml.jackson.core.JsonFactory
        Since:
        2.1
      • version

        public com.fasterxml.jackson.core.Version version()
        Specified by:
        version in interface com.fasterxml.jackson.core.Versioned
        Overrides:
        version in class com.fasterxml.jackson.core.JsonFactory
      • readResolve

        protected Object readResolve()
        Method that we need to override to actually make restoration go through constructors etc.
        Overrides:
        readResolve in class com.fasterxml.jackson.core.JsonFactory
      • setXMLTextElementName

        public void setXMLTextElementName​(String name)
        Since:
        2.1
      • getXMLTextElementName

        public String getXMLTextElementName()
        Since:
        2.2
      • configure

        public final XmlFactory configure​(FromXmlParser.Feature f,
                                          boolean state)
        Method for enabling or disabling specified XML parser feature.
      • isEnabled

        public final boolean isEnabled​(FromXmlParser.Feature f)
        Checked whether specified XML parser feature is enabled.
      • isEnabled

        public final boolean isEnabled​(ToXmlGenerator.Feature f)
        Check whether specified XML generator feature is enabled.
      • getXMLInputFactory

        public XMLInputFactory getXMLInputFactory()
        Since:
        2.4
      • setXMLInputFactory

        public void setXMLInputFactory​(XMLInputFactory f)
      • getXMLOutputFactory

        public XMLOutputFactory getXMLOutputFactory()
        Since:
        2.4
      • getFormatName

        public String getFormatName()
        Method that returns short textual id identifying format this factory supports.

        Note: sub-classes should override this method; default implementation will return null for all sub-classes

        Overrides:
        getFormatName in class com.fasterxml.jackson.core.JsonFactory
      • hasFormat

        public com.fasterxml.jackson.core.format.MatchStrength hasFormat​(com.fasterxml.jackson.core.format.InputAccessor acc)
                                                                  throws IOException
        Overrides:
        hasFormat in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • requiresCustomCodec

        public boolean requiresCustomCodec()
        XML format does require support from custom ObjectCodec (that is, XmlMapper), so need to return true here.
        Overrides:
        requiresCustomCodec in class com.fasterxml.jackson.core.JsonFactory
        Returns:
        True since XML format does require support from codec
      • canUseCharArrays

        public boolean canUseCharArrays()
        As of 2.4, we do have actual capability for passing char arrays efficiently, but unfortunately have no working mechanism for recycling buffers. So we have to admit that can not make efficient use.
        Overrides:
        canUseCharArrays in class com.fasterxml.jackson.core.JsonFactory
      • getFormatReadFeatureType

        public Class<FromXmlParser.Feature> getFormatReadFeatureType()
        Overrides:
        getFormatReadFeatureType in class com.fasterxml.jackson.core.JsonFactory
      • getFormatWriteFeatureType

        public Class<ToXmlGenerator.Feature> getFormatWriteFeatureType()
        Overrides:
        getFormatWriteFeatureType in class com.fasterxml.jackson.core.JsonFactory
      • createParser

        public com.fasterxml.jackson.core.JsonParser createParser​(String content)
                                                           throws IOException
        Overridden just to prevent trying to optimize access via char array; while nice idea, problem is that we don't have proper hooks to ensure that temporary buffer gets recycled; so let's just use StringReader.
        Overrides:
        createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • createGenerator

        public ToXmlGenerator createGenerator​(OutputStream out,
                                              com.fasterxml.jackson.core.JsonEncoding enc)
                                       throws IOException
        Overrides:
        createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • createGenerator

        public ToXmlGenerator createGenerator​(File f,
                                              com.fasterxml.jackson.core.JsonEncoding enc)
                                       throws IOException
        Overrides:
        createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • _createParser

        protected FromXmlParser _createParser​(InputStream in,
                                              com.fasterxml.jackson.core.io.IOContext ctxt)
                                       throws IOException
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • _createParser

        protected FromXmlParser _createParser​(Reader r,
                                              com.fasterxml.jackson.core.io.IOContext ctxt)
                                       throws IOException
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • _createParser

        protected FromXmlParser _createParser​(char[] data,
                                              int offset,
                                              int len,
                                              com.fasterxml.jackson.core.io.IOContext ctxt,
                                              boolean recycleBuffer)
                                       throws IOException
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • _createParser

        protected FromXmlParser _createParser​(byte[] data,
                                              int offset,
                                              int len,
                                              com.fasterxml.jackson.core.io.IOContext ctxt)
                                       throws IOException
        Overrides:
        _createParser in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • _createGenerator

        protected com.fasterxml.jackson.core.JsonGenerator _createGenerator​(Writer out,
                                                                            com.fasterxml.jackson.core.io.IOContext ctxt)
                                                                     throws IOException
        Overrides:
        _createGenerator in class com.fasterxml.jackson.core.JsonFactory
        Throws:
        IOException
      • hasXMLFormat

        public static com.fasterxml.jackson.core.format.MatchStrength hasXMLFormat​(com.fasterxml.jackson.core.format.InputAccessor acc)
                                                                            throws IOException
        Method that tries to figure out if content seems to be in some kind of XML format. Note that implementation here is not nearly as robust as what underlying Stax parser will do; the idea is to first support common encodings, then expand as needed (for example, it is not all that hard to support UTF-16; but it is some work and not needed quite yet)
        Throws:
        IOException