Currently supported configuration options fall into two categories. First,
all properties from XMLInputFactory (such as, say,
XMLInputFactory#IS_NAMESPACE_AWARE) are at least recognized, and
most are supported. Second, there are additional properties, defined in
constant class WstxInputProperties, that are supported.
See WstxInputProperties for further explanation of these 'custom'
properties.
| Modifier and Type | Field and Description |
|---|---|
| protected XMLEventAllocator | |
| pack-priv static final int | MAX_SYMBOL_TABLE_GENERATIONS
Number of generations should not matter as much as raw size... |
| pack-priv static final int | MAX_SYMBOL_TABLE_SIZE
Let's limit max size to 3/4 of 16k, since this corresponds to 64k main hash index. |
| protected final ReaderConfig | mConfig
Current configurations for this factory |
| protected SimpleCache | |
| pack-priv static final SymbolTable | mRootSymbols
'Root' symbol table, used for creating actual symbol table instances, but never as is. |
| private SymbolTable | mSymbols
Actual current 'parent' symbol table; concrete instances will be
created from this instance using |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public synchronized void | |
| public void | |
| public void | configureForConvenience()
Implements abstract org. 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. |
| public void | configureForLowMemUsage()
Implements abstract org. Method to call to minimize the memory usage of the stream/event reader; both regarding Objects created, and the temporary memory usage during parsing. |
| public void | configureForRoundTripping()
Implements abstract org. 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. |
| public void | configureForSpeed()
Implements abstract org. 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. |
| public void | configureForXmlConformance()
Implements abstract org. Method to call to make Reader created conform as closely to XML standard as possible, doing all checks and transformations mandated by the XML specification (linefeed conversions, attr value normalizations). |
| protected XMLEventAllocator | |
| public XMLEventReader | createFilteredReader(XMLEventReader
the event reader to wrap reader, EventFilter the filter to apply to the event reader filter)Implements abstract javax. Create a filtered event reader that wraps the filter around the event reader |
| public XMLStreamReader | createFilteredReader(XMLStreamReader
the reader to filter reader, StreamFilter the filter to apply to the reader filter)Implements abstract javax. Create a filtered reader that wraps the filter around the reader |
| public ReaderConfig | createPrivateConfig()
Method called to construct a copy of the factory's configuration object, such that two will be unlinked (changes to one are not reflect in the other). |
| public XMLStreamReader2 | createSR(ReaderConfig cfg, String
System id used for this reader (if any) systemId, InputBootstrapper Bootstrapper to use for creating actual underlying
physical reader bs, boolean Flag to indicate whether it will be used via
Event API (will affect some configuration settings), true if it
will be, false if not (or not known) forER, boolean Whether the underlying input source should be
actually closed when encountering EOF, or when autoCloseInput)close()
is called. Will be true for input sources that are automatically
managed by stream reader (input streams created for
java. and java. arguments, or when
configuration settings indicate auto-closing is to be enabled
(the default value is false as per Stax 1.0 specs).Method that is eventually called to create a (full) stream read instance. |
| public XMLStreamReader2 | createSR(ReaderConfig cfg, SystemId systemId, InputBootstrapper bs, boolean forER, boolean autoCloseInput)
|
| protected XMLStreamReader2 | |
| protected XMLStreamReader2 | |
| private XMLStreamReader2 | createSR(ReaderConfig cfg, SystemId systemId, InputStream in, boolean forER, boolean autoCloseInput)
|
| protected XMLStreamReader2 | |
| protected XMLStreamReader2 | |
| protected XMLStreamReader2 | |
| public XMLEventReader | createXMLEventReader(InputStream
the InputStream to read from in)Implements abstract javax. Create a new XMLEventReader from a java.io.InputStream |
| public XMLEventReader | createXMLEventReader(InputStream
the InputStream to read from in, String the character encoding of the stream enc)Implements abstract javax. Create a new XMLEventReader from a java.io.InputStream |
| public XMLEventReader | createXMLEventReader(Reader
the XML data to read from r)Implements abstract javax. Create a new XMLEventReader from a reader. |
| public XMLEventReader | createXMLEventReader(Source
the source to read from source)Implements abstract javax. Create a new XMLEventReader from a JAXP source. |
| public XMLEventReader | createXMLEventReader(String
the system ID of the stream systemId, InputStream the InputStream to read from in)Implements abstract javax. Create a new XMLEventReader from a java.io.InputStream |
| public XMLEventReader | createXMLEventReader(String
the system ID of the input systemId, Reader the XML data to read from r)Implements abstract javax. Create a new XMLEventReader from a reader. |
| public XMLEventReader | createXMLEventReader(XMLStreamReader
the XMLStreamReader to read from (may not be modified) sr)Implements abstract javax. Create a new XMLEventReader from an XMLStreamReader. |
| public XMLEventReader2 | createXMLEventReader(URL src)
Implements abstract org. Factory method that allows for parsing a document accessible via specified URL. |
| public XMLEventReader2 | createXMLEventReader(File f)
Implements abstract org. Convenience factory method that allows for parsing a document stored in the specified file. |
| public XMLStreamReader | createXMLStreamReader(InputStream
the InputStream to read from in)Implements abstract javax. Create a new XMLStreamReader from a java.io.InputStream. |
| public XMLStreamReader | createXMLStreamReader(InputStream
the InputStream to read from in, String the character encoding of the stream enc)Implements abstract javax. Create a new XMLStreamReader from a java.io.InputStream. |
| public XMLStreamReader | createXMLStreamReader(Reader
the XML data to read from r)Implements abstract javax. Create a new XMLStreamReader from a reader. |
| public XMLStreamReader | createXMLStreamReader(Source
the source to read from src)Implements abstract javax. Create a new XMLStreamReader from a JAXP source. |
| public XMLStreamReader | createXMLStreamReader(String
the system ID of the stream systemId, InputStream the InputStream to read from in)Implements abstract javax. Create a new XMLStreamReader from a java.io.InputStream. |
| public XMLStreamReader | createXMLStreamReader(String
the system ID of the stream systemId, Reader the InputStream to read from r)Implements abstract javax. Create a new XMLStreamReader from a java.io.InputStream. |
| public XMLStreamReader2 | createXMLStreamReader(URL src)
Implements abstract org. Factory method that allows for parsing a document accessible via specified URL. |
| public XMLStreamReader2 | createXMLStreamReader(File f)
Implements abstract org. Convenience factory method that allows for parsing a document stored in the specified file. |
| private XMLStreamReader2 | doCreateSR(ReaderConfig cfg, SystemId systemId, InputBootstrapper bs, boolean
True, if the reader is being constructed to be used
by an event reader; false if it is not (or the purpose is not known) forER, boolean Whether the underlying input source should be
actually closed when encountering EOF, or when autoCloseInput)close()
is called. Will be true for input sources that are automatically
managed by stream reader (input streams created for
java. and java. arguments, or when
configuration settings indicate auto-closing is to be enabled
(the default value is false as per Stax 1.0 specs).Bottleneck method used for creating ALL full stream reader instances (via other createSR() methods and directly) |
| public synchronized DTDSubset | findCachedDTD(DTDId id)
Implements com. Method readers created by this factory call, if DTD caching is enabled, to see if an external DTD (subset) has been parsed and cached earlier. |
| public ReaderConfig | |
| public XMLEventAllocator | getEventAllocator()
Implements abstract javax. Gets the allocator used by streams created with this factory |
| public Object | getProperty(String
The name of the property (may not be null) name)Implements abstract javax. Get the value of a feature/property from the underlying implementation |
| public XMLReporter | getXMLReporter()
Implements abstract javax. The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
| public XMLResolver | getXMLResolver()
Implements abstract javax. The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
| public boolean | isPropertySupported(String
The name of the property (may not be null) name)Implements abstract javax. Query the set of properties that this factory supports. |
| public void | setEventAllocator(XMLEventAllocator
the user defined allocator allocator)Implements abstract javax. Set a user defined event allocator for events |
| public void | setProperty(String
The name of the property (may not be null) propName, Object The value of the property value)Implements abstract javax. Allows the user to set specific feature/property on the underlying implementation. |
| public void | setXMLReporter(XMLReporter
the resolver to use to report non fatal errors r)Implements abstract javax. The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
| public void | setXMLResolver(XMLResolver
the resolver to use to resolve references r)Implements abstract javax. Note it's preferable to use Wstx-specific
|
| public synchronized void | updateSymbolTable(SymbolTable t)
Implements com. Method individual parsers call to pass back symbol table that they updated, which may be useful for other parser to reuse, instead of previous base symbol table. |