Package com.fasterxml.jackson.dataformat.xml.deser

Class XmlTokenStream

java.lang.Object

com.fasterxml.jackson.dataformat.xml.deser.XmlTokenStream

public class XmlTokenStream
extends Object

Simple helper class used on top of STAX XMLStreamReader to further abstract out all irrelevant details, and to expose equivalent of flat token stream with no "fluff" tokens (comments, processing instructions, mixed content) all of which is just to simplify actual higher-level conversion to JSON tokens.

Beyond initial idea there are also couple of other detours like ability to "replay" some tokens, add virtual wrappers (ironically to support "unwrapped" array values), and to unroll "Objects" into String values in some cases.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XML_ATTRIBUTE_NAME
static final int	XML_ATTRIBUTE_VALUE
static final int	XML_END
static final int	XML_END_ELEMENT
static final int	XML_ROOT_TEXT
static final int	XML_START_ELEMENT
static final int	XML_TEXT

Constructor Summary

Constructors

Constructor	Description
XmlTokenStream(XMLStreamReader xmlReader, ContentReference sourceRef, int formatFeatures, XmlNameProcessor nameProcessor)

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeCompletely()
JsonLocation	getCurrentLocation()
int	getCurrentToken()
String	getLocalName()	Accessor for local name of current named event (that is, XML_START_ELEMENT or XML_ATTRIBUTE_NAME).
String	getNamespaceURI()
String	getText()
JsonLocation	getTokenLocation()
org.codehaus.stax2.XMLStreamReader2	getXmlReader()
boolean	hasXsiNil()
int	initialize()	Second part of initialization, to be called immediately after construction
int	next()
void	skipEndElement()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XML_START_ELEMENT

public static final int XML_START_ELEMENT

See Also:

• Constant Field Values

XML_END_ELEMENT

public static final int XML_END_ELEMENT

See Also:

• Constant Field Values

XML_ATTRIBUTE_NAME

public static final int XML_ATTRIBUTE_NAME

See Also:

• Constant Field Values

XML_ATTRIBUTE_VALUE

public static final int XML_ATTRIBUTE_VALUE

See Also:

• Constant Field Values

XML_TEXT

public static final int XML_TEXT

See Also:

• Constant Field Values

XML_ROOT_TEXT

public static final int XML_ROOT_TEXT

See Also:

• Constant Field Values

XML_END

public static final int XML_END

See Also:

• Constant Field Values

Constructor Details

XmlTokenStream

public XmlTokenStream(XMLStreamReader xmlReader,
 ContentReference sourceRef,
 int formatFeatures,
 XmlNameProcessor nameProcessor)

Method Details

initialize

public int initialize()
               throws XMLStreamException

Second part of initialization, to be called immediately after construction

Throws:

XMLStreamException

Since:

2.12

getXmlReader

public org.codehaus.stax2.XMLStreamReader2 getXmlReader()

next

public int next()
         throws XMLStreamException

Throws:

XMLStreamException

skipEndElement

public void skipEndElement()
                    throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

getCurrentToken

public int getCurrentToken()

getText

public String getText()

getLocalName

public String getLocalName()

Accessor for local name of current named event (that is, XML_START_ELEMENT or XML_ATTRIBUTE_NAME).

NOTE: name NOT accessible on XML_END_ELEMENT

getNamespaceURI

public String getNamespaceURI()

hasXsiNil

public boolean hasXsiNil()

closeCompletely

public void closeCompletely()
                     throws XMLStreamException

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Throws:

XMLStreamException

getCurrentLocation

public JsonLocation getCurrentLocation()

getTokenLocation

public JsonLocation getTokenLocation()