org.apache.cxf.staxutils
Class StaxUtils

java.lang.Object
  org.apache.cxf.staxutils.StaxUtils

public final class StaxUtils
extends java.lang.Object

Method Summary

static org.w3c.dom.Document	copy(org.w3c.dom.Document doc)
static void	copy(org.w3c.dom.Document doc, javax.xml.stream.XMLStreamWriter writer)
static void	copy(org.w3c.dom.Element node, javax.xml.stream.XMLStreamWriter writer)
static void	copy(javax.xml.stream.XMLStreamReader reader, javax.xml.stream.XMLStreamWriter writer) Copies the reader to the writer.
static void	copy(javax.xml.stream.XMLStreamReader reader, javax.xml.stream.XMLStreamWriter writer, boolean fragment)
static javax.xml.stream.XMLStreamReader	createFilteredReader(javax.xml.stream.XMLStreamReader reader, javax.xml.stream.StreamFilter filter)
static javax.xml.stream.XMLInputFactory	createXMLInputFactory(boolean nsAware) Return a new factory so that the caller can set sticky parameters.
static javax.xml.stream.XMLStreamReader	createXMLStreamReader(org.w3c.dom.Document doc)
static javax.xml.stream.XMLStreamReader	createXMLStreamReader(org.w3c.dom.Element el)
static javax.xml.stream.XMLStreamReader	createXMLStreamReader(java.io.InputStream in)
static javax.xml.stream.XMLStreamReader	createXMLStreamReader(java.io.InputStream in, java.lang.String encoding)
static javax.xml.stream.XMLStreamReader	createXMLStreamReader(java.io.Reader reader)
static javax.xml.stream.XMLStreamReader	createXMLStreamReader(javax.xml.transform.Source source)
static javax.xml.stream.XMLStreamWriter	createXMLStreamWriter(java.io.OutputStream out)
static javax.xml.stream.XMLStreamWriter	createXMLStreamWriter(java.io.OutputStream out, java.lang.String encoding)
static javax.xml.stream.XMLStreamWriter	createXMLStreamWriter(javax.xml.transform.Result r)
static javax.xml.stream.XMLStreamWriter	createXMLStreamWriter(java.io.Writer out)
static java.lang.String	getUniquePrefix(javax.xml.stream.XMLStreamWriter writer)
static java.lang.String	getUniquePrefix(javax.xml.stream.XMLStreamWriter writer, java.lang.String namespaceURI, boolean declare) Create a unique namespace uri/prefix combination.
static javax.xml.stream.XMLInputFactory	getXMLInputFactory() Return a cached, namespace-aware, factory.
static javax.xml.stream.XMLInputFactory	getXMLInputFactory(boolean nsAware) Return a cached factory.
static javax.xml.stream.XMLOutputFactory	getXMLOutputFactory()
static void	nextEvent(javax.xml.stream.XMLStreamReader dr)
static void	printXmlFragment(javax.xml.stream.XMLStreamReader reader)
static org.w3c.dom.Document	read(javax.xml.parsers.DocumentBuilder builder, javax.xml.stream.XMLStreamReader reader, boolean repairing)
static org.w3c.dom.Document	read(javax.xml.stream.XMLStreamReader reader)
static void	readDocElements(org.w3c.dom.Node parent, javax.xml.stream.XMLStreamReader reader, boolean repairing)
static javax.xml.namespace.QName	readQName(javax.xml.stream.XMLStreamReader reader) Reads a QName from the element text.
static boolean	skipToStartOfElement(DepthXMLStreamReader in)
static boolean	skipToStartOfElement(javax.xml.stream.XMLStreamReader in) Returns true if currently at the start of an element, otherwise move forwards to the next element start and return true, otherwise false is returned if the end of the stream is reached.
static boolean	toNextElement(DepthXMLStreamReader dr)
static boolean	toNextTag(DepthXMLStreamReader reader, javax.xml.namespace.QName endTag)
static boolean	toNextTag(javax.xml.stream.XMLStreamReader reader)
static boolean	toNextText(DepthXMLStreamReader reader)
static void	writeDocument(org.w3c.dom.Document d, javax.xml.stream.XMLStreamWriter writer, boolean repairing)
static void	writeDocument(org.w3c.dom.Document d, javax.xml.stream.XMLStreamWriter writer, boolean writeProlog, boolean repairing)
static void	writeElement(org.w3c.dom.Element e, javax.xml.stream.XMLStreamWriter writer, boolean repairing) Writes an Element to an XMLStreamWriter.
static void	writeElement(org.w3c.dom.Element e, javax.xml.stream.XMLStreamWriter writer, boolean repairing, boolean endElement) Writes an Element to an XMLStreamWriter.
static void	writeEvent(javax.xml.stream.events.XMLEvent event, javax.xml.stream.XMLStreamWriter writer)
static void	writeNode(org.w3c.dom.Node n, javax.xml.stream.XMLStreamWriter writer, boolean repairing)
static void	writeStartElement(javax.xml.stream.XMLStreamWriter writer, java.lang.String prefix, java.lang.String name, java.lang.String namespace)

