Package org.jibx.runtime.impl
Class XMLPullReaderFactory.XMLPullReader
java.lang.Object
org.jibx.runtime.impl.XMLPullReaderFactory.XMLPullReader
- All Implemented Interfaces:
IXMLReader
- Enclosing class:
XMLPullReaderFactory
Wrapper for an XMLPull parser implementation. Since the internal parser
API was originally based on XMLPull, this basically just delegates all
the calls with minimal processing.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate InByteBuffer
Byte buffer used when stream set directly (lazy create,null
if not used).private String
Document name.private String
Input document character encoding (null
if unknown)private final XmlPullParser
Actual parser.private InputStreamWrapper
Wrapper for supplied input stream (lazy create,null
if not used).Fields inherited from interface org.jibx.runtime.IXMLReader
CDSECT, COMMENT, DOCDECL, END_DOCUMENT, END_TAG, ENTITY_REF, IGNORABLE_WHITESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_TAG, TEXT
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
XMLPullReader
(XmlPullParser parser) Constructor used by factory. -
Method Summary
Modifier and TypeMethodDescriptionBuild current parse input position description.private String
Format error message from exception.int
Get the number of attributes of the current start tag.getAttributeName
(int index) Get an attribute name from the current start tag.getAttributeNamespace
(int index) Get an attribute namespace from the current start tag.getAttributePrefix
(int index) Get an attribute prefix from the current start tag.getAttributeValue
(int index) Get an attribute value from the current start tag.getAttributeValue
(String ns, String name) Get an attribute value from the current start tag.int
Get current source column number.Get document name.int
Gets the current parse event type, without changing the current parse state.Return the input encoding, if known.int
Get current source line number.getName()
Get element name from the current start or end tag.Get element namespace from the current start or end tag.getNamespace
(String prefix) Get namespace URI associated with prefix.int
getNamespaceCount
(int depth) Get number of namespace declarations active at depth.getNamespacePrefix
(int index) Get namespace prefix.getNamespaceUri
(int index) Get namespace URI.int
Get current element nesting depth.Get element prefix from the current start or end tag.getText()
Get current text.void
init()
Initialize reader.boolean
Return namespace processing flag.int
next()
Advance to next binding component of input document.int
Advance to next parse event of input document.private void
setDocument
(InputStream is, String name, String enc) Set document to be parsed from input stream.private void
setDocument
(Reader rdr, String name) Set document to be parsed from reader.
-
Field Details
-
m_parser
private final XmlPullParser m_parserActual parser. -
m_docName
Document name. -
m_byteBuffer
Byte buffer used when stream set directly (lazy create,null
if not used). -
m_streamWrapper
Wrapper for supplied input stream (lazy create,null
if not used). -
m_encoding
Input document character encoding (null
if unknown)
-
-
Constructor Details
-
XMLPullReader
private XMLPullReader(XmlPullParser parser) Constructor used by factory.- Parameters:
parser
-
-
-
Method Details
-
setDocument
Set document to be parsed from input stream.- Parameters:
is
- document input streamname
- document name (null
if unknown)enc
- document character encoding (null
if unknown)- Throws:
JiBXException
- on parser configuration error
-
setDocument
Set document to be parsed from reader.- Parameters:
rdr
- document readername
- document name (null
if unknown)- Throws:
JiBXException
- on parser configuration error
-
describeException
Format error message from exception.- Parameters:
e
- root cause exception
-
init
public void init()Description copied from interface:IXMLReader
Initialize reader.- Specified by:
init
in interfaceIXMLReader
-
buildPositionString
Description copied from interface:IXMLReader
Build current parse input position description.- Specified by:
buildPositionString
in interfaceIXMLReader
- Returns:
- text description of current parse position
-
nextToken
Description copied from interface:IXMLReader
Advance to next parse event of input document.- Specified by:
nextToken
in interfaceIXMLReader
- Returns:
- parse event type code
- Throws:
JiBXException
- if error reading or parsing document
-
next
Description copied from interface:IXMLReader
Advance to next binding component of input document. This is a higher-level operation thanIXMLReader.nextToken()
, which consolidates text content and ignores parse events for components such as comments and PIs.- Specified by:
next
in interfaceIXMLReader
- Returns:
- parse event type code
- Throws:
JiBXException
- if error reading or parsing document
-
getEventType
Description copied from interface:IXMLReader
Gets the current parse event type, without changing the current parse state.- Specified by:
getEventType
in interfaceIXMLReader
- Returns:
- parse event type code
- Throws:
JiBXException
- if error parsing document
-
getName
Description copied from interface:IXMLReader
Get element name from the current start or end tag.- Specified by:
getName
in interfaceIXMLReader
- Returns:
- local name if namespace handling enabled, full name if namespace handling disabled
-
getNamespace
Description copied from interface:IXMLReader
Get element namespace from the current start or end tag.- Specified by:
getNamespace
in interfaceIXMLReader
- Returns:
- namespace URI if namespace handling enabled and element is in a namespace, empty string otherwise
-
getPrefix
Description copied from interface:IXMLReader
Get element prefix from the current start or end tag.- Specified by:
getPrefix
in interfaceIXMLReader
- Returns:
- prefix text (
null
if no prefix)
-
getAttributeCount
public int getAttributeCount()Description copied from interface:IXMLReader
Get the number of attributes of the current start tag.- Specified by:
getAttributeCount
in interfaceIXMLReader
- Returns:
- number of attributes
-
getAttributeName
Description copied from interface:IXMLReader
Get an attribute name from the current start tag.- Specified by:
getAttributeName
in interfaceIXMLReader
- Parameters:
index
- attribute index- Returns:
- local name if namespace handling enabled, full name if namespace handling disabled
-
getAttributeNamespace
Description copied from interface:IXMLReader
Get an attribute namespace from the current start tag.- Specified by:
getAttributeNamespace
in interfaceIXMLReader
- Parameters:
index
- attribute index- Returns:
- namespace URI if namespace handling enabled and attribute is in a namespace, empty string otherwise
-
getAttributePrefix
Description copied from interface:IXMLReader
Get an attribute prefix from the current start tag.- Specified by:
getAttributePrefix
in interfaceIXMLReader
- Parameters:
index
- attribute index- Returns:
- prefix for attribute (
null
if no prefix present)
-
getAttributeValue
Description copied from interface:IXMLReader
Get an attribute value from the current start tag.- Specified by:
getAttributeValue
in interfaceIXMLReader
- Parameters:
index
- attribute index- Returns:
- value text
-
getAttributeValue
Description copied from interface:IXMLReader
Get an attribute value from the current start tag.- Specified by:
getAttributeValue
in interfaceIXMLReader
- Parameters:
ns
- namespace URI for expected attribute (may benull
or the empty string for the empty namespace)name
- attribute name expected- Returns:
- attribute value text, or
null
if missing
-
getText
Description copied from interface:IXMLReader
Get current text. When positioned on a TEXT event this returns the actual text; for CDSECT it returns the text inside the CDATA section; for COMMENT, DOCDECL, or PROCESSING_INSTRUCTION it returns the text inside the structure.- Specified by:
getText
in interfaceIXMLReader
- Returns:
- text for current event
-
getNestingDepth
public int getNestingDepth()Description copied from interface:IXMLReader
Get current element nesting depth. The returned depth always includes the current start or end tag (if positioned on a start or end tag).- Specified by:
getNestingDepth
in interfaceIXMLReader
- Returns:
- element nesting depth
-
getNamespaceCount
public int getNamespaceCount(int depth) Description copied from interface:IXMLReader
Get number of namespace declarations active at depth.- Specified by:
getNamespaceCount
in interfaceIXMLReader
- Parameters:
depth
- element nesting depth- Returns:
- number of namespaces active at depth
-
getNamespaceUri
Description copied from interface:IXMLReader
Get namespace URI.- Specified by:
getNamespaceUri
in interfaceIXMLReader
- Parameters:
index
- declaration index- Returns:
- namespace URI
-
getNamespacePrefix
Description copied from interface:IXMLReader
Get namespace prefix.- Specified by:
getNamespacePrefix
in interfaceIXMLReader
- Parameters:
index
- declaration index- Returns:
- namespace prefix,
null
if a default namespace
-
getDocumentName
Description copied from interface:IXMLReader
Get document name.- Specified by:
getDocumentName
in interfaceIXMLReader
- Returns:
- document name,
null
if not known
-
getLineNumber
public int getLineNumber()Description copied from interface:IXMLReader
Get current source line number.- Specified by:
getLineNumber
in interfaceIXMLReader
- Returns:
- line number from source document,
-1
if line number information not available
-
getColumnNumber
public int getColumnNumber()Description copied from interface:IXMLReader
Get current source column number.- Specified by:
getColumnNumber
in interfaceIXMLReader
- Returns:
- column number from source document,
-1
if column number information not available
-
getNamespace
Description copied from interface:IXMLReader
Get namespace URI associated with prefix.- Specified by:
getNamespace
in interfaceIXMLReader
- Parameters:
prefix
- namespace prefix to be matched (null
for default namespace)- Returns:
- associated URI (
null
if prefix not defined)
-
getInputEncoding
Description copied from interface:IXMLReader
Return the input encoding, if known. This is only valid after parsing of a document has been started.- Specified by:
getInputEncoding
in interfaceIXMLReader
- Returns:
- input encoding (
null
if unknown)
-
isNamespaceAware
public boolean isNamespaceAware()Description copied from interface:IXMLReader
Return namespace processing flag.- Specified by:
isNamespaceAware
in interfaceIXMLReader
- Returns:
- namespace processing flag (
true
if namespaces are processed by reader,false
if not)
-