org.opendaylight.yangtools.yang.data.impl.codec.xml

Class XmlStreamUtils

java.lang.Object

org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlStreamUtils

@Beta
public final class XmlStreamUtils
extends Object

Utility class for bridging JAXP Stream and YANG Data APIs. Note that the definition of this class by no means final and subject to change as more functionality is centralized here.

Method Summary

Modifier and Type	Method and Description
static XmlStreamUtils	create(XmlCodecProvider codecProvider) Create a new instance encapsulating a particular codec provider.
static XmlStreamUtils	create(XmlCodecProvider codecProvider, SchemaContext schemaContext)
void	writeInstanceIdentifier(XMLStreamWriter writer, YangInstanceIdentifier value)
void	writeValue(XMLStreamWriter writer, SchemaNode schemaNode, Object value)
void	writeValue(XMLStreamWriter writer, SchemaNode schemaNode, Object value, com.google.common.base.Optional<QNameModule> parent) Write a value into a XML stream writer.
void	writeValue(XMLStreamWriter writer, SchemaNode schemaNode, Object value, QNameModule parent)
void	writeValue(XMLStreamWriter writer, TypeDefinition<?> type, Object value)
void	writeValue(XMLStreamWriter writer, TypeDefinition<?> type, Object value, com.google.common.base.Optional<QNameModule> parent) Write a value into a XML stream writer.
void	writeValue(XMLStreamWriter writer, TypeDefinition<?> type, Object value, QNameModule parent)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static XmlStreamUtils create(XmlCodecProvider codecProvider)

Create a new instance encapsulating a particular codec provider.

Parameters:

codecProvider - XML codec provider

Returns:

A new instance

create

public static XmlStreamUtils create(XmlCodecProvider codecProvider,
                                    SchemaContext schemaContext)

writeValue

public void writeValue(@Nonnull
                       XMLStreamWriter writer,
                       @Nonnull
                       SchemaNode schemaNode,
                       Object value,
                       com.google.common.base.Optional<QNameModule> parent)
                throws XMLStreamException

Write a value into a XML stream writer. This method assumes the start and end of element is emitted by the caller.

Parameters:

writer - XML Stream writer

schemaNode - Schema node that describes the value

value - data value

parent - optional parameter of a module QName owning the leaf definition

Throws:

XMLStreamException - if an encoding problem occurs

writeValue

public void writeValue(@Nonnull
                       XMLStreamWriter writer,
                       @Nonnull
                       SchemaNode schemaNode,
                       Object value)
                throws XMLStreamException

Throws:

XMLStreamException

writeValue

public void writeValue(@Nonnull
                       XMLStreamWriter writer,
                       @Nonnull
                       SchemaNode schemaNode,
                       Object value,
                       QNameModule parent)
                throws XMLStreamException

Throws:

XMLStreamException

writeValue

public void writeValue(@Nonnull
                       XMLStreamWriter writer,
                       @Nonnull
                       TypeDefinition<?> type,
                       Object value,
                       com.google.common.base.Optional<QNameModule> parent)
                throws XMLStreamException

Write a value into a XML stream writer. This method assumes the start and end of element is emitted by the caller.

Parameters:

writer - XML Stream writer

type - data type. In case of leaf ref this should be the type of leaf being referenced

value - data value

parent - optional parameter of a module QName owning the leaf definition

Throws:

XMLStreamException - if an encoding problem occurs

writeValue

public void writeValue(@Nonnull
                       XMLStreamWriter writer,
                       @Nonnull
                       TypeDefinition<?> type,
                       Object value,
                       QNameModule parent)
                throws XMLStreamException

Throws:

XMLStreamException

writeValue

public void writeValue(@Nonnull
                       XMLStreamWriter writer,
                       @Nonnull
                       TypeDefinition<?> type,
                       Object value)
                throws XMLStreamException

Throws:

XMLStreamException

writeInstanceIdentifier

public void writeInstanceIdentifier(XMLStreamWriter writer,
                                    YangInstanceIdentifier value)
                             throws XMLStreamException

Throws:

XMLStreamException