com.objsys.xbinder.stax

Class XMLStreamHelper

java.lang.Object

com.objsys.xbinder.stax.XMLStreamHelper

public class XMLStreamHelper
extends java.lang.Object

XMLStreamHelper provides helper methods for dealing with XMLStreamReader.

Constructor Summary

Constructors

Constructor and Description
XMLStreamHelper()

Method Summary

Modifier and Type	Method and Description
static void	assertEmptyElement(javax.xml.stream.XMLStreamReader reader) Throw an exception if the current element contains a child element or character data.
static void	assertEvent(javax.xml.stream.XMLStreamReader reader, int event) Check that the current event is of the given type.
static void	assertStartElement(javax.xml.stream.XMLStreamReader reader, java.lang.String elemNamespaceURI, java.lang.String elemName) Check that the current event is a START_ELEMENT for the given element.
static void	beginDocumentDecode(javax.xml.stream.XMLStreamReader reader) Begin document decoding by skipping all input up to the first start element.
static boolean	checkEmptyElement(javax.xml.stream.XMLStreamReader reader) This is a placeholder method that's needed for generated C# code, but not for generated Java code.
static void	decodeNamespaces(javax.xml.stream.XMLStreamReader reader, XBComplexType obj) Decode the namespaces on the current start event into the given object.
static void	decodeSchemaLocations(javax.xml.stream.XMLStreamReader reader, XBContext obj) Decode the xsi:schemaLocation and xsi:noSchemaLocation attributes into the given XBContext object.
static boolean	isElementNilled(javax.xml.stream.XMLStreamReader reader) Return true if the current element has a nil attribute set to "true".
static boolean	isEndContent(javax.xml.stream.XMLStreamReader reader) Returns TRUE if the reader is at an END_ELEMENT or END_DOCUMENT.
static boolean	moveToContentElement(javax.xml.stream.XMLStreamReader reader) This tries to locate the next content element, ie, the next element at the current level.
static java.lang.String	nameForEvent(int event)
static int	nextTagOrEndDocument(javax.xml.stream.XMLStreamReader reader) Skip comments, processing instructions, and whitespace until the next START_ELEMENT, END_ELEMENT, or END_DOCUMENT is found.
static java.lang.String	readContent(javax.xml.stream.XMLStreamReader reader) Read content for the current element into a raw XML string.
static java.lang.String	readElementAndContent(javax.xml.stream.XMLStreamReader reader) Read the current element and all of its content into a String.
static javax.xml.namespace.QName	readXsiType(javax.xml.stream.XMLStreamReader reader) Return the QName (or null) for the xsi:type attribute.
static void	skipToEndElement(javax.xml.stream.XMLStreamReader reader) Skip all events until an end element is found that closes the start element under which the current event is nested.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStreamHelper

public XMLStreamHelper()

Method Detail

assertEmptyElement

public static void assertEmptyElement(javax.xml.stream.XMLStreamReader reader)

Throw an exception if the current element contains a child element or character data.

assertEvent

public static void assertEvent(javax.xml.stream.XMLStreamReader reader,
                               int event)
                        throws XBException

Check that the current event is of the given type. If not, throw an exception. This method helps standardize error messages.

Parameters:

reader -

Throws:

XBException

assertStartElement

public static void assertStartElement(javax.xml.stream.XMLStreamReader reader,
                                      java.lang.String elemNamespaceURI,
                                      java.lang.String elemName)
                               throws XBException

Check that the current event is a START_ELEMENT for the given element. If not, throw an exception.

Parameters:

reader -

elemNamespaceURI - namespace URI of element

elemName - short name for element

Throws:

XBException

beginDocumentDecode

public static void beginDocumentDecode(javax.xml.stream.XMLStreamReader reader)
                                throws XBException

Begin document decoding by skipping all input up to the first start element.

Parameters:

reader -

Throws:

XBException

decodeNamespaces