Methods inherited from class java.lang.Object

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

Method Detail

getXMLInputFactory

public static javax.xml.stream.XMLInputFactory getXMLInputFactory()

Return a cached, namespace-aware, factory.

Returns:

getXMLInputFactory

public static javax.xml.stream.XMLInputFactory getXMLInputFactory(boolean nsAware)

Return a cached factory.

Parameters:

nsAware -

Returns:

createXMLInputFactory

public static javax.xml.stream.XMLInputFactory createXMLInputFactory(boolean nsAware)

Return a new factory so that the caller can set sticky parameters.

Parameters:

nsAware -

Returns:

getXMLOutputFactory

public static javax.xml.stream.XMLOutputFactory getXMLOutputFactory()

createXMLStreamWriter

public static javax.xml.stream.XMLStreamWriter createXMLStreamWriter(java.io.Writer out)

createXMLStreamWriter

public static javax.xml.stream.XMLStreamWriter createXMLStreamWriter(java.io.OutputStream out)

createXMLStreamWriter

public static javax.xml.stream.XMLStreamWriter createXMLStreamWriter(java.io.OutputStream out,
                                                                     java.lang.String encoding)

createXMLStreamWriter

public static javax.xml.stream.XMLStreamWriter createXMLStreamWriter(javax.xml.transform.Result r)

createFilteredReader

public static javax.xml.stream.XMLStreamReader createFilteredReader(javax.xml.stream.XMLStreamReader reader,
                                                                    javax.xml.stream.StreamFilter filter)

nextEvent

public static void nextEvent(javax.xml.stream.XMLStreamReader dr)

toNextText

public static boolean toNextText(DepthXMLStreamReader reader)

toNextTag

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

toNextTag

public static boolean toNextTag(DepthXMLStreamReader reader,
                                javax.xml.namespace.QName endTag)

writeStartElement

public static void writeStartElement(javax.xml.stream.XMLStreamWriter writer,
                                     java.lang.String prefix,
                                     java.lang.String name,
                                     java.lang.String namespace)
                              throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

skipToStartOfElement

public static boolean skipToStartOfElement(javax.xml.stream.XMLStreamReader in)
                                    throws javax.xml.stream.XMLStreamException

Returns true if currently at the start of an element, otherwise move forwards to the next element start and return true, otherwise false is returned if the end of the stream is reached.

Throws:

javax.xml.stream.XMLStreamException

toNextElement

public static boolean toNextElement(DepthXMLStreamReader dr)

skipToStartOfElement

public static boolean skipToStartOfElement(DepthXMLStreamReader in)
                                    throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

copy

public static org.w3c.dom.Document copy(org.w3c.dom.Document doc)
                                 throws javax.xml.stream.XMLStreamException,
                                        javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.stream.XMLStreamException

javax.xml.parsers.ParserConfigurationException

copy

public static void copy(org.w3c.dom.Document doc,
                        javax.xml.stream.XMLStreamWriter writer)
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

copy

public static void copy(org.w3c.dom.Element node,
                        javax.xml.stream.XMLStreamWriter writer)
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

copy

public static void copy(javax.xml.stream.XMLStreamReader reader,
                        javax.xml.stream.XMLStreamWriter writer)
                 throws javax.xml.stream.XMLStreamException

Copies the reader to the writer. The start and end document methods must be handled on the writer manually. TODO: if the namespace on the reader has been declared previously to where we are in the stream, this probably won't work.

Parameters:

reader -

writer -

Throws:

javax.xml.stream.XMLStreamException

