Package com.ctc.wstx.api

Class CommonConfig

  • All Implemented Interfaces:
    org.codehaus.stax2.XMLStreamProperties
    Direct Known Subclasses:
    ReaderConfig, ValidatorConfig, WriterConfig
    abstract class CommonConfig
extends java.lang.Object
implements org.codehaus.stax2.XMLStreamProperties
    Shared common base class for variour configuration container implementations for public factories Woodstox uses: implementations of XMLInputFactory, XMLOutputFactory and XMLValidationSchemaFactory. Implements basic settings for some shared settings, defined by the shared property interface XMLStreamProperties.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) static int CPROP_IMPL_NAME  
      (package private) static int CPROP_IMPL_VERSION  
      (package private) static int CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE  
      (package private) static int CPROP_SUPPORT_XMLID  
      (package private) static int CPROP_SUPPORTS_XML11  
      protected static java.lang.String IMPL_NAME  
      protected static java.lang.String IMPL_VERSION
      This is "major.minor" version used for purposes of determining the feature set.
      protected boolean mReturnNullForDefaultNamespace
      As per [WSTX-277], can specify whether prefix for the "default namespace" is return as null (true) or empty String (false)
      (package private) static java.util.HashMap<java.lang.String,​java.lang.Integer> sStdProperties
      Map to use for converting from String property ids to enumeration (ints).

      • Fields inherited from interface org.codehaus.stax2.XMLStreamProperties

        XSP_IMPLEMENTATION_NAME, XSP_IMPLEMENTATION_VERSION, XSP_NAMESPACE_AWARE, XSP_PROBLEM_REPORTER, XSP_SUPPORT_XMLID, XSP_SUPPORTS_XML11, XSP_V_XMLID_FULL, XSP_V_XMLID_NONE, XSP_V_XMLID_TYPING

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected CommonConfig​(CommonConfig base)
      Constructor used by sub-classes

    • Field Detail

      • IMPL_VERSION

        protected static final java.lang.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

      • CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE

        static final int CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE
        See Also:
        Constant Field Values

      • sStdProperties

        static final java.util.HashMap<java.lang.String,​java.lang.Integer> sStdProperties
        Map to use for converting from String property ids to enumeration (ints). Used for faster dispatching.

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

    • Constructor Detail

      • CommonConfig

        protected CommonConfig​(CommonConfig base)
        Constructor used by sub-classes
        Parameters:
        base - Base instance to copy settings from, if any; null for 'root' configuration objects.

    • Method Detail

      • getProperty

        public java.lang.Object getProperty​(java.lang.String propName)

      • isPropertySupported

        public boolean isPropertySupported​(java.lang.String propName)

      • setProperty

        public boolean setProperty​(java.lang.String propName,
                           java.lang.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​(java.lang.String propName)

      • safeGetProperty

        public final java.lang.Object safeGetProperty​(java.lang.String propName)

      • getImplName

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

      • getImplVersion

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

      • findPropertyId

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

      • doesSupportXml11

        public boolean doesSupportXml11()

      • doesSupportXmlId

        public boolean doesSupportXmlId()

      • returnNullForDefaultNamespace

        public boolean returnNullForDefaultNamespace()

      • getProperty

        protected abstract java.lang.Object getProperty​(int id)

      • setProperty

        protected abstract boolean setProperty​(java.lang.String propName,
                                       int id,
                                       java.lang.Object value)

      • findStdPropertyId

        protected int findStdPropertyId​(java.lang.String propName)

      • setStdProperty

        protected boolean setStdProperty​(java.lang.String propName,
                                 int id,
                                 java.lang.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 java.lang.Object getStdProperty​(int id)