Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ctc.wstx.sr
Class BasicStreamReader

java.lang.Object
  extended by com.ctc.wstx.io.WstxInputData
      extended by com.ctc.wstx.sr.StreamScanner
          extended by com.ctc.wstx.sr.BasicStreamReader
All Implemented Interfaces:
InputConfigFlags, ParsingErrorMsgs, InputProblemReporter, StreamReaderImpl, javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader, DTDInfo, LocationInfo, Validatable, XMLStreamReader2
Direct Known Subclasses:
ValidatingStreamReader
public class BasicStreamReader
extends StreamScanner
implements StreamReaderImpl, DTDInfo, LocationInfo

Implementation of XMLStreamReader2 that implements non-DTD aware parts of XML handling (plus some minimal support for parsing DOCTYPE declaration and skipping internal DTD subset if necessary). It can be used as is, and it is also the superclass of the DTD-aware implementation(s).

This class is also the lowest common denominator for all actual XMLStreamReader2 implementations Woodstox will ever create.

About interfaces implemented: XMLStreamReader2 is part of StAX2, and implemented as the "main" interface. Implementing DTDInfo is just an implementation detail; it could be implemented as a separate Object if necessary.

Field Summary
protected static java.lang.String DEFAULT_NS_PREFIX
          StAX API expects null to indicate "no prefix", not an empty String...
protected  AttributeCollector mAttrCollector
          Object that stores information about currently accessible attributes.
protected  boolean mCfgCoalesceText
           
protected  boolean mCfgLazyParsing
           
protected  boolean mCfgNormalizeAttrs
           
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  EntityDecl mCurrEntity
          Entity reference stream currently points to; only used when in non-automatically expanding mode.
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  java.lang.String mDtdPublicId
          Public id of the DTD, if one exists and has been parsed.
protected  java.lang.String mDtdSystemId
          System id of the DTD, if one exists and has been parsed.
protected  InputElementStack mElementStack
          Currently open element tree
protected  java.util.Map 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  javax.xml.stream.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  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 java.lang.String sPrefixXml
           
protected static java.lang.String sPrefixXmlns
           
 
Fields inherited from class com.ctc.wstx.sr.StreamScanner
CHAR_CR_LF_OR_NULL, CHAR_FIRST_PURE_TEXT, CHAR_LOWEST_LEGAL_LOCALNAME_CHAR, INT_CR_LF_OR_NULL, mCfgNormalizeLFs, mCfgNsEnabled, mCfgReplaceEntities, mConfig, mCurrDepth, mCurrName, mDocXmlVersion, mInput, mInputTopDepth, mNameBuffer, mRootInput, mTokenInputCol, mTokenInputRow, mTokenInputTotal, SAX_COMPAT_MODE
 
Fields inherited from class com.ctc.wstx.io.WstxInputData
CHAR_NULL, CHAR_SPACE, INT_NULL, INT_SPACE, MAX_UNICODE_CHAR, mCurrInputProcessed, mCurrInputRow, mCurrInputRowStart, mInputBuffer, mInputLen, mInputPtr, mXml11
 
Fields inherited from interface org.codehaus.stax2.XMLStreamReader2
FEATURE_DTD_OVERRIDE
 
Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
 
Fields inherited from interface com.ctc.wstx.cfg.InputConfigFlags
CFG_AUTO_CLOSE_INPUT, CFG_CACHE_DTDS, CFG_CACHE_DTDS_BY_PUBLIC_ID, CFG_COALESCE_TEXT, CFG_INTERN_NS_URIS, CFG_LAZY_PARSING, CFG_NAMESPACE_AWARE, CFG_NORMALIZE_ATTR_VALUES, 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_VALIDATE_AGAINST_DTD, CFG_VALIDATE_TEXT_CHARS, CFG_XMLID_TYPING, CFG_XMLID_UNIQ_CHECKS
 
Fields inherited from interface com.ctc.wstx.cfg.ParsingErrorMsgs
SUFFIX_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
 
Constructor Summary
protected BasicStreamReader(InputBootstrapper bs, BranchingReaderSource input, ReaderCreator owner, ReaderConfig cfg, InputElementStack elemStack, boolean forER)
           
 
Method Summary
protected  void checkCData()
           