copy

public static void copy(javax.xml.stream.XMLStreamReader reader,
                        javax.xml.stream.XMLStreamWriter writer,
                        boolean fragment)
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeDocument

public static void writeDocument(org.w3c.dom.Document d,
                                 javax.xml.stream.XMLStreamWriter writer,
                                 boolean repairing)
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeDocument

public static void writeDocument(org.w3c.dom.Document d,
                                 javax.xml.stream.XMLStreamWriter writer,
                                 boolean writeProlog,
                                 boolean repairing)
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeElement

public static void writeElement(org.w3c.dom.Element e,
                                javax.xml.stream.XMLStreamWriter writer,
                                boolean repairing)
                         throws javax.xml.stream.XMLStreamException

Writes an Element to an XMLStreamWriter. The writer must already have started the document (via writeStartDocument()). Also, this probably won't work with just a fragment of a document. The Element should be the root element of the document.

Parameters:

e -

writer -

Throws:

javax.xml.stream.XMLStreamException

writeElement

public static void writeElement(org.w3c.dom.Element e,
                                javax.xml.stream.XMLStreamWriter writer,
                                boolean repairing,
                                boolean endElement)
                         throws javax.xml.stream.XMLStreamException

Writes an Element to an XMLStreamWriter. The writer must already have started the document (via writeStartDocument()). Also, this probably won't work with just a fragment of a document. The Element should be the root element of the document.

Parameters:

e -

writer -

endElement - true if the element should be ended

Throws:

javax.xml.stream.XMLStreamException

writeNode

public static void writeNode(org.w3c.dom.Node n,
                             javax.xml.stream.XMLStreamWriter writer,
                             boolean repairing)
                      throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

read

public static org.w3c.dom.Document read(javax.xml.stream.XMLStreamReader reader)
                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

read

public static org.w3c.dom.Document read(javax.xml.parsers.DocumentBuilder builder,
                                        javax.xml.stream.XMLStreamReader reader,
                                        boolean repairing)
                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

readDocElements

public static void readDocElements(org.w3c.dom.Node parent,
                                   javax.xml.stream.XMLStreamReader reader,
                                   boolean repairing)
                            throws javax.xml.stream.XMLStreamException

Parameters:

parent -

reader -

Throws:

javax.xml.stream.XMLStreamException

createXMLStreamReader

public static javax.xml.stream.XMLStreamReader createXMLStreamReader(java.io.InputStream in,
                                                                     java.lang.String encoding)

Parameters:

in -

encoding -

ctx -

Returns:

createXMLStreamReader

public static javax.xml.stream.XMLStreamReader createXMLStreamReader(java.io.InputStream in)

Parameters:

in -

Returns:

createXMLStreamReader

public static javax.xml.stream.XMLStreamReader createXMLStreamReader(org.w3c.dom.Element el)

createXMLStreamReader

public static javax.xml.stream.XMLStreamReader createXMLStreamReader(org.w3c.dom.Document doc)

createXMLStreamReader

public static javax.xml.stream.XMLStreamReader createXMLStreamReader(javax.xml.transform.Source source)

createXMLStreamReader

public static javax.xml.stream.XMLStreamReader createXMLStreamReader(java.io.Reader reader)

Parameters:

reader -

Returns:

readQName

public static javax.xml.namespace.QName readQName(javax.xml.stream.XMLStreamReader reader)
                                           throws javax.xml.stream.XMLStreamException

Reads a QName from the element text. Reader must be positioned at the start tag.

Throws:

javax.xml.stream.XMLStreamException

getUniquePrefix

public static java.lang.String getUniquePrefix(javax.xml.stream.XMLStreamWriter writer,
                                               java.lang.String namespaceURI,
                                               boolean declare)
                                        throws javax.xml.stream.XMLStreamException

Create a unique namespace uri/prefix combination.

Parameters:

nsUri -

Returns:

The namespace with the specified URI. If one doesn't exist, one is created.

Throws:

javax.xml.stream.XMLStreamException

getUniquePrefix

public static java.lang.String getUniquePrefix(javax.xml.stream.XMLStreamWriter writer)

printXmlFragment

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

writeEvent

public static void writeEvent(javax.xml.stream.events.XMLEvent event,
                              javax.xml.stream.XMLStreamWriter writer)
                       throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException