com.arjuna.webservices11.util

Class StreamHelper

java.lang.Object

com.arjuna.webservices11.util.StreamHelper

public class StreamHelper
extends Object

Helper class for Stream operations.

Author:

kevin

Constructor Summary

Constructors

Constructor and Description
StreamHelper()

Method Summary

Modifier and Type	Method and Description
static void	checkNextStartTag(XMLStreamReader streamReader, QName expected) Check the next start tag is as expected.
static boolean	checkParentFinished(XMLStreamReader streamReader) Check to see if the parent element is finished.
static void	checkTag(XMLStreamReader streamReader, QName expected) Compare the element tag with the expected qualified name.
static void	skipToNextStartElement(XMLStreamReader streamReader) Make sure the stream is at the start of the next element.
static void	skipToStartElement(XMLStreamReader streamReader) Make sure the stream is at the start of an element.
static void	writeAttribute(XMLStreamWriter out, QName attributeName, Object attributeValue) Write the attribute to the stream.
static void	writeAttribute(XMLStreamWriter out, QName attributeName, QName attributeValue) Write the attribute to the stream.
static void	writeAttribute(XMLStreamWriter out, QName attributeName, String attributeValue) Write the attribute to the stream.
static void	writeAttributes(XMLStreamWriter out, Map attributes) Write the attributes to the stream.
static void	writeEndElement(XMLStreamWriter out, String prefix, String namespaceURI) Write an end element removing the namespace binding if necessary
static void	writeNamespace(XMLStreamWriter out, String prefix, String namespaceURI) Write the namespace if necessary.
static void	writeQualifiedName(XMLStreamWriter out, QName qName) Write the QName to the stream as text.
static String	writeStartElement(XMLStreamWriter out, QName elementName) Write a start element with appropriate namespace declarations if necessary

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamHelper

public StreamHelper()

Method Detail

writeStartElement

public static String writeStartElement(XMLStreamWriter out,
                                       QName elementName)
                                throws XMLStreamException

Write a start element with appropriate namespace declarations if necessary

Parameters:

out - The output stream.

elementName - The element name.

Returns:

The previous namespace if written, null otherwise.

Throws:

XMLStreamException - for errors during writing.

writeEndElement

public static void writeEndElement(XMLStreamWriter out,
                                   String prefix,
                                   String namespaceURI)
                            throws XMLStreamException

Write an end element removing the namespace binding if necessary

Parameters:

out - The output stream.

prefix - The element prefix.

namespaceURI - The previous binding for the prefix.

Throws:

XMLStreamException - for errors during writing.

writeAttributes

public static void writeAttributes(XMLStreamWriter out,
                                   Map attributes)
                            throws XMLStreamException

Write the attributes to the stream.

Parameters:

out - The output stream.

attributes - The attributes.

Throws:

XMLStreamException - Thrown for errors during writing.

writeAttribute

public static void writeAttribute(XMLStreamWriter out,
                                  QName attributeName,
                                  Object attributeValue)
                           throws XMLStreamException

Write the attribute to the stream.

Parameters:

out - The output stream.

attributeName - The attribute name.

attributeValue - The attribute value.

Throws:

XMLStreamException - Thrown for errors during writing.

writeAttribute

public static void writeAttribute(XMLStreamWriter out,
                                  QName attributeName,
                                  QName attributeValue)
                           throws XMLStreamException

Write the attribute to the stream.

Parameters:

out - The output stream.

attributeName - The attribute name.

attributeValue - The attribute value as a QName.

Throws:

XMLStreamException - Thrown for errors during writing.

writeAttribute

public static void writeAttribute(XMLStreamWriter out,
                                  QName attributeName,
                                  String attributeValue)
                           throws XMLStreamException

Write the attribute to the stream.

Parameters:

out - The output stream.

attributeName - The attribute name.

attributeValue - The attribute value.

Throws:

XMLStreamException - Thrown for errors during writing.

writeQualifiedName

public static void writeQualifiedName(XMLStreamWriter out,
                                      QName qName)
                               throws XMLStreamException

Write the QName to the stream as text.

Parameters:

out - The output stream.

qName - The qualified name.

Throws:

XMLStreamException - Thrown for errors during writing.

writeNamespace

public static void writeNamespace(XMLStreamWriter out,
                                  String prefix,
                                  String namespaceURI)
                           throws XMLStreamException

Write the namespace if necessary.

Parameters:

out - The output stream.

prefix - The namespace prefix.

namespaceURI - The namespaceURI.

Throws:

XMLStreamException - Thrown for errors during writing.

skipToNextStartElement

public static void skipToNextStartElement(XMLStreamReader streamReader)
                                   throws XMLStreamException

Make sure the stream is at the start of the next element.

Parameters:

streamReader - The current stream reader.

Throws:

XMLStreamException - For parsing errors.

skipToStartElement

public static void skipToStartElement(XMLStreamReader streamReader)
                               throws XMLStreamException

Make sure the stream is at the start of an element.

Parameters:

streamReader - The current stream reader.

Throws:

XMLStreamException - For parsing errors.

checkNextStartTag

public static void checkNextStartTag(XMLStreamReader streamReader,
                                     QName expected)
                              throws XMLStreamException

Check the next start tag is as expected.

Parameters:

streamReader - The stream reader.

expected - The expected qualified name.

Throws:

XMLStreamException - For errors during parsing.

checkTag

public static void checkTag(XMLStreamReader streamReader,
                            QName expected)
                     throws XMLStreamException

Compare the element tag with the expected qualified name.

Parameters:

streamReader - The current stream reader.

expected - The expected qualified name.

Throws:

XMLStreamException - For errors during parsing.

checkParentFinished

public static boolean checkParentFinished(XMLStreamReader streamReader)
                                   throws XMLStreamException

Check to see if the parent element is finished.

Parameters:

streamReader - The stream reader.

Returns:

true if it is finished, false otherwise.

Throws:

XMLStreamException - For errors during parsing.