protected  java.lang.String checkKeyword(char c, java.lang.String expected)
           
 void close()
           Note: as per StAX 1.0 specs, this method does NOT close the underlying input reader.
 void closeCompletely()
          Method similar to XMLStreamReader.getNamespaceContext(), except that this method also does close the underlying input source if it has not yet been closed.
static BasicStreamReader createBasicStreamReader(BranchingReaderSource input, ReaderCreator owner, ReaderConfig cfg, InputBootstrapper bs, boolean forER)
          Factory method for constructing readers.
protected static InputElementStack createElementStack(ReaderConfig cfg)
           
protected  void ensureFinishToken()
           
protected  EntityDecl findEntity(java.lang.String id, java.lang.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.
 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()
           
 AttributeInfo getAttributeInfo()
          Method that can be called to get additional information about attributes related to the current start element, as well as related DTD-based information if available.
 java.lang.String getAttributeLocalName(int index)
           
 javax.xml.namespace.QName getAttributeName(int index)
           
 java.lang.String getAttributeNamespace(int index)
           
 java.lang.String getAttributePrefix(int index)
           
 java.lang.String getAttributeType(int index)
           
 java.lang.String getAttributeValue(int index)
           
 java.lang.String getAttributeValue(java.lang.String nsURI, java.lang.String localName)
           
 java.lang.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()
          Method that returns the number of open elements in the stack; 0 when the reader is in prolog/epilog, 1 inside root element and so on.
 DTDInfo getDTDInfo()
          Since this class implements DTDInfo, method can just return this.
 java.lang.String getDTDInternalSubset()
           
 java.lang.String getDTDPublicId()
           
 java.lang.String getDTDRootName()
           
 java.lang.String getDTDSystemId()
           
 java.lang.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.
 java.lang.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()
          Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event.
 long getEndingCharOffset()
          Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right after the end of the current event.
 XMLStreamLocation2 getEndLocation()
          An optional method that either returns the location object that points the ending position of the current event, or null if implementation does not keep track of it (some may return only start location; and some no location at all).
 int getEventType()
          Returns type of the last event returned; or START_DOCUMENT before any events has been explicitly returned.
 java.lang.Object getFeature(java.lang.String name)
          Method that can be used to get per-reader values; both generic ones (names for which are defined as constants in this class), and implementation dependant ones.
 InputElementStack getInputElementStack()
          Method needed by classes (like stream writer implementations) that want to have efficient direct access to element stack implementation
 java.lang.String getLocalName()
           
 javax.xml.stream.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).
 LocationInfo getLocationInfo()
          Location information is always accessible, for this reader.
 javax.xml.namespace.QName getName()
           
 javax.xml.namespace.NamespaceContext getNamespaceContext()
           
 int getNamespaceCount()
           
 java.lang.String getNamespacePrefix(int index)
           
 java.lang.String getNamespaceURI()
           
 java.lang.String getNamespaceURI(int index)
           
 java.lang.String getNamespaceURI(java.lang.String prefix)
           
 javax.xml.namespace.NamespaceContext getNonTransientNamespaceContext()
          This method returns a namespace contenxt object that contains information identical to that returned by XMLStreamReader.getNamespaceContext(), but one that is not transient.
 java.lang.String getPIData()
           
 java.lang.String getPITarget()
           
 java.lang.String getPrefix()
           
 java.lang.String getPrefixedName()
          This method returns "prefix-qualified" name of the current element.
 java.lang.Object getProcessedDTD()
           Note: DTD-handling sub-classes need to override this method.
 DTDValidationSchema getProcessedDTDSchema()
          Sub-class will override this method
 java.lang.Object getProperty(java.lang.String name)
           
 long getStartingByteOffset()
          Method that can be used to get exact byte offset (number of bytes read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event.
 long getStartingCharOffset()
          Method that can be used to get exact character offset (number of chars read from the stream right before getting to this location) in the stream that is pointed to by this reader, right before the start of the current event.
 java.lang.String getText()
           
 int getText(java.io.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()
           
 java.lang.String getVersion()
           
protected  int handleEOF(boolean isProlog)
           
protected  char handleExpandedSurrogate(char first, char second)
          Method called when a character entity needs to expand to a pair of 16-bit surrogate characters.
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(java.lang.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()
          Method that can be used to check whether current START_ELEMENT event was created for an empty element (xml short-hand notation where one tag implies start and end, ending with "/>"), or not.
 boolean isEndElement()
           
 boolean isNamespaceAware()
           
 boolean isPropertySupported(java.lang.String name)
          Method similar to XMLInputFactory.isPropertySupported(java.lang.String), used to determine whether a property is supported by the Reader instance.
 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(java.lang.String name, char quoteChar, TextBuffer tbuf)
          Method called to parse quoted xml declaration pseudo-attribute values.
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, java.lang.String nsUri, java.lang.String localName)
           
protected  void safeEnsureFinishToken()
           
protected  void safeFinishToken()
           
 void setFeature(java.lang.String name, java.lang.Object value)
          Method that can be used to set per-reader features such as configuration settings; both generic ones (names for which are defined as constants in this class), and implementation dependant ones.
 boolean setProperty(java.lang.String name, java.lang.Object value)
          Method that can be used to set per-reader properties; a subset of properties one can set via matching XMLInputFactory2 instance.
 ValidationProblemHandler setValidationProblemHandler(ValidationProblemHandler h)
          Method that application can call to define a custom handler for validation problems encountered during validation process.
 void skipElement()
          Method that will skip all the contents of the element that the stream currently points to.
protected  char skipEquals(java.lang.String name, java.lang.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()
           
 XMLValidator stopValidatingAgainst(XMLValidationSchema schema)
          Method that can be called by application to stop validating output against a schema, for which Validatable.validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema) was called earlier.
 XMLValidator stopValidatingAgainst(XMLValidator validator)
          Method that can be called by application to stop validating output using specified validator.
 XMLValidator validateAgainst(XMLValidationSchema schema)
          Method that will construct a XMLValidator instance from the given schema (unless a validator for that schema has already been added), initialize it if necessary, and make validatable object (reader, writer) call appropriate validation methods from this point on until the end of the document (that is, it's not scoped with sub-trees), or until validator is removed by an explicit call to Validatable.stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema).
 java.lang.Object withStartElement(ElemCallback cb, javax.xml.stream.Location loc)
          Method called by DefaultEventAllocator to get double-indirection necessary for constructing start element events.
protected  void wrappedFinishToken()
           
 
Methods inherited from class com.ctc.wstx.sr.StreamScanner
closeAllInput, constructFromIoe, constructNullCharException, constructWfcException, doReportProblem, ensureInput, expandBy50Pct, expandEntity, fullyResolveEntity, getCurrentInput, getCurrentLocation, 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, reportProblem, reportProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, resolveCharOnlyEntity, resolveNonCharEntity, resolveSimpleEntity, skipCRLF, skipFullName, throwFromIOE, throwFromStrE, throwIllegalCall, throwInvalidSpace, throwInvalidSpace, throwLazyError, throwNullChar, throwNullParent, throwParseError, throwParseError, throwParseError, throwUnexpectedChar, throwUnexpectedEOB, throwUnexpectedEOF, throwWfcException, tokenTypeDesc
 
Methods inherited from class com.ctc.wstx.io.WstxInputData
copyBufferStateFrom, findIllegalNameChar, findIllegalNmtokenChar, getCharDesc, isNameChar, isNameChar, isNameStartChar, isNameStartChar, isSpaceChar
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.codehaus.stax2.LocationInfo
getCurrentLocation, getStartLocation
 

Field Detail

DEFAULT_NS_PREFIX

protected static final java.lang.String DEFAULT_NS_PREFIX
StAX API expects null to indicate "no prefix", not an empty String...

mConfigFlags

protected final int mConfigFlags
Set of locally stored configuration flags

mCfgCoalesceText

protected final boolean mCfgCoalesceText

mCfgNormalizeAttrs

protected final boolean mCfgNormalizeAttrs

mCfgReportTextAsChars

protected final boolean mCfgReportTextAsChars

mCfgLazyParsing

protected final boolean mCfgLazyParsing

mShortestTextSegment

protected final int mShortestTextSegment
Minimum number of characters parser can return as partial text segment, IF it's not required to coalesce adjacent text segments.

sPrefixXml

protected static final java.lang.String sPrefixXml

sPrefixXmlns

protected static final java.lang.String sPrefixXmlns

mOwner

protected final ReaderCreator mOwner
Object to notify about shared stuff, such as symbol tables, as well as to query for additional config settings if necessary.

mDocStandalone

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.

mDtdPublicId

protected java.lang.String mDtdPublicId
Public id of the DTD, if one exists and has been parsed.

mDtdSystemId

protected java.lang.String mDtdSystemId
System id of the DTD, if one exists and has been parsed.

mTextBuffer

protected final TextBuffer mTextBuffer
TextBuffer mostly used to collect non-element textual content (text, CDATA, comment content, pi data)

mElementStack

protected final InputElementStack mElementStack
Currently open element tree

mAttrCollector

protected final AttributeCollector mAttrCollector
Object that stores information about currently accessible attributes.

mStDoctypeFound

protected boolean mStDoctypeFound

mTokenState

protected int mTokenState
State of the current token; one of M_ - constants from above.

Initially set to fully tokenized, since it's the virtual START_DOCUMENT event that we fully know by now (parsed by bootstrapper)

mStTextThreshold

protected final 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)

mStEmptyElem

protected boolean mStEmptyElem

mCurrToken

protected int mCurrToken
Current state of the stream, ie token value returned by getEventType(). Needs to be initialized to START_DOCUMENT, since that's the state it starts in.

mSecondaryToken

protected int mSecondaryToken
Additional information sometimes stored (when generating dummy events in multi-doc mode, for example) temporarily when mCurrToken is already populated.

mWsStatus

protected int mWsStatus
Status of current (text) token's "whitespaceness", that is, whether it is or is not all white space.

mValidateText

protected boolean mValidateText
Flag that indicates that textual content (CDATA, CHARACTERS) is to be validated within current element's scope. Enabled if one of validators returns XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT, and will prevent lazy parsing of text.

mCheckIndentation

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

mPendingException

protected javax.xml.stream.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. If so, this variable holds the pending stream exception.

mGeneralEntities

protected java.util.Map mGeneralEntities
Entities parsed from internal/external DTD subsets. Although it will remain null for this class, extended classes make use of it, plus, to be able to share some of entity resolution code, instance is left here even though it semantically belongs to the sub-class.

mCurrEntity

protected EntityDecl mCurrEntity
Entity reference stream currently points to; only used when in non-automatically expanding mode.

mVldContent

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. Constants come from XMLValidator, (like XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT). Only used inside tree; ignored for prolog/epilog (which have straight-forward static rules).

Constructor Detail

BasicStreamReader

protected BasicStreamReader(InputBootstrapper bs,
                            BranchingReaderSource input,
                            ReaderCreator owner,
                            ReaderConfig cfg,
                            InputElementStack elemStack,
                            boolean forER)
                     throws java.io.IOException,
                            javax.xml.stream.XMLStreamException
Parameters:
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.
Throws:
java.io.IOException
javax.xml.stream.XMLStreamException
Method Detail

createBasicStreamReader

public static BasicStreamReader createBasicStreamReader(BranchingReaderSource input,
                                                        ReaderCreator owner,
                                                        ReaderConfig cfg,
                                                        InputBootstrapper bs,
                                                        boolean forER)
                                                 throws java.io.IOException,
                                                        javax.xml.stream.XMLStreamException
Factory method for constructing readers.

Parameters:
owner - "Owner" of this reader, factory that created the reader; needed for returning updated symbol table information after parsing.
input - Input source used to read the XML document.
cfg - Object that contains reader configuration info.
Throws:
java.io.IOException
javax.xml.stream.XMLStreamException

createElementStack

protected static InputElementStack createElementStack(ReaderConfig cfg)

getCharacterEncodingScheme

public java.lang.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.

Note: method name is rather confusing (compare to getEncoding()).

Specified by:
getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader

getEncoding

public java.lang.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. If not (there are cases where this can not be found; specifically when being passed a Reader), it should return null.

Specified by:
getEncoding in interface javax.xml.stream.XMLStreamReader

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface javax.xml.stream.XMLStreamReader

isStandalone

public boolean isStandalone()
Specified by:
isStandalone in interface javax.xml.stream.XMLStreamReader

standaloneSet

public boolean standaloneSet()
Specified by:
standaloneSet in interface javax.xml.stream.XMLStreamReader

getProperty

public java.lang.Object getProperty(java.lang.String name)
Specified by:
getProperty in interface javax.xml.stream.XMLStreamReader

getAttributeCount

public int getAttributeCount()
Specified by:
getAttributeCount in interface javax.xml.stream.XMLStreamReader

getAttributeLocalName

public java.lang.String getAttributeLocalName(int index)
Specified by:
getAttributeLocalName in interface javax.xml.stream.XMLStreamReader

getAttributeName

public javax.xml.namespace.QName getAttributeName(int index)
Specified by:
getAttributeName in interface javax.xml.stream.XMLStreamReader

getAttributeNamespace

public java.lang.String getAttributeNamespace(int index)
Specified by:
getAttributeNamespace in interface javax.xml.stream.XMLStreamReader

getAttributePrefix

public java.lang.String getAttributePrefix(int index)
Specified by:
getAttributePrefix in interface javax.xml.stream.XMLStreamReader

getAttributeType

public java.lang.String getAttributeType(int index)
Specified by:
getAttributeType in interface javax.xml.stream.XMLStreamReader

getAttributeValue

public java.lang.String getAttributeValue(int index)
Specified by:
getAttributeValue in interface javax.xml.stream.XMLStreamReader

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String nsURI,
                                          java.lang.String localName)
Specified by:
getAttributeValue in interface javax.xml.stream.XMLStreamReader

getElementText

public java.lang.String getElementText()
                                throws javax.xml.stream.XMLStreamException
From StAX specs:
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.

Specified by:
getElementText in interface javax.xml.stream.XMLStreamReader
Throws:
javax.xml.stream.XMLStreamException

getEventType

public int getEventType()
Returns type of the last event returned; or START_DOCUMENT before any events has been explicitly returned.

Specified by:
getEventType in interface javax.xml.stream.XMLStreamReader

getLocalName

public java.lang.String getLocalName()
Specified by:
getLocalName in interface javax.xml.stream.XMLStreamReader

getName

public javax.xml.namespace.QName getName()
Specified by:
getName in interface javax.xml.stream.XMLStreamReader

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()
Specified by:
getNamespaceContext in interface javax.xml.stream.XMLStreamReader

getNamespaceCount

public int getNamespaceCount()
Specified by:
getNamespaceCount in interface javax.xml.stream.XMLStreamReader

getNamespacePrefix

public java.lang.String getNamespacePrefix(int index)
Specified by:
getNamespacePrefix in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI()
Specified by:
getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI(int index)
Specified by:
getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)
Specified by:
getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getPIData

