Package com.fasterxml.aalto.out

Class WriterConfig

  • public final class WriterConfig
extends CommonConfig
    This is the shared configuration object passed by the factory to writer.

    • Field Detail

      • DEFAULT_AUTOMATIC_NS_PREFIX

        protected static final java.lang.String DEFAULT_AUTOMATIC_NS_PREFIX
        See Also:
        Constant Field Values

      • sProperties

        private static final java.util.HashMap<java.lang.String,​java.lang.Integer> sProperties

      • _propAutoNsPrefix

        private java.lang.String _propAutoNsPrefix

      • _encodingContext

        private final WriterConfig.EncodingContext _encodingContext
        A single encoding context instance is shared between all WriterConfig instances created for readers by an output factory. It is used for sharing symbol tables.

      • _encoding

        private java.lang.String _encoding
        Encoding passed in either during construction, or via xml declaration write.

      • mRecyclerRef

        static final java.lang.ThreadLocal<java.lang.ref.SoftReference<BufferRecycler>> mRecyclerRef
        This ThreadLocal contains a SoftRerefence to a BufferRecycler used to provide a low-cost buffer recycling between Reader instances.

      • _currRecycler

        BufferRecycler _currRecycler
        This is the actually container of the recyclable buffers. It is obtained via ThreadLocal/SoftReference combination, if one exists, when Config instance is created. If one does not exist, it will created first time a buffer is returned.

    • Constructor Detail

      • WriterConfig

        private WriterConfig​(java.lang.String encoding,
                     int flags,
                     int flagMods,
                     WriterConfig.EncodingContext encCtxt,
                     java.lang.String autoNsPrefix)

      • WriterConfig

        public WriterConfig()

    • Method Detail

      • setActualEncodingIfNotSet

        public void setActualEncodingIfNotSet​(java.lang.String enc)

      • doAutoCloseOutput

        public void doAutoCloseOutput​(boolean state)

      • enableXml11

        public void enableXml11()

      • isXml11

        public boolean isXml11()
        Specified by:
        isXml11 in class CommonConfig
        Returns:
        True, if the processing will be done according to Xml 1.1 rules; false if according to xml 1.0

      • getExternalEncoding

        public java.lang.String getExternalEncoding()
        Description copied from class: CommonConfig
        This method returns name of encoding that has been passed explicitly to the reader or writer, from outside. An example is that HTTP server may pass encoding as declared in HTTP headers. This should either be null (if none passed), or the same as actual encoding (which is determined from physical stream contents [for readers], or from encoder properties / configuration [for writers]
        Specified by:
        getExternalEncoding in class CommonConfig
        Returns:
        Encoding that has been passed externally by the application

      • getActualEncoding

        public java.lang.String getActualEncoding()
        Specified by:
        getActualEncoding in class CommonConfig
        Returns:
        Actual encoding in use, as determined by the processor.

      • getPreferredEncoding

        public java.lang.String getPreferredEncoding()

      • getProperty

        public java.lang.Object getProperty​(java.lang.String name,
                                    boolean isMandatory)
        Overrides:
        getProperty in class CommonConfig
        isMandatory - If true, unrecognized property should result in IllegalArgumentException

      • setProperty

        public boolean setProperty​(java.lang.String name,
                           java.lang.Object value)
        Overrides:
        setProperty in class CommonConfig
        Returns:
        True, if the specified property was succesfully set to specified value; false if its value was not changed

      • willRepairNamespaces

        public boolean willRepairNamespaces()

      • isNamespaceAware

        public boolean isNamespaceAware()

      • willAutoCloseOutput

        public boolean willAutoCloseOutput()

      • getAutomaticNsPrefix

        public java.lang.String getAutomaticNsPrefix()
        Returns:
        Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "axns".

      • configureForXmlConformance

        public void configureForXmlConformance()

      • configureForRobustness

        public void configureForRobustness()

      • configureForSpeed

        public void configureForSpeed()
        For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.

      • willCheckStructure

        public boolean willCheckStructure()

      • willCheckContent

        public boolean willCheckContent()

      • willCheckNames

        public boolean willCheckNames()

      • willCheckAttributes

        public boolean willCheckAttributes()

      • willFixContent

        public boolean willFixContent()

      • willEscapeCR

        public boolean willEscapeCR()

      • allocMediumCBuffer

        public char[] allocMediumCBuffer​(int minSize)

      • freeMediumCBuffer

        public void freeMediumCBuffer​(char[] buffer)

      • allocFullCBuffer

        public char[] allocFullCBuffer​(int minSize)

      • freeFullCBuffer

        public void freeFullCBuffer​(char[] buffer)

      • allocFullBBuffer

        public byte[] allocFullBBuffer​(int minSize)

      • freeFullBBuffer

        public void freeFullBBuffer​(byte[] buffer)