Package com.ctc.wstx.cfg
Interface InputConfigFlags
-
- All Known Implementing Classes:
BasicStreamReader
,FullDTDReader
,MinimalDTDReader
,ReaderConfig
,StreamScanner
,TypedStreamReader
,ValidatingStreamReader
,WstxInputFactory
public interface InputConfigFlags
Constant interface that contains configuration flag used by parser and parser factory, as well as some other input constants.
-
-
Field Summary
Fields Modifier and Type Field Description static int
CFG_ALLOW_XML11_ESCAPED_CHARS_IN_XML10
If true, the XML parser will allow XML 1.1 escaped chars in XML 1.0 file.static int
CFG_AUTO_CLOSE_INPUT
Property that enables/disables stream reader to close the underlying input source, either when it is asked to (.close() is called), or when it doesn't need it any more (reaching EOF, hitting an unrecoverable exception).static int
CFG_CACHE_DTDS
If true, input factory is allowed cache parsed external DTD subsets, potentially speeding up things for which DTDs are needed for: entity substitution, attribute defaulting, and of course DTD-based validation.static int
CFG_CACHE_DTDS_BY_PUBLIC_ID
If true, key used for matching DTD subsets can be the public id, if false, only system id can be used.static int
CFG_COALESCE_TEXT
static int
CFG_INTERN_NAMES
If true, will guarantee that all names (attribute/element local names have been intern()ed.static int
CFG_INTERN_NS_URIS
It true, will call intern() on all namespace URIs parsed; otherwise will just use 'regular' Strings created from parsed contents.static int
CFG_JAXP_FEATURE_SECURE_PROCESSING
Flag that matches pseudo-settingXMLConstants.FEATURE_SECURE_PROCESSING
static int
CFG_LAZY_PARSING
If true, input factory can defer parsing of nodes until data is actually needed; if false, it has to read all the data in right away when next type is requested.static int
CFG_NAMESPACE_AWARE
If true, parser will handle namespaces according to XML specs; if false, will only pass them as part of element/attribute name value information.static int
CFG_NORMALIZE_LFS
static int
CFG_PRESERVE_LOCATION
Property that determines whether Event objects created will contain (accurate)Location
information or not.static int
CFG_REPLACE_ENTITY_REFS
Flag that enables automatic replacement of internal entitiesstatic int
CFG_REPORT_CDATA
If true, parser will accurately report CDATA event as such (unless coalescing); otherwise will always report them as CHARACTERS independent of coalescing settings.static int
CFG_REPORT_PROLOG_WS
If true, parser will report (ignorable) white space events in prolog and epilog; if false, it will silently ignore them.static int
CFG_SUPPORT_DTD
Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.static int
CFG_SUPPORT_DTDPP
If true, DTD-parser will recognize DTD++ features, and the validator will also use any such information found from DTD when DTD validation is enabled.static int
CFG_SUPPORT_EXTERNAL_ENTITIES
Flag that enables support for expanding external entities.static int
CFG_TREAT_CHAR_REFS_AS_ENTS
If true, the XML parser will treat character references as entities.static int
CFG_VALIDATE_AGAINST_DTD
Not yet (fully) supported; added as the placeholderstatic int
CFG_XMLID_TYPING
If true, xml:id attribute type assignment and matching checks will be done as per Xml:id specification.static int
CFG_XMLID_UNIQ_CHECKS
If true, xml:id attribute uniqueness constraints are enforced, even if not validating against DTD otherwise.
-
-
-
Field Detail
-
CFG_NAMESPACE_AWARE
static final int CFG_NAMESPACE_AWARE
If true, parser will handle namespaces according to XML specs; if false, will only pass them as part of element/attribute name value information.- See Also:
- Constant Field Values
-
CFG_COALESCE_TEXT
static final int CFG_COALESCE_TEXT
- See Also:
- Constant Field Values
-
CFG_REPLACE_ENTITY_REFS
static final int CFG_REPLACE_ENTITY_REFS
Flag that enables automatic replacement of internal entities- See Also:
- Constant Field Values
-
CFG_SUPPORT_EXTERNAL_ENTITIES
static final int CFG_SUPPORT_EXTERNAL_ENTITIES
Flag that enables support for expanding external entities. Woodstox pretty much ignores the setting, since effectively it is irrelevant, asCFG_REPLACE_ENTITY_REFS
andCFG_SUPPORT_DTD
both need to be enabled for external entities to be supported.- See Also:
- Constant Field Values
-
CFG_SUPPORT_DTD
static final int CFG_SUPPORT_DTD
Whether DTD handling is enabled or disabled; disabling means both internal and external subsets will just be skipped unprocessed.- See Also:
- Constant Field Values
-
CFG_VALIDATE_AGAINST_DTD
static final int CFG_VALIDATE_AGAINST_DTD
Not yet (fully) supported; added as the placeholder- See Also:
- Constant Field Values
-
CFG_REPORT_PROLOG_WS
static final int CFG_REPORT_PROLOG_WS
If true, parser will report (ignorable) white space events in prolog and epilog; if false, it will silently ignore them.- See Also:
- Constant Field Values
-
CFG_REPORT_CDATA
static final int CFG_REPORT_CDATA
If true, parser will accurately report CDATA event as such (unless coalescing); otherwise will always report them as CHARACTERS independent of coalescing settings.- See Also:
- Constant Field Values
-
CFG_INTERN_NAMES
static final int CFG_INTERN_NAMES
If true, will guarantee that all names (attribute/element local names have been intern()ed. If false, this is not guaranteed although implementation may still choose to do it.- See Also:
- Constant Field Values
-
CFG_INTERN_NS_URIS
static final int CFG_INTERN_NS_URIS
It true, will call intern() on all namespace URIs parsed; otherwise will just use 'regular' Strings created from parsed contents. Interning makes namespace-based access faster, but has initial overhead of intern() call.- See Also:
- Constant Field Values
-
CFG_PRESERVE_LOCATION
static final int CFG_PRESERVE_LOCATION
Property that determines whether Event objects created will contain (accurate)Location
information or not. If not, Location may be null or a fixed location (beginning of main XML file).Note, however, that the underlying parser will still keep track of location information for error reporting purposes; it's only Event objects that are affected.
- See Also:
- Constant Field Values
-
CFG_AUTO_CLOSE_INPUT
static final int CFG_AUTO_CLOSE_INPUT
Property that enables/disables stream reader to close the underlying input source, either when it is asked to (.close() is called), or when it doesn't need it any more (reaching EOF, hitting an unrecoverable exception). As per Stax 1.0 specification, automatic closing is NOT enabled by default; except if the caller has no access to the target (i.e. when factory created it)- See Also:
- Constant Field Values
-
CFG_NORMALIZE_LFS
static final int CFG_NORMALIZE_LFS
- See Also:
- Constant Field Values
-
CFG_CACHE_DTDS
static final int CFG_CACHE_DTDS
If true, input factory is allowed cache parsed external DTD subsets, potentially speeding up things for which DTDs are needed for: entity substitution, attribute defaulting, and of course DTD-based validation.- See Also:
- Constant Field Values
-
CFG_CACHE_DTDS_BY_PUBLIC_ID
static final int CFG_CACHE_DTDS_BY_PUBLIC_ID
If true, key used for matching DTD subsets can be the public id, if false, only system id can be used.- See Also:
- Constant Field Values
-
CFG_LAZY_PARSING
static final int CFG_LAZY_PARSING
If true, input factory can defer parsing of nodes until data is actually needed; if false, it has to read all the data in right away when next type is requested. Setting it to true is good for performance, in the cases where some of the nodes (like comments, processing instructions, or whole subtrees) are ignored. Otherwise setting will not make much of a difference. Downside is that error reporting is also done 'lazily'; not right away when getting the next even type but when either accessing data, or skipping it.- See Also:
- Constant Field Values
-
CFG_SUPPORT_DTDPP
static final int CFG_SUPPORT_DTDPP
If true, DTD-parser will recognize DTD++ features, and the validator will also use any such information found from DTD when DTD validation is enabled.- See Also:
- Constant Field Values
-
CFG_XMLID_TYPING
static final int CFG_XMLID_TYPING
If true, xml:id attribute type assignment and matching checks will be done as per Xml:id specification. Needs to be enabled for xml:id uniqueness checks to function properly- See Also:
- Constant Field Values
-
CFG_XMLID_UNIQ_CHECKS
static final int CFG_XMLID_UNIQ_CHECKS
If true, xml:id attribute uniqueness constraints are enforced, even if not validating against DTD otherwise.- See Also:
- Constant Field Values
-
CFG_TREAT_CHAR_REFS_AS_ENTS
static final int CFG_TREAT_CHAR_REFS_AS_ENTS
If true, the XML parser will treat character references as entities.- See Also:
- Constant Field Values
-
CFG_ALLOW_XML11_ESCAPED_CHARS_IN_XML10
static final int CFG_ALLOW_XML11_ESCAPED_CHARS_IN_XML10
If true, the XML parser will allow XML 1.1 escaped chars in XML 1.0 file.- Since:
- 5.2
- See Also:
- Constant Field Values
-
CFG_JAXP_FEATURE_SECURE_PROCESSING
static final int CFG_JAXP_FEATURE_SECURE_PROCESSING
Flag that matches pseudo-settingXMLConstants.FEATURE_SECURE_PROCESSING
- Since:
- 5.3
- See Also:
- Constant Field Values
-
-