public java.lang.String getPIData()
Specified by:
getPIData in interface javax.xml.stream.XMLStreamReader

getPITarget

public java.lang.String getPITarget()
Specified by:
getPITarget in interface javax.xml.stream.XMLStreamReader

getPrefix

public java.lang.String getPrefix()
Specified by:
getPrefix in interface javax.xml.stream.XMLStreamReader

getText

public java.lang.String getText()
Specified by:
getText in interface javax.xml.stream.XMLStreamReader

getTextCharacters

public char[] getTextCharacters()
Specified by:
getTextCharacters in interface javax.xml.stream.XMLStreamReader

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int len)
Specified by:
getTextCharacters in interface javax.xml.stream.XMLStreamReader

getTextLength

public int getTextLength()
Specified by:
getTextLength in interface javax.xml.stream.XMLStreamReader

getTextStart

public int getTextStart()
Specified by:
getTextStart in interface javax.xml.stream.XMLStreamReader

hasName

public boolean hasName()
Specified by:
hasName in interface javax.xml.stream.XMLStreamReader

hasNext

public boolean hasNext()
Specified by:
hasNext in interface javax.xml.stream.XMLStreamReader

hasText

public boolean hasText()
Specified by:
hasText in interface javax.xml.stream.XMLStreamReader

isAttributeSpecified

