Package com.fasterxml.aalto.impl
Class CommonConfig
java.lang.Object
com.fasterxml.aalto.impl.CommonConfig
- Direct Known Subclasses:
ReaderConfig
,WriterConfig
Base class for reader and writer-side configuration/context objects
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
Bitset that indicates all explicit changes to on/off values; clear bits indicate settings that are unmodified default values.protected int
Bitset for all on/off values for this configuration object.protected static final String
protected static final String
This is "major.minor" version used for purposes of determining the feature set.(package private) static final int
(package private) static final int
(package private) static final int
(package private) static final int
Map to use for converting from String property ids to enumeration (ints). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract String
abstract String
This method returns name of encoding that has been passed explicitly to the reader or writer, from outside.getProperty
(String propName, boolean isMandatory) protected final boolean
hasExplicitFlag
(int flagMask) protected final boolean
hasFlag
(int flagMask) protected final boolean
hasFlagBeenModified
(int flagMask) Method for checking whether specific configuration flag has been explicitly modified (set, clear; regardless of whether state actually changed), or is it the default value.boolean
isPropertySupported
(String propName) abstract boolean
isXml11()
protected final void
setFlag
(int flagMask, boolean state) boolean
setProperty
(String propName, 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:
-
PROP_IMPL_NAME
static final int PROP_IMPL_NAME- See Also:
-
PROP_IMPL_VERSION
static final int PROP_IMPL_VERSION- See Also:
-
PROP_SUPPORTS_XML11
static final int PROP_SUPPORTS_XML11- See Also:
-
PROP_SUPPORTS_XMLID
static final int PROP_SUPPORTS_XMLID- See Also:
-
sStdProperties
Map to use for converting from String property ids to enumeration (ints). Used for faster dispatching. -
_flags
protected int _flagsBitset for all on/off values for this configuration object. -
_flagMods
protected int _flagModsBitset that indicates all explicit changes to on/off values; clear bits indicate settings that are unmodified default values.
-
-
Constructor Details
-
CommonConfig
protected CommonConfig(int flags, int flagMods)
-
-
Method Details
-
getProperty
- Parameters:
isMandatory
- If true, unrecognized property should result inIllegalArgumentException
-
isPropertySupported
-
setProperty
- Returns:
- True, if the specified property was succesfully set to specified value; false if its value was not changed
-
getExternalEncoding
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]- Returns:
- Encoding that has been passed externally by the application
-
getActualEncoding
- Returns:
- Actual encoding in use, as determined by the processor.
-
isXml11
public abstract boolean isXml11()- Returns:
- True, if the processing will be done according to Xml 1.1 rules; false if according to xml 1.0
-
hasFlag
protected final boolean hasFlag(int flagMask) -
hasExplicitFlag
protected final boolean hasExplicitFlag(int flagMask) -
setFlag
protected final void setFlag(int flagMask, boolean state) -
hasFlagBeenModified
protected final boolean hasFlagBeenModified(int flagMask) Method for checking whether specific configuration flag has been explicitly modified (set, clear; regardless of whether state actually changed), or is it the default value.- Returns:
- False, if flag in question has its default value, true if a call has been made that could have changed it.
-