Class ReaderConfig
- All Implemented Interfaces:
InputConfigFlags
,org.codehaus.stax2.XMLStreamProperties
In addition to its main task as a configuration container, this class also acts as a wrapper around simple buffer recycling functionality. The reason is that while conceptually this is a separate concern, there are enough commonalities with the life-cycle of this object to make this a very convenience place to add that functionality... (that is: conceptually this is not right, but from pragmatic viewpoint it just makes sense)
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final int
Default config flags are converted from individual settings, to conform to StAX 1.0 specifications.(package private) static final int
For now defaults for J2ME flags can be identical to 'full' set; differences are in buffer sizes.static final int
static final int
static final int
static final int
static final int
(package private) static final int
By default, let's require minimum of 64 chars to be delivered as shortest partial (piece of) text (CDATA, text) segment; same for both J2ME subset and full readers.(package private) static final int
(package private) static final int
Let's allow caching of just a dozen DTDs...protected URL
Base URL to use as the resolution context for relative entity referencesprotected int
Bitset that indicates explicit changes tomConfigFlags
through calls; empty bit means that the corresponding property has its default value, set bit that an explicit call has been made.protected int
Bitset that contains state of on/off properties; initialized to defaults, but can be set/cleared.(package private) BufferRecycler
This is the actually container of the recyclable buffers.(package private) XMLResolver
(package private) XMLResolver
(package private) static final int
Need to set a minimum size, since there are some limitations to smallest consequtive block that can be used.protected int
protected final boolean
protected int
protected int
protected long
protected int
protected long
protected int
protected long
protected int
protected int
protected int
protected WstxInputProperties.ParsingMode
Parsing mode can be changed from the default xml compliant behavior to one of alternate modes (fragment processing, multiple document processing).(package private) static final ThreadLocal
<SoftReference<BufferRecycler>> ThisThreadLocal
contains ainvalid reference
SoftRerefence
BufferRecycler
used to provide a low-cost buffer recycling between Reader instances.(package private) XMLReporter
(package private) Object[]
protected final SymbolTable
protected boolean
This boolean flag is set if the input document requires xml 1.1 (or above) compliant processing: default is xml 1.0 compliant.(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
(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
static final int
(package private) static final int
(package private) static final int
(package private) static final int
(package private) static final int
13-Nov-2008, tatus: Need to be able to keep track of whether name-interning has been explicitly enabled/disable or not (not if it's whatever defaults we have)(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
(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
(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
(package private) static final int
Note: this entry was deprecated for 4.0 versions up until and including 4.0.7; was brought back for 4.0.8 (and will be retained for 4.1)(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
(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
(package private) static final int
(package private) static final int
(package private) static final int
private static final int
private static final int
private static final int
private static final int
private static final int
Map to use for converting from String property ids to ints described above; useful to allow use of switch later on.Fields inherited from class com.ctc.wstx.api.CommonConfig
CPROP_IMPL_NAME, CPROP_IMPL_VERSION, CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE, CPROP_SUPPORT_XMLID, CPROP_SUPPORTS_XML11, IMPL_NAME, IMPL_VERSION, mReturnNullForDefaultNamespace, sStdProperties
Fields inherited from interface com.ctc.wstx.cfg.InputConfigFlags
CFG_ALLOW_XML11_ESCAPED_CHARS_IN_XML10, CFG_AUTO_CLOSE_INPUT, CFG_CACHE_DTDS, CFG_CACHE_DTDS_BY_PUBLIC_ID, CFG_COALESCE_TEXT, CFG_INTERN_NAMES, CFG_INTERN_NS_URIS, CFG_JAXP_FEATURE_SECURE_PROCESSING, CFG_LAZY_PARSING, CFG_NAMESPACE_AWARE, CFG_NORMALIZE_LFS, CFG_PRESERVE_LOCATION, CFG_REPLACE_ENTITY_REFS, CFG_REPORT_CDATA, CFG_REPORT_PROLOG_WS, CFG_SUPPORT_DTD, CFG_SUPPORT_DTDPP, CFG_SUPPORT_EXTERNAL_ENTITIES, CFG_TREAT_CHAR_REFS_AS_ENTS, CFG_VALIDATE_AGAINST_DTD, CFG_XMLID_TYPING, CFG_XMLID_UNIQ_CHECKS
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
ConstructorsModifierConstructorDescriptionprivate
ReaderConfig
(ReaderConfig base, boolean j2meSubset, SymbolTable symbols, int configFlags, int configFlagMods, int inputBufLen, int minTextSegmentLen) -
Method Summary
Modifier and TypeMethodDescriptionprivate final Object
_getSpecialProperty
(int ix) protected boolean
_hasConfigFlag
(int flag) protected boolean
_hasExplicitConfigFlag
(int flag) Method similar to_hasConfigFlag(int)
, but that will only return true if in addition to being set, flag has been explicitly modified (i.e.private final void
_setSpecialProperty
(int ix, Object value) byte[]
allocFullBBuffer
(int minSize) char[]
allocFullCBuffer
(int minSize) char[]
allocMediumCBuffer
(int minSize) char[]
allocSmallCBuffer
(int minSize) void
clearConfigFlag
(int flag) void
Method to call to make Reader created be as "convenient" to use as possible; ie try to avoid having to deal with some of things like segmented text chunks.void
Method to call to minimize the memory usage of the stream/event reader; both regarding Objects created, and the temporary memory usage during parsing.void
Method to call to make Reader try to preserve as much of input formatting as possible, so that round-tripping would be as lossless as possible.void
Method to call to make the Reader created be as fast as possible reading documents, especially for long-running processes where caching is likely to help.void
Method to call to make Reader created conform as closely to XML standard as possible, doing all checks and transformations mandated (linefeed conversions, attr value normalizations).static ReaderConfig
static ReaderConfig
private BufferRecycler
void
doAllowXml11EscapedCharsInXml10
(boolean state) void
doAutoCloseInput
(boolean state) void
doCacheDTDs
(boolean state) void
doCacheDTDsByPublicId
(boolean state) void
doCoalesceText
(boolean state) void
doInternNames
(boolean state) void
doInternNsURIs
(boolean state) void
doNormalizeLFs
(boolean state) void
doParseLazily
(boolean state) void
doPreserveLocation
(boolean state) void
doProcessSecurely
(boolean value) Method called when {code XMLConstants.FEATURE_SECURE_PROCESSING} is being enabled or disabled.void
doReplaceEntityRefs
(boolean state) void
doReportCData
(boolean state) void
doReportPrologWhitespace
(boolean state) void
doSupportDTDPP
(boolean state) void
doSupportDTDs
(boolean state) void
doSupportExternalEntities
(boolean state) void
doSupportNamespaces
(boolean state) void
doTreatCharRefsAsEnts
(boolean state) void
doValidateWithDTD
(boolean state) void
doXmlIdTyping
(boolean state) void
doXmlIdUniqChecks
(boolean state) void
enableXml11
(boolean state) Method called to enable or disable 1.1 compliant processing; if disabled, defaults to xml 1.0 compliant processing.protected int
findPropertyId
(String propName) void
freeFullBBuffer
(byte[] buffer) void
freeFullCBuffer
(char[] buffer) void
freeMediumCBuffer
(char[] buffer) void
freeSmallCBuffer
(char[] buffer) int
int
In future this property could/should be made configurable?org.codehaus.stax2.validation.DTDValidationSchema
int
int
int
long
int
long
int
long
int
long
getProperty
(int id) int
boolean
Special accessor to use to verify whether name interning has explicitly been enabled; true if call was been made to set it to true; false otherwise (default, or set to false)boolean
boolean
boolean
boolean
isXml11()
void
Unlike name suggests there is also some limited state information associated with the config object.void
setBaseURL
(URL baseURL) void
setConfigFlag
(int flag) private void
setConfigFlag
(int flag, boolean state) void
void
void
setDTDOverride
(org.codehaus.stax2.validation.DTDValidationSchema schema) void
void
void
setInputBufferLength
(int value) void
void
setMaxAttributeSize
(int value) void
setMaxAttributesPerElement
(int value) void
setMaxCharacters
(long value) void
setMaxChildrenPerElement
(int value) void
setMaxElementCount
(long value) void
setMaxElementDepth
(int value) void
setMaxEntityCount
(long value) void
setMaxEntityDepth
(int value) void
setMaxTextLength
(int value) boolean
setProperty
(String propName, int id, Object value) void
setShortestReportedTextSegment
(int value) void
void
void
Note: for better granularity, you should callsetEntityResolver(javax.xml.stream.XMLResolver)
andsetDtdResolver(javax.xml.stream.XMLResolver)
instead.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
Methods inherited from class com.ctc.wstx.api.CommonConfig
doesSupportXml11, doesSupportXmlId, findStdPropertyId, getImplName, getImplVersion, getProperty, getStdProperty, isPropertySupported, reportUnknownProperty, returnNullForDefaultNamespace, safeGetProperty, setProperty, setStdProperty
-
Field Details
-
DEFAULT_MAX_ATTRIBUTES_PER_ELEMENT
public static final int DEFAULT_MAX_ATTRIBUTES_PER_ELEMENT- See Also:
-
DEFAULT_MAX_ATTRIBUTE_LENGTH
public static final int DEFAULT_MAX_ATTRIBUTE_LENGTH- See Also:
-
DEFAULT_MAX_ELEMENT_DEPTH
public static final int DEFAULT_MAX_ELEMENT_DEPTH- See Also:
-
DEFAULT_MAX_ENTITY_DEPTH
public static final int DEFAULT_MAX_ENTITY_DEPTH- See Also:
-
DEFAULT_MAX_ENTITY_COUNT
public static final int DEFAULT_MAX_ENTITY_COUNT- See Also:
-
PROP_COALESCE_TEXT
static final int PROP_COALESCE_TEXT- See Also:
-
PROP_NAMESPACE_AWARE
static final int PROP_NAMESPACE_AWARE- See Also:
-
PROP_REPLACE_ENTITY_REFS
static final int PROP_REPLACE_ENTITY_REFS- See Also:
-
PROP_SUPPORT_EXTERNAL_ENTITIES
static final int PROP_SUPPORT_EXTERNAL_ENTITIES- See Also:
-
PROP_VALIDATE_AGAINST_DTD
static final int PROP_VALIDATE_AGAINST_DTD- See Also:
-
PROP_SUPPORT_DTD
static final int PROP_SUPPORT_DTD- See Also:
-
PROP_EVENT_ALLOCATOR
public static final int PROP_EVENT_ALLOCATOR- See Also:
-
PROP_WARNING_REPORTER
static final int PROP_WARNING_REPORTER- See Also:
-
PROP_XML_RESOLVER
static final int PROP_XML_RESOLVER- See Also:
-
PROP_INTERN_NS_URIS
static final int PROP_INTERN_NS_URIS- See Also:
-
PROP_INTERN_NAMES
static final int PROP_INTERN_NAMES- See Also:
-
PROP_REPORT_CDATA
static final int PROP_REPORT_CDATA- See Also:
-
PROP_REPORT_PROLOG_WS
static final int PROP_REPORT_PROLOG_WS- See Also:
-
PROP_PRESERVE_LOCATION
static final int PROP_PRESERVE_LOCATION- See Also:
-
PROP_AUTO_CLOSE_INPUT
static final int PROP_AUTO_CLOSE_INPUT- See Also:
-
PROP_SUPPORT_XMLID
static final int PROP_SUPPORT_XMLID- See Also:
-
PROP_DTD_OVERRIDE
static final int PROP_DTD_OVERRIDE- See Also:
-
PROP_JAXP_SECURE_PROCESSING
static final int PROP_JAXP_SECURE_PROCESSING- See Also:
-
PROP_NORMALIZE_LFS
static final int PROP_NORMALIZE_LFSNote: this entry was deprecated for 4.0 versions up until and including 4.0.7; was brought back for 4.0.8 (and will be retained for 4.1)- See Also:
-
PROP_CACHE_DTDS
static final int PROP_CACHE_DTDS- See Also:
-
PROP_CACHE_DTDS_BY_PUBLIC_ID
static final int PROP_CACHE_DTDS_BY_PUBLIC_ID- See Also:
-
PROP_LAZY_PARSING
static final int PROP_LAZY_PARSING- See Also:
-
PROP_SUPPORT_DTDPP
static final int PROP_SUPPORT_DTDPP- See Also:
-
PROP_TREAT_CHAR_REFS_AS_ENTS
static final int PROP_TREAT_CHAR_REFS_AS_ENTS- See Also:
-
PROP_ALLOW_XML11_ESCAPED_CHARS_IN_XML10
static final int PROP_ALLOW_XML11_ESCAPED_CHARS_IN_XML10- Since:
- 5.2
- See Also:
-
PROP_INPUT_BUFFER_LENGTH
static final int PROP_INPUT_BUFFER_LENGTH- See Also:
-
PROP_MIN_TEXT_SEGMENT
static final int PROP_MIN_TEXT_SEGMENT- See Also:
-
PROP_CUSTOM_INTERNAL_ENTITIES
static final int PROP_CUSTOM_INTERNAL_ENTITIES- See Also:
-
PROP_DTD_RESOLVER
static final int PROP_DTD_RESOLVER- See Also:
-
PROP_ENTITY_RESOLVER
static final int PROP_ENTITY_RESOLVER- See Also:
-
PROP_UNDECLARED_ENTITY_RESOLVER
static final int PROP_UNDECLARED_ENTITY_RESOLVER- See Also:
-
PROP_BASE_URL
static final int PROP_BASE_URL- See Also:
-
PROP_INPUT_PARSING_MODE
static final int PROP_INPUT_PARSING_MODE- See Also:
-
PROP_MAX_ATTRIBUTES_PER_ELEMENT
static final int PROP_MAX_ATTRIBUTES_PER_ELEMENT- See Also:
-
PROP_MAX_CHILDREN_PER_ELEMENT
static final int PROP_MAX_CHILDREN_PER_ELEMENT- See Also:
-
PROP_MAX_ELEMENT_COUNT
static final int PROP_MAX_ELEMENT_COUNT- See Also:
-
PROP_MAX_ELEMENT_DEPTH
static final int PROP_MAX_ELEMENT_DEPTH- See Also:
-
PROP_MAX_CHARACTERS
static final int PROP_MAX_CHARACTERS- See Also:
-
PROP_MAX_ATTRIBUTE_SIZE
static final int PROP_MAX_ATTRIBUTE_SIZE- See Also:
-
PROP_MAX_TEXT_LENGTH
static final int PROP_MAX_TEXT_LENGTH- See Also:
-
PROP_MAX_ENTITY_COUNT
static final int PROP_MAX_ENTITY_COUNT- See Also:
-
PROP_MAX_ENTITY_DEPTH
static final int PROP_MAX_ENTITY_DEPTH- See Also:
-
MIN_INPUT_BUFFER_LENGTH
static final int MIN_INPUT_BUFFER_LENGTHNeed to set a minimum size, since there are some limitations to smallest consequtive block that can be used.- See Also:
-
DTD_CACHE_SIZE_J2SE
static final int DTD_CACHE_SIZE_J2SELet's allow caching of just a dozen DTDs... shouldn't really matter, how many DTDs does one really use?- See Also:
-
DTD_CACHE_SIZE_J2ME
static final int DTD_CACHE_SIZE_J2ME- See Also:
-
DEFAULT_SHORTEST_TEXT_SEGMENT
static final int DEFAULT_SHORTEST_TEXT_SEGMENTBy default, let's require minimum of 64 chars to be delivered as shortest partial (piece of) text (CDATA, text) segment; same for both J2ME subset and full readers. Prevents tiniest runts from getting passed- See Also:
-
DEFAULT_FLAGS_FULL
static final int DEFAULT_FLAGS_FULLDefault config flags are converted from individual settings, to conform to StAX 1.0 specifications.- See Also:
-
DEFAULT_FLAGS_J2ME
static final int DEFAULT_FLAGS_J2MEFor now defaults for J2ME flags can be identical to 'full' set; differences are in buffer sizes.- See Also:
-
sProperties
Map to use for converting from String property ids to ints described above; useful to allow use of switch later on. -
mIsJ2MESubset
protected final boolean mIsJ2MESubset -
mSymbols
-
mConfigFlags
protected int mConfigFlagsBitset that contains state of on/off properties; initialized to defaults, but can be set/cleared. -
mConfigFlagMods
protected int mConfigFlagModsBitset that indicates explicit changes tomConfigFlags
through calls; empty bit means that the corresponding property has its default value, set bit that an explicit call has been made. -
PROP_INTERN_NAMES_EXPLICIT
static final int PROP_INTERN_NAMES_EXPLICIT13-Nov-2008, tatus: Need to be able to keep track of whether name-interning has been explicitly enabled/disable or not (not if it's whatever defaults we have)- See Also:
-
PROP_INTERN_NS_URIS_EXPLICIT
static final int PROP_INTERN_NS_URIS_EXPLICIT- See Also:
-
mInputBufferLen
protected int mInputBufferLen -
mMinTextSegmentLen
protected int mMinTextSegmentLen -
mMaxAttributesPerElement
protected int mMaxAttributesPerElement -
mMaxAttributeSize
protected int mMaxAttributeSize -
mMaxChildrenPerElement
protected int mMaxChildrenPerElement -
mMaxElementDepth
protected int mMaxElementDepth -
mMaxElementCount
protected long mMaxElementCount -
mMaxCharacters
protected long mMaxCharacters -
mMaxTextLength
protected int mMaxTextLength -
mMaxEntityDepth
protected int mMaxEntityDepth -
mMaxEntityCount
protected long mMaxEntityCount -
mBaseURL
Base URL to use as the resolution context for relative entity references -
mParsingMode
Parsing mode can be changed from the default xml compliant behavior to one of alternate modes (fragment processing, multiple document processing). -
mXml11
protected boolean mXml11This boolean flag is set if the input document requires xml 1.1 (or above) compliant processing: default is xml 1.0 compliant. Note that unlike most other properties, this does not come from configuration settings, but from processed document itself. -
mReporter
XMLReporter mReporter -
mDtdResolver
XMLResolver mDtdResolver -
mEntityResolver
XMLResolver mEntityResolver -
mSpecialProperties
Object[] mSpecialProperties -
SPEC_PROC_COUNT
private static final int SPEC_PROC_COUNT- See Also:
-
SP_IX_CUSTOM_ENTITIES
private static final int SP_IX_CUSTOM_ENTITIES- See Also:
-
SP_IX_UNDECL_ENT_RESOLVER
private static final int SP_IX_UNDECL_ENT_RESOLVER- See Also:
-
SP_IX_DTD_EVENT_LISTENER
private static final int SP_IX_DTD_EVENT_LISTENER- See Also:
-
SP_IX_DTD_OVERRIDE
private static final int SP_IX_DTD_OVERRIDE- See Also:
-
mRecyclerRef
ThisThreadLocal
contains ainvalid reference
SoftRerefence
BufferRecycler
used to provide a low-cost buffer recycling between Reader instances. -
mCurrRecycler
BufferRecycler mCurrRecyclerThis 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 Details
-
ReaderConfig
private ReaderConfig(ReaderConfig base, boolean j2meSubset, SymbolTable symbols, int configFlags, int configFlagMods, int inputBufLen, int minTextSegmentLen)
-
-
Method Details
-
createJ2MEDefaults
-
createFullDefaults
-
resetState
public void resetState()Unlike name suggests there is also some limited state information associated with the config object. If these objects are reused, that state needs to be reset between reuses, to avoid carrying over incorrect state. -
findPropertyId
- Specified by:
findPropertyId
in classCommonConfig
- Returns:
- Internal enumerated int matching the String name of the property, if one found: -1 to indicate no match was found.
-
getSymbols
-
getDtdCacheSize
public int getDtdCacheSize()In future this property could/should be made configurable? -
getConfigFlags
public int getConfigFlags() -
willCoalesceText
public boolean willCoalesceText() -
willSupportNamespaces
public boolean willSupportNamespaces() -
willReplaceEntityRefs
public boolean willReplaceEntityRefs() -
willSupportExternalEntities
public boolean willSupportExternalEntities() -
willSupportDTDs
public boolean willSupportDTDs() -
willValidateWithDTD
public boolean willValidateWithDTD() -
willReportCData
public boolean willReportCData() -
willParseLazily
public boolean willParseLazily() -
willInternNames
public boolean willInternNames() -
willInternNsURIs
public boolean willInternNsURIs() -
willPreserveLocation
public boolean willPreserveLocation() -
willAutoCloseInput
public boolean willAutoCloseInput() -
willProcessSecurely
public boolean willProcessSecurely() -
willReportPrologWhitespace
public boolean willReportPrologWhitespace() -
willCacheDTDs
public boolean willCacheDTDs() -
willCacheDTDsByPublicId
public boolean willCacheDTDsByPublicId() -
willDoXmlIdTyping
public boolean willDoXmlIdTyping() -
willDoXmlIdUniqChecks
public boolean willDoXmlIdUniqChecks() -
willSupportDTDPP
public boolean willSupportDTDPP() -
willNormalizeLFs
public boolean willNormalizeLFs() -
willTreatCharRefsAsEnts
public boolean willTreatCharRefsAsEnts() -
willAllowXml11EscapedCharsInXml10
public boolean willAllowXml11EscapedCharsInXml10() -
getInputBufferLength
public int getInputBufferLength() -
getShortestReportedTextSegment
public int getShortestReportedTextSegment() -
getMaxAttributesPerElement
public int getMaxAttributesPerElement() -
getMaxAttributeSize
public int getMaxAttributeSize() -
getMaxChildrenPerElement
public int getMaxChildrenPerElement() -
getMaxElementDepth
public int getMaxElementDepth() -
getMaxElementCount
public long getMaxElementCount() -
getMaxEntityDepth
public int getMaxEntityDepth() -
getMaxEntityCount
public long getMaxEntityCount() -
getMaxCharacters
public long getMaxCharacters() -
getMaxTextLength
public long getMaxTextLength() -
getCustomInternalEntities
-
findCustomInternalEntity
-
getXMLReporter
-
getXMLResolver
-
getDtdResolver
-
getEntityResolver
-
getUndeclaredEntityResolver
-
getBaseURL
-
getInputParsingMode
-
inputParsingModeDocuments
public boolean inputParsingModeDocuments() -
inputParsingModeFragment
public boolean inputParsingModeFragment() -
isXml11
public boolean isXml11()- Returns:
- True if the input well-formedness and validation checks should be done according to xml 1.1 specification; false if xml 1.0 specification.
-
getDTDEventListener
-
getDTDOverride
public org.codehaus.stax2.validation.DTDValidationSchema getDTDOverride() -
hasInternNamesBeenEnabled
public boolean hasInternNamesBeenEnabled()Special accessor to use to verify whether name interning has explicitly been enabled; true if call was been made to set it to true; false otherwise (default, or set to false) -
hasInternNsURIsBeenEnabled
public boolean hasInternNsURIsBeenEnabled() -
setConfigFlag
public void setConfigFlag(int flag) -
clearConfigFlag
public void clearConfigFlag(int flag) -
doCoalesceText
public void doCoalesceText(boolean state) -
doSupportNamespaces
public void doSupportNamespaces(boolean state) -
doReplaceEntityRefs
public void doReplaceEntityRefs(boolean state) -
doSupportExternalEntities
public void doSupportExternalEntities(boolean state) -
doSupportDTDs
public void doSupportDTDs(boolean state) -
doValidateWithDTD
public void doValidateWithDTD(boolean state) -
doProcessSecurely
public void doProcessSecurely(boolean value) Method called when {code XMLConstants.FEATURE_SECURE_PROCESSING} is being enabled or disabled.Note that disabling (passing {code false} as argument) does not actually change any settings.
Calls made when
true
is passed (that is, secure processing enabled):doSupportExternalEntities(false)
- Since:
- 5.3
-
doInternNames
public void doInternNames(boolean state) -
doInternNsURIs
public void doInternNsURIs(boolean state) -
doReportPrologWhitespace
public void doReportPrologWhitespace(boolean state) -
doReportCData
public void doReportCData(boolean state) -
doCacheDTDs
public void doCacheDTDs(boolean state) -
doCacheDTDsByPublicId
public void doCacheDTDsByPublicId(boolean state) -
doParseLazily
public void doParseLazily(boolean state) -
doXmlIdTyping
public void doXmlIdTyping(boolean state) -
doXmlIdUniqChecks
public void doXmlIdUniqChecks(boolean state) -
doPreserveLocation
public void doPreserveLocation(boolean state) -
doAutoCloseInput
public void doAutoCloseInput(boolean state) -
doSupportDTDPP
public void doSupportDTDPP(boolean state) -
doTreatCharRefsAsEnts
public void doTreatCharRefsAsEnts(boolean state) -
doAllowXml11EscapedCharsInXml10
public void doAllowXml11EscapedCharsInXml10(boolean state) -
doNormalizeLFs
public void doNormalizeLFs(boolean state) -
setInputBufferLength
public void setInputBufferLength(int value) -
setShortestReportedTextSegment
public void setShortestReportedTextSegment(int value) -
setMaxAttributesPerElement
public void setMaxAttributesPerElement(int value) -
setMaxAttributeSize
public void setMaxAttributeSize(int value) -
setMaxChildrenPerElement
public void setMaxChildrenPerElement(int value) -
setMaxElementDepth
public void setMaxElementDepth(int value) -
setMaxElementCount
public void setMaxElementCount(long value) -
setMaxCharacters
public void setMaxCharacters(long value) -
setMaxTextLength
public void setMaxTextLength(int value) -
setMaxEntityDepth
public void setMaxEntityDepth(int value) -
setMaxEntityCount
public void setMaxEntityCount(long value) -
setCustomInternalEntities
-
setXMLReporter
-
setXMLResolver
Note: for better granularity, you should callsetEntityResolver(javax.xml.stream.XMLResolver)
andsetDtdResolver(javax.xml.stream.XMLResolver)
instead. -
setDtdResolver
-
setEntityResolver
-
setUndeclaredEntityResolver
-
setBaseURL
-
setInputParsingMode
-
enableXml11
public void enableXml11(boolean state) Method called to enable or disable 1.1 compliant processing; if disabled, defaults to xml 1.0 compliant processing. -
setDTDEventListener
-
setDTDOverride
public void setDTDOverride(org.codehaus.stax2.validation.DTDValidationSchema schema) -
configureForXmlConformance
public void configureForXmlConformance()Method to call to make Reader created conform as closely to XML standard as possible, doing all checks and transformations mandated (linefeed conversions, attr value normalizations). SeeXMLInputFactory2.configureForXmlConformance()
for required settings for standard StAX/StAX properties.In addition to the standard settings, following Woodstox-specific settings are also done:
- None
Notes: Does NOT change 'performance' settings (buffer sizes, DTD caching, coalescing, interning, accurate location info).
-
configureForConvenience
public void configureForConvenience()Method to call to make Reader created be as "convenient" to use as possible; ie try to avoid having to deal with some of things like segmented text chunks. This may incur some slight performance penalties, but should not affect XML conformance. SeeXMLInputFactory2.configureForConvenience()
for required settings for standard StAX/StAX properties.In addition to the standard settings, following Woodstox-specific settings are also done:
- Disable
XMLStreamFactory2.P_LAZY_PARSING
(to allow for synchronous error notification by forcing full XML events to be completely parsed when reader'snext()
is called)
- Disable
-
configureForSpeed
public void configureForSpeed()Method to call to make the Reader created be as fast as possible reading documents, especially for long-running processes where caching is likely to help. SeeXMLInputFactory2.configureForSpeed()
for required settings for standard StAX/StAX properties.In addition to the standard settings, following Woodstox-specific settings are also done:
- Enable
P_CACHE_DTDS
. - Enable
XMLStremaFactory2.P_LAZY_PARSING
(can improve performance especially when skipping text segments) - Disable Xml:id uniqueness checks (and leave typing as is)
- Set lowish value for
P_MIN_TEXT_SEGMENT
, to allow reader to optimize segment length it uses (and possibly avoids one copy operation in the process) - Increase
P_INPUT_BUFFER_LENGTH
a bit from default, to allow for longer consequtive read operations; also reduces cases where partial text segments are on input buffer boundaries.
- Enable
-
configureForLowMemUsage
public void configureForLowMemUsage()Method to call to minimize the memory usage of the stream/event reader; both regarding Objects created, and the temporary memory usage during parsing. This generally incurs some performance penalties, due to using smaller input buffers.See
XMLInputFactory2.configureForLowMemUsage()
for required settings for standard StAX/StAX properties.In addition to the standard settings, following Woodstox-specific settings are also done:
- Disable
P_CACHE_DTDS
- Enable
P_PARSE_LAZILY
- Resets
P_MIN_TEXT_SEGMENT
to the (somewhat low) default value. - Reduces
P_INPUT_BUFFER_LENGTH
a bit from the default
- Disable
-
configureForRoundTripping
public void configureForRoundTripping()Method to call to make Reader try to preserve as much of input formatting as possible, so that round-tripping would be as lossless as possible.See
XMLInputFactory2.configureForLowMemUsage()
for required settings for standard StAX/StAX properties.In addition to the standard settings, following Woodstox-specific settings are also done:
- Increases
P_MIN_TEXT_SEGMENT
to the maximum value so that all original text segment chunks are reported without segmentation (but without coalescing with adjacent CDATA segments) - Sets
P_TREAT_CHAR_REFS_AS_ENTS
to true, so the all the original character references are reported with their position, original text, and the replacement text.
- Increases
-
allocSmallCBuffer
public char[] allocSmallCBuffer(int minSize) -
freeSmallCBuffer
public void freeSmallCBuffer(char[] buffer) -
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) -
createRecycler
-
setConfigFlag
private void setConfigFlag(int flag, boolean state) -
getProperty
- Specified by:
getProperty
in classCommonConfig
-
setProperty
- Specified by:
setProperty
in classCommonConfig
-
_hasConfigFlag
protected boolean _hasConfigFlag(int flag) -
_hasExplicitConfigFlag
protected boolean _hasExplicitConfigFlag(int flag) Method similar to_hasConfigFlag(int)
, but that will only return true if in addition to being set, flag has been explicitly modified (i.e. setProperty has been called to modify it) -
_getSpecialProperty
-
_setSpecialProperty
-