public boolean isAttributeSpecified(int index)
Specified by:
isAttributeSpecified in interface javax.xml.stream.XMLStreamReader

isCharacters

public boolean isCharacters()
Specified by:
isCharacters in interface javax.xml.stream.XMLStreamReader

isEndElement

public boolean isEndElement()
Specified by:
isEndElement in interface javax.xml.stream.XMLStreamReader

isStartElement

public boolean isStartElement()
Specified by:
isStartElement in interface javax.xml.stream.XMLStreamReader

isWhiteSpace

public 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?

Specified by:
isWhiteSpace in interface javax.xml.stream.XMLStreamReader

require

public void require(int type,
                    java.lang.String nsUri,
                    java.lang.String localName)
             throws javax.xml.stream.XMLStreamException
Specified by:
require in interface javax.xml.stream.XMLStreamReader
Throws:
javax.xml.stream.XMLStreamException

next

public final int next()
               throws javax.xml.stream.XMLStreamException
Specified by:
next in interface javax.xml.stream.XMLStreamReader
Throws:
javax.xml.stream.XMLStreamException

nextTag

public int nextTag()
            throws javax.xml.stream.XMLStreamException
Specified by:
nextTag in interface javax.xml.stream.XMLStreamReader
Throws:
javax.xml.stream.XMLStreamException