public static void decodeNamespaces(javax.xml.stream.XMLStreamReader reader,
                                    XBComplexType obj)

Decode the namespaces on the current start event into the given object.

Parameters:

reader -

decodeSchemaLocations

public static void decodeSchemaLocations(javax.xml.stream.XMLStreamReader reader,
                                         XBContext obj)

Decode the xsi:schemaLocation and xsi:noSchemaLocation attributes into the given XBContext object.

Parameters:

reader - Should be on START_ELEMENT event.

obj -

nameForEvent

public static java.lang.String nameForEvent(int event)

isElementNilled

public static boolean isElementNilled(javax.xml.stream.XMLStreamReader reader)

Return true if the current element has a nil attribute set to "true". Current position must be start element.

Parameters:

reader -

Returns:

isEndContent

public static boolean isEndContent(javax.xml.stream.XMLStreamReader reader)

Returns TRUE if the reader is at an END_ELEMENT or END_DOCUMENT.

moveToContentElement

public static boolean moveToContentElement(javax.xml.stream.XMLStreamReader reader)
                                    throws javax.xml.stream.XMLStreamException

This tries to locate the next content element, ie, the next element at the current level. It begins by locating the next tag or end of document, skipping over non-content events (PI, comments, whitespace). If it encounters an end tag or end document before finding a start tag, it returns false (no more content at this level). If it encounters something other than a non-content event, start or end tag, or end of document, it throws an exception. Otherwise, it returns true, indicating the desired element was located.

Parameters:

reader -

Throws:

XBException

javax.xml.stream.XMLStreamException

nextTagOrEndDocument

public static int nextTagOrEndDocument(javax.xml.stream.XMLStreamReader reader)
                                throws javax.xml.stream.XMLStreamException

Skip comments, processing instructions, and whitespace until the next START_ELEMENT, END_ELEMENT, or END_DOCUMENT is found. Throw an exception if some other event is found.

Returns:

Throws:

javax.xml.stream.XMLStreamException

readContent

public static java.lang.String readContent(javax.xml.stream.XMLStreamReader reader)
                                    throws javax.xml.stream.XMLStreamException

Read content for the current element into a raw XML string. The reader should be at the START_ELEMENT event of the element whose content should be read. This method effectively round-trips the XML, so that the XML returned may not exactly match the XML read.

Parameters:

reader - The reader to read from.

Returns:

Throws:

javax.xml.stream.XMLStreamException

readElementAndContent

public static java.lang.String readElementAndContent(javax.xml.stream.XMLStreamReader reader)
                                              throws javax.xml.stream.XMLStreamException

Read the current element and all of its content into a String. This method effectively round-trips the XML, so that the XML returned may not exactly match the XML read.

Parameters:

reader - The reader to read from. Current event must be START_ELEMENT

Returns:

Throws:

javax.xml.stream.XMLStreamException

readXsiType

public static javax.xml.namespace.QName readXsiType(javax.xml.stream.XMLStreamReader reader)
                                             throws XBException

Return the QName (or null) for the xsi:type attribute.

Throws:

XBException

skipToEndElement

public static void skipToEndElement(javax.xml.stream.XMLStreamReader reader)
                             throws XBException

Skip all events until an end element is found that closes the start element under which the current event is nested. Note: If the current event is a start element, and you want to find the matching end element, call reader.next() and then call this method. Note: If the current event (possibly a start element) is nested under some element S and you want to find the end element that closes S, simply call this method.

Parameters:

reader -

Throws:

XBException

checkEmptyElement

public static boolean checkEmptyElement(javax.xml.stream.XMLStreamReader reader)

This is a placeholder method that's needed for generated C# code, but not for generated Java code. Java's XML parsing generates an END_ELEMENT for empty elements, but C#'s does not. With C# the determination of whether an element is empty or not must be done while we're sitting at C#'s equivalent of START_ELEMENT. This method always returns false, even if the element is empty, so the generated code will work properly.

Parameters:

reader - the reader instance

Returns:

always false