Package org.opendaylight.yangtools.util.xml

Class UntrustedXML

java.lang.Object

org.opendaylight.yangtools.util.xml.UntrustedXML

@Beta
public final class UntrustedXML
extends Object

Set of utility methods for instantiating parser that deal with untrusted XML sources.

Author:

Robert Varga

Method Summary

Modifier and Type	Method	Description
static @NonNull XMLStreamReader	createXMLStreamReader(InputStream stream)	Create a new XMLStreamReader for dealing with untrusted XML data.
static @NonNull XMLStreamReader	createXMLStreamReader(InputStream stream, Charset charset)	Create a new XMLStreamReader for dealing with untrusted XML data.
static @NonNull XMLStreamReader	createXMLStreamReader(Reader reader)	Create a new XMLStreamReader for dealing with untrusted XML data.
static @NonNull DocumentBuilder	newDocumentBuilder()	Create a new DocumentBuilder for dealing with untrusted XML data.
static @NonNull SAXParser	newSAXParser()	Create a new SAXParser for dealing with untrusted XML data.

Methods inherited from class java.lang.Object

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

Method Detail

newDocumentBuilder

public static @NonNull DocumentBuilder newDocumentBuilder()

Create a new DocumentBuilder for dealing with untrusted XML data. This method is equivalent to DocumentBuilderFactory.newDocumentBuilder(), except it does not throw a checked exception.

Returns:

A new DocumentBuilder

Throws:

UnsupportedOperationException - if the runtime fails to instantiate a good enough builder

newSAXParser

public static @NonNull SAXParser newSAXParser()

Create a new SAXParser for dealing with untrusted XML data. This method is equivalent to SAXParserFactory.newSAXParser(), except it does not throw a checked exception.

Returns:

A new SAXParser

Throws:

UnsupportedOperationException - if the runtime fails to instantiate a good enough builder

createXMLStreamReader

public static @NonNull XMLStreamReader createXMLStreamReader(InputStream stream)
                                                      throws XMLStreamException

Create a new XMLStreamReader for dealing with untrusted XML data. This method is equivalent to XMLInputFactory.createXMLStreamReader(InputStream).

Returns:

A new XMLStreamReader

Throws:

XMLStreamException - when the underlying factory throws it

createXMLStreamReader

public static @NonNull XMLStreamReader createXMLStreamReader(InputStream stream,
                                                             Charset charset)
                                                      throws XMLStreamException

Create a new XMLStreamReader for dealing with untrusted XML data. This method is equivalent to XMLInputFactory.createXMLStreamReader(InputStream, String), except it takes an explict charset argument.

Returns:

A new XMLStreamReader

Throws:

XMLStreamException - when the underlying factory throws it

createXMLStreamReader

public static @NonNull XMLStreamReader createXMLStreamReader(Reader reader)
                                                      throws XMLStreamException

Create a new XMLStreamReader for dealing with untrusted XML data. This method is equivalent to XMLInputFactory.createXMLStreamReader(Reader).

Returns:

A new XMLStreamReader

Throws:

XMLStreamException - when the underlying factory throws it