Package com.ctc.wstx.api
Class CommonConfig
java.lang.Object
com.ctc.wstx.api.CommonConfig
- All Implemented Interfaces:
org.codehaus.stax2.XMLStreamProperties
- Direct Known Subclasses:
ReaderConfig
,ValidatorConfig
,WriterConfig
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
FieldsModifier and TypeFieldDescription(package private) static final int
(package private) static final int
(package private) static final int
(package private) static final int
(package private) static final int
protected static final String
protected static final String
This is "major.minor" version used for purposes of determining the feature set.protected boolean
As per [WSTX-277], can specify whether prefix for the "default namespace" is return as null (true) or empty String (false)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
ConstructorsModifierConstructorDescriptionprotected
CommonConfig
(CommonConfig base) Constructor used by sub-classes -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
protected abstract int
findPropertyId
(String propName) protected int
findStdPropertyId
(String propName) static String
Method used to figure out the official implementation name for input/output/validation factories.static String
Method used to figure out the official implementation version for input/output/validation factories.protected abstract Object
getProperty
(int id) getProperty
(String propName) protected Object
getStdProperty
(int id) boolean
isPropertySupported
(String propName) protected void
reportUnknownProperty
(String propName) boolean
final Object
safeGetProperty
(String propName) protected abstract boolean
setProperty
(String propName, int id, Object value) boolean
setProperty
(String propName, Object value) protected boolean
setStdProperty
(String propName, int id, Object value)
-
Field Details
-
IMPL_NAME
- See Also:
-
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:
-
CPROP_IMPL_NAME
static final int CPROP_IMPL_NAME- See Also:
-
CPROP_IMPL_VERSION
static final int CPROP_IMPL_VERSION- See Also:
-
CPROP_SUPPORTS_XML11
static final int CPROP_SUPPORTS_XML11- See Also:
-
CPROP_SUPPORT_XMLID
static final int CPROP_SUPPORT_XMLID- See Also:
-
CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE
static final int CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE- See Also:
-
sStdProperties
Map to use for converting from String property ids to enumeration (ints). Used for faster dispatching. -
mReturnNullForDefaultNamespace
protected boolean mReturnNullForDefaultNamespaceAs per [WSTX-277], can specify whether prefix for the "default namespace" is return as null (true) or empty String (false)
-
-
Constructor Details
-
CommonConfig
Constructor used by sub-classes- Parameters:
base
- Base instance to copy settings from, if any; null for 'root' configuration objects.
-
-
Method Details
-
getProperty
-
isPropertySupported
-
setProperty
- Returns:
- True, if the specified property was successfully set to specified value; false if its value was not changed
-
reportUnknownProperty
-
safeGetProperty
-
getImplName
Method used to figure out the official implementation name for input/output/validation factories. -
getImplVersion
Method used to figure out the official implementation version for input/output/validation factories. -
findPropertyId
- 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
-
setProperty
-
findStdPropertyId
-
setStdProperty
- Parameters:
propName
- Name of standard property to setid
- Internal id matching the namevalue
- Value to set the standard property to
-
getStdProperty
-