close

public void close()
           throws javax.xml.stream.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.

Specified by:
close in interface javax.xml.stream.XMLStreamReader
Throws:
javax.xml.stream.XMLStreamException

getFeature

public java.lang.Object getFeature(java.lang.String name)
Description copied from interface: XMLStreamReader2
Method that can be used to get per-reader values; both generic ones (names for which are defined as constants in this class), and implementation dependant ones.

Note: although some feature names are shared with XMLStreamReader2.setFeature(java.lang.String, java.lang.Object), not all are: some features are read-only, some write-only

Specified by:
getFeature in interface XMLStreamReader2
Parameters:
name - Name of the feature of which value to get
Returns:
Value of the feature (possibly null), if supported; null otherwise

setFeature

public void setFeature(java.lang.String name,
                       java.lang.Object value)
Description copied from interface: XMLStreamReader2
Method that can be used to set per-reader features such as configuration settings; both generic ones (names for which are defined as constants in this class), and implementation dependant ones.

Note: although some feature names are shared with XMLStreamReader2.getFeature(java.lang.String), not all are: some features are read-only, some write-only

Specified by:
setFeature in interface XMLStreamReader2
Parameters:
name - Name of the feature to set
value - Value to set feature to.

isPropertySupported

public boolean isPropertySupported(java.lang.String name)
Description copied from interface: XMLStreamReader2
Method similar to XMLInputFactory.isPropertySupported(java.lang.String), used to determine whether a property is supported by the Reader instance. This means that this method may return false for some properties that the input factory does support: specifically, it should only return true if the value is mutable on per-instance basis. False means that either the property is not recognized, or is not mutable via reader instance.

