Package com.ctc.wstx.api

Class WriterConfig

    • Field Detail

      • mConfigFlags

        protected int mConfigFlags

      • IMPL_VERSION

        protected static final String IMPL_VERSION
        This is "major.minor" version used for purposes of determining the feature set. Patch level is not included, since those should not affect API or feature set. Using applications should be prepared to take additional levels, however, just not depend on those being available.
        See Also:
        Constant Field Values

      • mReturnNullForDefaultNamespace

        protected boolean mReturnNullForDefaultNamespace
        As per [WSTX-277], can specify whether prefix for the "default namespace" is return as null (true) or empty String (false)

    • Method Detail

      • createJ2MEDefaults

        public static WriterConfig createJ2MEDefaults()

      • createFullDefaults

        public static WriterConfig createFullDefaults()

      • findPropertyId

        protected int findPropertyId​(String propName)
        Returns:
        Internal enumerated int matching the String name of the property, if one found: -1 to indicate no match was found.

      • getProperty

        public Object getProperty​(int id)

      • setProperty

        public boolean setProperty​(String name,
                           int id,
                           Object value)
        Returns:
        True, if the specified property was succesfully set to specified value; false if its value was not changed

      • getConfigFlags

        public int getConfigFlags()

      • automaticNamespacesEnabled

        public boolean automaticNamespacesEnabled()

      • automaticEmptyElementsEnabled

        public boolean automaticEmptyElementsEnabled()

      • willAutoCloseOutput

        public boolean willAutoCloseOutput()

      • willSupportNamespaces

        public boolean willSupportNamespaces()

      • willUseDoubleQuotesInXmlDecl

        public boolean willUseDoubleQuotesInXmlDecl()
        Since:
        4.2.2

      • willOutputCDataAsText

        public boolean willOutputCDataAsText()

      • willCopyDefaultAttrs

        public boolean willCopyDefaultAttrs()

      • willEscapeCr

        public boolean willEscapeCr()

      • willAddSpaceAfterEmptyElem

        public boolean willAddSpaceAfterEmptyElem()

      • automaticEndElementsEnabled

        public boolean automaticEndElementsEnabled()

      • willValidateStructure

        public boolean willValidateStructure()

      • willValidateContent

        public boolean willValidateContent()

      • willValidateAttributes

        public boolean willValidateAttributes()

      • willValidateNames

        public boolean willValidateNames()

      • willFixContent

        public boolean willFixContent()

      • getAutomaticNsPrefix

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

      • getProblemReporter

        public XMLReporter getProblemReporter()

      • enableAutomaticNamespaces

        public void enableAutomaticNamespaces​(boolean state)

      • enableAutomaticEmptyElements

        public void enableAutomaticEmptyElements​(boolean state)

      • doAutoCloseOutput

        public void doAutoCloseOutput​(boolean state)

      • doSupportNamespaces

        public void doSupportNamespaces​(boolean state)

      • doUseDoubleQuotesInXmlDecl

        public void doUseDoubleQuotesInXmlDecl​(boolean state)
        Since:
        4.2.2

      • doOutputCDataAsText

        public void doOutputCDataAsText​(boolean state)

      • doCopyDefaultAttrs

        public void doCopyDefaultAttrs​(boolean state)

      • doEscapeCr

        public void doEscapeCr​(boolean state)

      • doAddSpaceAfterEmptyElem

        public void doAddSpaceAfterEmptyElem​(boolean state)

      • enableAutomaticEndElements

        public void enableAutomaticEndElements​(boolean state)

      • doValidateStructure

        public void doValidateStructure​(boolean state)

      • doValidateContent

        public void doValidateContent​(boolean state)

      • doValidateAttributes

        public void doValidateAttributes​(boolean state)

      • doValidateNames

        public void doValidateNames​(boolean state)

      • doFixContent

        public void doFixContent​(boolean state)

      • setAutomaticNsPrefix

        public void setAutomaticNsPrefix​(String prefix)
        Parameters:
        prefix - Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak).

      • setProblemReporter

        public void setProblemReporter​(XMLReporter rep)

      • configureForXmlConformance

        public void configureForXmlConformance()
        For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity.

      • configureForRobustness

        public void configureForRobustness()
        For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity, and also enables all matching "fix-me" properties (currently only content-fixing property exists).

      • configureForSpeed

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

      • allocMediumCBuffer

        public char[] allocMediumCBuffer​(int minSize)
        Method called to allocate intermediate recyclable copy buffers

      • 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)

      • getProperty

        public Object getProperty​(String propName)

      • isPropertySupported

        public boolean isPropertySupported​(String propName)

      • setProperty

        public boolean setProperty​(String propName,
                           Object value)
        Returns:
        True, if the specified property was successfully set to specified value; false if its value was not changed

      • reportUnknownProperty

        protected void reportUnknownProperty​(String propName)

      • safeGetProperty

        public final Object safeGetProperty​(String propName)

      • getImplName

        public static String getImplName()
        Method used to figure out the official implementation name for input/output/validation factories.

      • getImplVersion

        public static String getImplVersion()
        Method used to figure out the official implementation version for input/output/validation factories.

      • doesSupportXml11

        public boolean doesSupportXml11()

      • doesSupportXmlId

        public boolean doesSupportXmlId()

      • returnNullForDefaultNamespace

        public boolean returnNullForDefaultNamespace()

      • findStdPropertyId

        protected int findStdPropertyId​(String propName)

      • setStdProperty

        protected boolean setStdProperty​(String propName,
                                 int id,
                                 Object value)
        Parameters:
        propName - Name of standard property to set
        id - Internal id matching the name
        value - Value to set the standard property to

      • getStdProperty

        protected Object getStdProperty​(int id)