public abstract class BasicStreamReader extends StreamScanner implements StreamReaderImpl, org.codehaus.stax2.DTDInfo, org.codehaus.stax2.LocationInfo
XMLStreamReader2 consisting of
all functionality other than DTD-validation-specific parts, and
Typed Access API (Stax2 v3.0), which are implemented at
sub-classes.| Modifier and Type | Field and Description |
|---|---|
protected static int |
MASK_GET_ELEMENT_TEXT |
protected static int |
MASK_GET_TEXT
This mask covers all types for which basic
getText() method
can be called. |
protected static int |
MASK_GET_TEXT_WITH_WRITER
This mask is used with Stax2 getText() method (one that takes
Writer as an argument): accepts even wider range of event types.
|
protected static int |
MASK_GET_TEXT_XXX
This mask covers all types for which extends
getTextXxx
methods can be called; which is less than those for which
getText() can be called. |
protected AttributeCollector |
mAttrCollector
Object that stores information about currently accessible attributes.
|
protected boolean |
mCfgCoalesceText |
protected boolean |
mCfgLazyParsing |
protected boolean |
mCfgReportTextAsChars |
protected int |
mCheckIndentation
Counter used for determining whether we are to try to heuristically
"intern" white space that seems to be used for indentation purposes
|
protected int |
mConfigFlags
Set of locally stored configuration flags
|
protected int |
mCurrTextLength
Sized of currentTextLength for CDATA, CHARACTERS, WHITESPACE.
|
protected int |
mCurrToken
Current state of the stream, ie token value returned by
getEventType(). |
protected int |
mDocStandalone
Status about "stand-aloneness" of document; set to 'yes'/'no'/'unknown'
based on whether there was xml declaration, and if so, whether
it had standalone attribute.
|
protected String |
mDtdPublicId
Public id of the DTD, if one exists and has been parsed.
|
protected String |
mDtdSystemId
System id of the DTD, if one exists and has been parsed.
|
protected InputElementStack |
mElementStack
Currently open element tree
|
protected Map<String,EntityDecl> |
mGeneralEntities
Entities parsed from internal/external DTD subsets.
|
protected ReaderCreator |
mOwner
Object to notify about shared stuff, such as symbol tables, as well
as to query for additional config settings if necessary.
|
protected int |
mParseState
Main parsing/tokenization state (STATE_xxx)
|
protected XMLStreamException |
mPendingException
Due to the way Stax API does not allow throwing stream exceptions
from many methods for which Woodstox would need to throw one
(especially
getText and its variations), we may need
to delay throwing an exception until next() is called next
time. |
protected boolean |
mReturnNullForDefaultNamespace
Configuration from
WstxInputProperties#RETURN_NULL_FOR_DEFAULT_NAMESPACE |
protected String |
mRootLName
Local name of root element, as dictated by DOCTYPE declaration; null
if no DOCTYPE declaration.
|
protected String |
mRootPrefix
Prefix of root element, as dictated by DOCTYPE declaration; null
if no DOCTYPE declaration, or no root prefix
|
protected int |
mSecondaryToken
Additional information sometimes stored (when generating dummy
events in multi-doc mode, for example) temporarily when
mCurrToken is already populated. |
protected int |
mShortestTextSegment
Minimum number of characters parser can return as partial text
segment, IF it's not required to coalesce adjacent text
segments.
|
protected boolean |
mStDoctypeFound |
protected boolean |
mStEmptyElem |
protected int |
mStTextThreshold
Threshold value that defines tokenization state that needs to be
achieved to "finish" current logical text segment (which
may consist of adjacent CDATA and text segments; or be a complete
physical segment; or just even a fragment of such a segment)
|
protected TextBuffer |
mTextBuffer
TextBuffer mostly used to collect non-element textual content
(text, CDATA, comment content, pi data)
|
protected int |
mTokenState
State of the current token; one of M_ - constants from above.
|
protected boolean |
mValidateText
Flag that indicates that textual content (CDATA, CHARACTERS) is to
be validated within current element's scope.
|
protected int |
mVldContent
Mode information needed at this level; mostly to check what kind
of textual content (if any) is allowed in current element
context.
|
protected int |
mWsStatus
Status of current (text) token's "whitespaceness", that is,
whether it is or is not all white space.
|
protected static String |
sPrefixXml |
protected static String |
sPrefixXmlns |
CHAR_CR_LF_OR_NULL, CHAR_FIRST_PURE_TEXT, CHAR_LOWEST_LEGAL_LOCALNAME_CHAR, INT_CR_LF_OR_NULL, mAllowXml11EscapedCharsInXml10, mCachedEntities, mCfgNsEnabled, mCfgReplaceEntities, mCfgTreatCharRefsAsEntities, mConfig, mCurrDepth, mCurrEntity, mCurrName, mDocInputEncoding, mDocXmlEncoding, mDocXmlVersion, mEntityExpansionCount, mEntityResolver, mInput, mInputTopDepth, mNameBuffer, mNormalizeLFs, mRootInput, mTokenInputCol, mTokenInputRow, mTokenInputTotalCHAR_NULL, CHAR_SPACE, INT_NULL, INT_SPACE, MAX_UNICODE_CHAR, mCurrInputProcessed, mCurrInputRow, mCurrInputRowStart, mInputBuffer, mInputEnd, mInputPtr, mXml11ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENTCFG_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_CHECKSSUFFIX_EOF_EXP_NAME, SUFFIX_IN_ATTR_VALUE, SUFFIX_IN_CDATA, SUFFIX_IN_CLOSE_ELEMENT, SUFFIX_IN_COMMENT, SUFFIX_IN_DEF_ATTR_VALUE, SUFFIX_IN_DOC, SUFFIX_IN_DTD, SUFFIX_IN_DTD_EXTERNAL, SUFFIX_IN_DTD_INTERNAL, SUFFIX_IN_ELEMENT, SUFFIX_IN_ENTITY_REF, SUFFIX_IN_EPILOG, SUFFIX_IN_NAME, SUFFIX_IN_PROC_INSTR, SUFFIX_IN_PROLOG, SUFFIX_IN_TEXT, SUFFIX_IN_XML_DECL| Modifier | Constructor and Description |
|---|---|
protected |
BasicStreamReader(InputBootstrapper bs,
BranchingReaderSource input,
ReaderCreator owner,
ReaderConfig cfg,
InputElementStack elemStack,
boolean forER) |
| Modifier and Type | Method and Description |
|---|---|
protected org.codehaus.stax2.typed.TypedXMLStreamException |
_constructTypeException(String msg,
String lexicalValue) |
protected XMLStreamException |
_constructUnexpectedInTyped(int nextToken)
Method called to report a problem with
|
protected void |
checkCData() |
protected String |
checkKeyword(char c,
String expected) |
void |
close()
Note: as per StAX 1.0 specs, this method does NOT close the underlying
input reader.
|
void |
closeCompletely() |
protected static InputElementStack |
createElementStack(ReaderConfig cfg) |
protected void |
ensureFinishToken() |
protected EntityDecl |
findEntity(String id,
Object arg)
Abstract method for sub-classes to implement, for finding
a declared general or parsed entity.
|
protected void |
finishDTD(boolean copyContents)
This method gets called to handle remainder of DOCTYPE declaration,
essentially the optional internal subset.
|
protected void |
finishToken(boolean deferErrors)
Method called to read in contents of the token completely, if not
yet read.
|
void |
fireSaxCharacterEvents(ContentHandler h) |
void |
fireSaxCommentEvent(LexicalHandler h) |
void |
fireSaxEndElement(ContentHandler h) |
void |
fireSaxPIEvent(ContentHandler h) |
void |
fireSaxSpaceEvents(ContentHandler h) |
void |
fireSaxStartElement(ContentHandler h,
Attributes attrs) |
AttributeCollector |
getAttributeCollector()
Method needed by classes (like stream writer implementations)
that want to have efficient direct access to attribute collector
Object, for optimal attribute name and value access.
|
int |
getAttributeCount() |
org.codehaus.stax2.AttributeInfo |
getAttributeInfo() |
String |
getAttributeLocalName(int index) |
QName |
getAttributeName(int index) |
String |
getAttributeNamespace(int index) |
String |
getAttributePrefix(int index) |
String |
getAttributeType(int index) |
String |
getAttributeValue(int index) |
String |
getAttributeValue(String nsURI,
String localName) |
String |
getCharacterEncodingScheme()
As per Stax (1.0) specs, needs to return whatever xml declaration
claimed encoding is, if any; or null if no xml declaration found.
|
EntityDecl |
getCurrentEntityDecl() |
int |
getDepth() |
org.codehaus.stax2.DTDInfo |
getDTDInfo()
Since this class implements
DTDInfo, method can just
return this. |
String |
getDTDInternalSubset() |
String |
getDTDPublicId() |
String |
getDTDRootName() |
String |
getDTDSystemId() |
String |
getElementText()
From StAX specs:
Reads the content of a text-only element, an exception is thrown if
this is not a text-only element.
|
String |
getEncoding()
As per Stax (1.0) specs, needs to return whatever parser determined
the encoding was, if it was able to figure it out.
|
long |
getEndingByteOffset() |
long |
getEndingCharOffset() |
org.codehaus.stax2.XMLStreamLocation2 |
getEndLocation() |
int |
getEventType()
Returns type of the last event returned; or START_DOCUMENT before
any events has been explicitly returned.
|
Object |
getFeature(String name)
Deprecated.
|
InputElementStack |
getInputElementStack()
Method needed by classes (like stream writer implementations)
that want to have efficient direct access to element stack
implementation
|
String |
getLocalName() |
Location |
getLocation()
Returns location of last properly parsed token; as per StAX specs,
apparently needs to be the end of current event, which is the same
as the start of the following event (or EOF if that's next).
|
org.codehaus.stax2.LocationInfo |
getLocationInfo()
Location information is always accessible, for this reader.
|
QName |
getName() |
NamespaceContext |
getNamespaceContext() |
int |
getNamespaceCount() |
String |
getNamespacePrefix(int index) |
String |
getNamespaceURI() |
String |
getNamespaceURI(int index) |
String |
getNamespaceURI(String prefix) |
NamespaceContext |
getNonTransientNamespaceContext() |
String |
getPIData() |
String |
getPITarget() |
String |
getPrefix() |
String |
getPrefixedName() |
Object |
getProcessedDTD()
Note: DTD-handling sub-classes need to override this method.
|
org.codehaus.stax2.validation.DTDValidationSchema |
getProcessedDTDSchema()
Sub-class will override this method
|
Object |
getProperty(String name) |
long |
getStartingByteOffset() |
long |
getStartingCharOffset() |
String |
getText() |
int |
getText(Writer w,
boolean preserveContents)
Method similar to
getText(), except
that it just uses provided Writer to write all textual content. |
char[] |
getTextCharacters() |
int |
getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int len) |
int |
getTextLength() |
int |
getTextStart() |
String |
getVersion() |
protected int |
handleEOF(boolean isProlog) |
protected void |
handleGreedyEntityProblem(WstxInputSource input)
This problem gets reported if an entity tries to expand to
a close tag matching start tag that did not came from the same
entity (but from parent).
|
protected void |
handleIncompleteEntityProblem(WstxInputSource closing) |
protected int |
handleMultiDocStart(int nextEvent)
Method called when an event was encountered that indicates document
boundary in multi-doc mode.
|
protected void |
handleMultiDocXmlDecl() |
protected void |
handleRootElem(char c) |
protected void |
handleUndeclaredEntity(String id)
This method gets called if a declaration for an entity was not
found in entity expanding mode (enabled by default for xml reader,
always enabled for dtd reader).
|
protected boolean |
hasConfigFlags(int flags) |
boolean |
hasName() |
boolean |
hasNext() |
boolean |
hasText() |
protected void |
initValidation()
Method called right before the document root element is handled.
|
boolean |
isAttributeSpecified(int index) |
boolean |
isCharacters() |
boolean |
isEmptyElement() |
boolean |
isEndElement() |
boolean |
isNamespaceAware() |
boolean |
isPropertySupported(String name) |
boolean |
isStandalone() |
boolean |
isStartElement() |
boolean |
isWhiteSpace()
05-Apr-2004, TSa: Could try to determine status when text is actually
read.
|
int |
next() |
int |
nextTag() |
protected void |
parseQuoted(String name,
char quoteChar,
TextBuffer tbuf)
Method called to parse quoted xml declaration pseudo-attribute values.
|
protected boolean |
readCDataSecondary(int shortestSegment) |
protected void |
readCoalescedText(int currType,
boolean deferErrors)
Method called to read the content of both current CDATA/CHARACTERS
events, and all following consequtive events into the text buffer.
|
protected void |
readEndElem()
Method called to completely read a close tag, and update element
stack appropriately (including checking that tag matches etc).
|
protected boolean |
readTextSecondary(int shortestSegment,
boolean deferErrors) |
protected void |
reportInvalidContent(int evtType)
Stub method implemented by validating parsers, to report content
that's not valid for current element context.
|
void |
require(int type,
String nsUri,
String localName) |
protected void |
safeEnsureFinishToken() |
protected void |
safeFinishToken() |
void |
setFeature(String name,
Object value)
Deprecated.
|
boolean |
setProperty(String name,
Object value) |
org.codehaus.stax2.validation.ValidationProblemHandler |
setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h) |
void |
skipElement() |
protected char |
skipEquals(String name,
String eofMsg)
Method that checks that input following is of form
'[S]* '=' [S]*' (as per XML specs, production #25).
|
protected boolean |
skipWS(char c)
Method that will skip any white space from input source(s)
|
boolean |
standaloneSet() |
org.codehaus.stax2.validation.XMLValidator |
stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema) |
org.codehaus.stax2.validation.XMLValidator |
stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator) |
protected void |
throwNotTextualOrElem(int type) |
protected void |
throwUnexpectedEOF()
Method called when we get an EOF within content tree
|
org.codehaus.stax2.validation.XMLValidator |
validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema) |
Object |
withStartElement(ElemCallback cb,
Location loc)
Method called by
DefaultEventAllocator
to get double-indirection necessary for constructing start element
events. |
_reportProblem, _reportProblem, closeAllInput, constructFromIOE, constructLimitViolation, constructNullCharException, constructWfcException, ensureInput, expandBy50Pct, expandEntity, fullyResolveEntity, getConfig, getCurrentInput, getCurrentLocation, getIntEntity, getLastCharLocation, getNameBuffer, getNext, getNextAfterWS, getNextChar, getNextCharAfterWS, getNextCharFromCurrent, getNextInCurrAfterWS, getNextInCurrAfterWS, getSource, getStartLocation, getSystemId, initInputSource, inputInBuffer, loadMore, loadMore, loadMoreFromCurrent, loadMoreFromCurrent, markLF, markLF, parseEntityName, parseFNameForError, parseFullName, parseFullName, parseFullName2, parseLocalName, parseLocalName2, parsePublicId, parseSystemId, parseUntil, peekNext, pushback, reportProblem, reportProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, resolveCharOnlyEntity, resolveNonCharEntity, resolveSimpleEntity, skipCRLF, skipFullName, throwFromIOE, throwFromStrE, throwInvalidSpace, throwInvalidSpace, throwLazyError, throwNullChar, throwNullParent, throwParseError, throwParseError, throwUnexpectedChar, throwUnexpectedEOB, throwUnexpectedEOF, throwWfcException, tokenTypeDesc, verifyLimitcopyBufferStateFrom, findIllegalNameChar, findIllegalNmtokenChar, getCharDesc, isNameChar, isNameChar, isNameStartChar, isNameStartChar, isSpaceCharclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetAttributeAs, getAttributeAsArray, getAttributeAsBinary, getAttributeAsBinary, getAttributeAsBoolean, getAttributeAsDecimal, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsInteger, getAttributeAsLong, getAttributeAsLongArray, getAttributeAsQName, getAttributeIndex, getElementAs, getElementAsBinary, getElementAsBinary, getElementAsBoolean, getElementAsDecimal, getElementAsDouble, getElementAsFloat, getElementAsInt, getElementAsInteger, getElementAsLong, getElementAsQName, readElementAsArray, readElementAsBinary, readElementAsBinary, readElementAsDoubleArray, readElementAsFloatArray, readElementAsIntArray, readElementAsLongArrayprotected static final int MASK_GET_TEXT
getText() method
can be called.protected static final int MASK_GET_TEXT_XXX
getTextXxx
methods can be called; which is less than those for which
getText() can be called. Specifically, DTD and
ENTITY_REFERENCE types do not support these extendedprotected static final int MASK_GET_TEXT_WITH_WRITER
protected static final int MASK_GET_ELEMENT_TEXT
protected static final String sPrefixXml
protected static final String sPrefixXmlns
protected final int mConfigFlags
protected final boolean mCfgCoalesceText
protected final boolean mCfgReportTextAsChars
protected final boolean mCfgLazyParsing
protected final int mShortestTextSegment
protected final ReaderCreator mOwner
protected int mDocStandalone
protected String mRootPrefix
protected String mRootLName
protected String mDtdPublicId
protected String mDtdSystemId
protected final TextBuffer mTextBuffer
protected final InputElementStack mElementStack
protected final AttributeCollector mAttrCollector
protected boolean mStDoctypeFound
protected int mTokenState
Initially set to fully tokenized, since it's the virtual START_DOCUMENT event that we fully know by now (parsed by bootstrapper)
protected final int mStTextThreshold
protected int mCurrTextLength
protected boolean mStEmptyElem
protected int mParseState
protected int mCurrToken
getEventType(). Needs to be initialized to START_DOCUMENT,
since that's the state it starts in.protected int mSecondaryToken
mCurrToken is already populated.protected int mWsStatus
protected boolean mValidateText
XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT,
and will prevent lazy parsing of text.protected int mCheckIndentation
protected XMLStreamException mPendingException
getText and its variations), we may need
to delay throwing an exception until next() is called next
time. If so, this variable holds the pending stream exception.protected Map<String,EntityDecl> mGeneralEntities
protected int mVldContent
XMLValidator,
(like XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT).
Only used inside tree; ignored for prolog/epilog (which
have straight-forward static rules).protected boolean mReturnNullForDefaultNamespace
WstxInputProperties#RETURN_NULL_FOR_DEFAULT_NAMESPACEprotected BasicStreamReader(InputBootstrapper bs, BranchingReaderSource input, ReaderCreator owner, ReaderConfig cfg, InputElementStack elemStack, boolean forER) throws XMLStreamException
elemStack - Input element stack to use; if null, will create
instance locally.forER - Override indicator; if true, this stream reader will be
used by an event reader, and should modify some of the base config
settings appropriately. If false, configuration settings are to
be used as is.XMLStreamExceptionprotected static InputElementStack createElementStack(ReaderConfig cfg)
public String getCharacterEncodingScheme()
Note: method name is rather confusing (compare to getEncoding()).
getCharacterEncodingScheme in interface XMLStreamReaderpublic String getEncoding()
Reader), it should return null.getEncoding in interface XMLStreamReaderpublic String getVersion()
getVersion in interface XMLStreamReaderpublic boolean isStandalone()
isStandalone in interface XMLStreamReaderpublic boolean standaloneSet()
standaloneSet in interface XMLStreamReaderpublic Object getProperty(String name)
getProperty in interface XMLStreamReaderpublic int getAttributeCount()
getAttributeCount in interface XMLStreamReaderpublic String getAttributeLocalName(int index)
getAttributeLocalName in interface XMLStreamReaderpublic QName getAttributeName(int index)
getAttributeName in interface XMLStreamReaderpublic String getAttributeNamespace(int index)
getAttributeNamespace in interface XMLStreamReaderpublic String getAttributePrefix(int index)
getAttributePrefix in interface XMLStreamReaderpublic String getAttributeType(int index)
getAttributeType in interface XMLStreamReaderpublic String getAttributeValue(int index)
getAttributeValue in interface XMLStreamReaderpublic String getAttributeValue(String nsURI, String localName)
getAttributeValue in interface XMLStreamReaderpublic String getElementText() throws XMLStreamException
Reads the content of a text-only element, an exception is thrown if this is not a text-only element. Regardless of value of javax.xml.stream.isCoalescing this method always returns coalesced content.
Precondition: the current event is START_ELEMENT.
Postcondition: the current event is the corresponding END_ELEMENT.
getElementText in interface XMLStreamReaderXMLStreamExceptionpublic int getEventType()
getEventType in interface XMLStreamReaderpublic String getLocalName()
getLocalName in interface XMLStreamReaderpublic QName getName()
getName in interface XMLStreamReaderpublic NamespaceContext getNamespaceContext()
getNamespaceContext in interface XMLStreamReaderpublic int getNamespaceCount()
getNamespaceCount in interface XMLStreamReaderpublic String getNamespacePrefix(int index)
getNamespacePrefix in interface XMLStreamReaderpublic String getNamespaceURI()
getNamespaceURI in interface XMLStreamReaderpublic String getNamespaceURI(int index)
getNamespaceURI in interface XMLStreamReaderpublic String getNamespaceURI(String prefix)
getNamespaceURI in interface XMLStreamReaderpublic String getPIData()
getPIData in interface XMLStreamReaderpublic String getPITarget()
getPITarget in interface XMLStreamReaderpublic String getPrefix()
getPrefix in interface XMLStreamReaderpublic String getText()
getText in interface XMLStreamReaderpublic char[] getTextCharacters()
getTextCharacters in interface XMLStreamReaderpublic int getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int len)
getTextCharacters in interface XMLStreamReaderpublic int getTextLength()
getTextLength in interface XMLStreamReaderpublic int getTextStart()
getTextStart in interface XMLStreamReaderpublic boolean hasName()
hasName in interface XMLStreamReaderpublic boolean hasNext()
hasNext in interface XMLStreamReaderpublic boolean hasText()
hasText in interface XMLStreamReaderpublic boolean isAttributeSpecified(int index)
isAttributeSpecified in interface XMLStreamReaderpublic boolean isCharacters()
isCharacters in interface XMLStreamReaderpublic boolean isEndElement()
isEndElement in interface XMLStreamReaderpublic boolean isStartElement()
isStartElement in interface XMLStreamReaderpublic boolean isWhiteSpace()
05-Apr-2004, TSa: Could try to determine status when text is actually read. That'd prevent double reads... but would it slow down that one reading so that net effect would be negative?
isWhiteSpace in interface XMLStreamReaderpublic void require(int type,
String nsUri,
String localName)
throws XMLStreamException
require in interface XMLStreamReaderXMLStreamExceptionpublic final int next()
throws XMLStreamException
next in interface XMLStreamReaderXMLStreamExceptionpublic int nextTag()
throws XMLStreamException
nextTag in interface XMLStreamReaderXMLStreamExceptionpublic void close()
throws XMLStreamException
Note: as per StAX 1.0 specs, this method does NOT close the underlying
input reader. That is, unless the new StAX2 property
XMLInputFactory2.P_AUTO_CLOSE_INPUT is
set to true.
close in interface XMLStreamReaderXMLStreamException@Deprecated public Object getFeature(String name)
getFeature in interface org.codehaus.stax2.XMLStreamReader2@Deprecated public void setFeature(String name, Object value)
setFeature in interface org.codehaus.stax2.XMLStreamReader2public boolean isPropertySupported(String name)
isPropertySupported in interface org.codehaus.stax2.XMLStreamReader2public boolean setProperty(String name, Object value)
setProperty in interface org.codehaus.stax2.XMLStreamReader2name - Name of the property to setvalue - Value to set property to.public void skipElement()
throws XMLStreamException
skipElement in interface org.codehaus.stax2.XMLStreamReader2XMLStreamExceptionpublic org.codehaus.stax2.AttributeInfo getAttributeInfo()
throws XMLStreamException
getAttributeInfo in interface org.codehaus.stax2.XMLStreamReader2XMLStreamExceptionpublic org.codehaus.stax2.DTDInfo getDTDInfo()
throws XMLStreamException
DTDInfo, method can just
return this.getDTDInfo in interface org.codehaus.stax2.XMLStreamReader2XMLStreamExceptionpublic final org.codehaus.stax2.LocationInfo getLocationInfo()
getLocationInfo in interface org.codehaus.stax2.XMLStreamReader2public int getText(Writer w, boolean preserveContents) throws IOException, XMLStreamException
getText(), except
that it just uses provided Writer to write all textual content.
For further optimization, it may also be allowed to do true
pass-through, thus possibly avoiding one temporary copy of the
data.
TODO: try to optimize to allow completely streaming pass-through: currently will still read all data in memory buffers before outputting
getText in interface org.codehaus.stax2.XMLStreamReader2w - Writer to use for writing textual contentspreserveContents - If true, reader has to preserve contents
so that further calls to getText will return
proper conntets. If false, reader is allowed to skip creation
of such copies: this can improve performance, but it also means
that further calls to getText is not guaranteed to
return meaningful data.IOExceptionXMLStreamExceptionpublic int getDepth()
getDepth in interface org.codehaus.stax2.XMLStreamReader2public boolean isEmptyElement()
throws XMLStreamException
isEmptyElement in interface org.codehaus.stax2.XMLStreamReader2'/>');
false otherwise.XMLStreamExceptionpublic NamespaceContext getNonTransientNamespaceContext()
getNonTransientNamespaceContext in interface org.codehaus.stax2.XMLStreamReader2public String getPrefixedName()
getPrefixedName in interface org.codehaus.stax2.XMLStreamReader2public void closeCompletely()
throws XMLStreamException
closeCompletely in interface org.codehaus.stax2.XMLStreamReader2XMLStreamExceptionpublic Object getProcessedDTD()
Note: DTD-handling sub-classes need to override this method.
getProcessedDTD in interface org.codehaus.stax2.DTDInfopublic String getDTDRootName()
getDTDRootName in interface org.codehaus.stax2.DTDInfopublic String getDTDPublicId()
getDTDPublicId in interface org.codehaus.stax2.DTDInfopublic String getDTDSystemId()
getDTDSystemId in interface org.codehaus.stax2.DTDInfopublic String getDTDInternalSubset()
getDTDInternalSubset in interface org.codehaus.stax2.DTDInfopublic org.codehaus.stax2.validation.DTDValidationSchema getProcessedDTDSchema()
getProcessedDTDSchema in interface org.codehaus.stax2.DTDInfopublic long getStartingByteOffset()
getStartingByteOffset in interface org.codehaus.stax2.LocationInfopublic long getStartingCharOffset()
getStartingCharOffset in interface org.codehaus.stax2.LocationInfopublic long getEndingByteOffset()
throws XMLStreamException
getEndingByteOffset in interface org.codehaus.stax2.LocationInfoXMLStreamExceptionpublic long getEndingCharOffset()
throws XMLStreamException
getEndingCharOffset in interface org.codehaus.stax2.LocationInfoXMLStreamExceptionpublic final Location getLocation()
StreamScannergetLocation in interface InputProblemReportergetLocation in interface XMLStreamReadergetLocation in interface org.codehaus.stax2.LocationInfogetLocation in class StreamScannerpublic final org.codehaus.stax2.XMLStreamLocation2 getEndLocation()
throws XMLStreamException
getEndLocation in interface org.codehaus.stax2.LocationInfoXMLStreamExceptionpublic org.codehaus.stax2.validation.XMLValidator validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
throws XMLStreamException
validateAgainst in interface org.codehaus.stax2.validation.ValidatableXMLStreamExceptionpublic org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
throws XMLStreamException
stopValidatingAgainst in interface org.codehaus.stax2.validation.ValidatableXMLStreamExceptionpublic org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator)
throws XMLStreamException
stopValidatingAgainst in interface org.codehaus.stax2.validation.ValidatableXMLStreamExceptionpublic org.codehaus.stax2.validation.ValidationProblemHandler setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h)
setValidationProblemHandler in interface org.codehaus.stax2.validation.Validatablepublic EntityDecl getCurrentEntityDecl()
getCurrentEntityDecl in interface StreamReaderImplpublic Object withStartElement(ElemCallback cb, Location loc)
DefaultEventAllocator
to get double-indirection necessary for constructing start element
events.withStartElement in interface StreamReaderImplpublic boolean isNamespaceAware()
isNamespaceAware in interface StreamReaderImplpublic InputElementStack getInputElementStack()
getInputElementStack in interface StreamReaderImplpublic AttributeCollector getAttributeCollector()
getAttributeCollector in interface StreamReaderImplpublic void fireSaxStartElement(ContentHandler h, Attributes attrs) throws SAXException
SAXExceptionpublic void fireSaxEndElement(ContentHandler h) throws SAXException
SAXExceptionpublic void fireSaxCharacterEvents(ContentHandler h) throws XMLStreamException, SAXException
XMLStreamExceptionSAXExceptionpublic void fireSaxSpaceEvents(ContentHandler h) throws XMLStreamException, SAXException
XMLStreamExceptionSAXExceptionpublic void fireSaxCommentEvent(LexicalHandler h) throws XMLStreamException, SAXException
XMLStreamExceptionSAXExceptionpublic void fireSaxPIEvent(ContentHandler h) throws XMLStreamException, SAXException
XMLStreamExceptionSAXExceptionprotected final boolean hasConfigFlags(int flags)
protected String checkKeyword(char c, String expected) throws XMLStreamException
XMLStreamExceptionprotected void checkCData()
throws XMLStreamException
XMLStreamExceptionprotected void handleRootElem(char c)
throws XMLStreamException
XMLStreamExceptionprotected void initValidation()
throws XMLStreamException
XMLStreamExceptionprotected int handleEOF(boolean isProlog)
throws XMLStreamException
XMLStreamExceptionprotected int handleMultiDocStart(int nextEvent)
protected void handleMultiDocXmlDecl()
throws XMLStreamException
XMLStreamExceptionprotected final char skipEquals(String name, String eofMsg) throws XMLStreamException
XMLStreamExceptionprotected final void parseQuoted(String name, char quoteChar, TextBuffer tbuf) throws XMLStreamException
Note: since it'll be called at most 3 times per document, this method is not optimized too much.
XMLStreamExceptionprotected void finishDTD(boolean copyContents)
throws XMLStreamException
NOTE: Since this default implementation will be overridden by some sub-classes, make sure you do NOT change the method signature.
copyContents - If true, will copy contents of the internal
subset of DOCTYPE declaration
in the text buffer; if false, will just completely ignore the
subset (if one found).XMLStreamExceptionprotected final void readEndElem()
throws XMLStreamException
XMLStreamExceptionprotected void ensureFinishToken()
throws XMLStreamException
XMLStreamExceptionprotected void safeEnsureFinishToken()
protected void safeFinishToken()
protected void finishToken(boolean deferErrors)
throws XMLStreamException
deferErrors - Flag to enable storing an exception to a
variable, instead of immediately throwing it. If true, will
just store the exception; if false, will not store, just throw.XMLStreamExceptionprotected void readCoalescedText(int currType,
boolean deferErrors)
throws XMLStreamException
deferErrors - Flag to enable storing an exception to a
variable, instead of immediately throwing it. If true, will
just store the exception; if false, will not store, just throw.XMLStreamExceptionprotected boolean readCDataSecondary(int shortestSegment)
throws XMLStreamException
XMLStreamExceptionprotected final boolean readTextSecondary(int shortestSegment,
boolean deferErrors)
throws XMLStreamException
deferErrors - Flag to enable storing an exception to a
variable, instead of immediately throwing it. If true, will
just store the exception; if false, will not store, just throw.'<' was hit,
or in non-entity-expanding mode, a non-char entity); false if
it may still continueXMLStreamExceptionprotected final boolean skipWS(char c)
throws XMLStreamException
XMLStreamExceptionprotected EntityDecl findEntity(String id, Object arg) throws XMLStreamException
StreamScannerfindEntity in class StreamScannerid - Identifier of the entity to findarg - Optional argument passed from caller; needed by DTD
reader.XMLStreamExceptionprotected void handleUndeclaredEntity(String id) throws XMLStreamException
StreamScannerhandleUndeclaredEntity in class StreamScannerXMLStreamExceptionprotected void handleIncompleteEntityProblem(WstxInputSource closing) throws XMLStreamException
handleIncompleteEntityProblem in class StreamScannerXMLStreamExceptionprotected void handleGreedyEntityProblem(WstxInputSource input) throws XMLStreamException
XMLStreamExceptionprotected void throwNotTextualOrElem(int type)
protected void throwUnexpectedEOF()
throws WstxException
WstxExceptionprotected XMLStreamException _constructUnexpectedInTyped(int nextToken)
protected org.codehaus.stax2.typed.TypedXMLStreamException _constructTypeException(String msg, String lexicalValue)
protected void reportInvalidContent(int evtType)
throws XMLStreamException
evtType - Type of event that contained unexpected contentXMLStreamExceptionCopyright © 2019 FasterXML. All rights reserved.