Specified by:
isPropertySupported in interface XMLStreamReader2

setProperty

public boolean setProperty(java.lang.String name,
                           java.lang.Object value)
Description copied from interface: XMLStreamReader2
Method that can be used to set per-reader properties; a subset of properties one can set via matching XMLInputFactory2 instance. Exactly which methods are mutable is implementation specific.

Specified by:
setProperty in interface XMLStreamReader2
Parameters:
name - Name of the property to set
value - Value to set property to.
Returns:
True, if the specified property was succesfully set to specified value; false if its value was not changed

skipElement

public void skipElement()
                 throws javax.xml.stream.XMLStreamException
Description copied from interface: XMLStreamReader2
Method that will skip all the contents of the element that the stream currently points to. Current event when calling the method has to be START_ELEMENT (or otherwise IllegalStateException is thrown); after the call the stream will point to the matching END_ELEMENT event, having skipped zero or more intervening events for the contents.

Specified by:
skipElement in interface XMLStreamReader2
Throws:
javax.xml.stream.XMLStreamException

getAttributeInfo

public AttributeInfo getAttributeInfo()
                               throws javax.xml.stream.XMLStreamException
Description copied from interface: XMLStreamReader2
Method that can be called to get additional information about attributes related to the current start element, as well as related DTD-based information if available. Note that the reader has to currently point to START_ELEMENT; if not, a IllegalStateException will be thrown.

Specified by:
getAttributeInfo in interface