io.lighty.codecs.api

Interface NodeConverter

All Known Implementing Classes:

JsonNodeConverter, XmlNodeConverter

public interface NodeConverter

This interface may be useful when (de)serializing NormalizedNodes (from)into its XML or JSON representation. Currently there are two implementations XmlNodeConverter and JsonNodeConverter.

Method Summary

Modifier and Type	Method and Description
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	deserialize(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode, Reader inputData) This method will deserialize the given input data into NormalizedNodes.
Writer	serializeData(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode) This method will serialize the given NormalizedNode into its string representation.
Writer	serializeRpc(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode) This method will serialize the input NormalizedNode RPC into its string representation.

Method Detail

serializeData

Writer serializeData(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode,
                     org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)
              throws SerializationException

This method will serialize the given NormalizedNode into its string representation.

Parameters:

schemaNode - parent schema node used during serialization

normalizedNode - normalized nodes to be serialized

Returns:

Writer

Throws:

SerializationException - may be throws while serializing data

See Also:

ConverterUtils.getSchemaNode(SchemaContext, QName)

serializeRpc

Writer serializeRpc(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode,
                    org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)
             throws SerializationException

This method will serialize the input NormalizedNode RPC into its string representation. It is highly recommend to use ConverterUtils.loadRpc(SchemaContext, QName) and proper input/output definition as the schemaNode parameter.

Parameters:

schemaNode - parent schema node which may be obtained via ConverterUtils.loadRpc(SchemaContext, QName) and input/output definition

normalizedNode - normalized nodes to be serialized

Returns:

string representation of the given nodes starting with input or output tag

Throws:

SerializationException - thrown in case serialization fails.

See Also:

ConverterUtils.rpcAsInput(XmlElement), ConverterUtils.rpcAsOutput(XmlElement), ConverterUtils.getRpcQName(XmlElement)

deserialize

org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> deserialize(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode,
                                                                                Reader inputData)
                                                                         throws SerializationException

This method will deserialize the given input data into NormalizedNodes. In case of RPC input/output use proper parent schema node obtained via ConverterUtils.loadRpc(SchemaContext, QName).

Parameters:

schemaNode - parent schema node

inputData - string representation of input/output RPC or data. In case of RPC the inputData MUST start with input tag (in case of XML) and object (in case of JSON). The same goes for RPC output

Returns:

deserialized NormalizedNodes

Throws:

SerializationException - is thrown in case of an error during deserialization

See Also:

ConverterUtils.loadRpc(SchemaContext, QName), ConverterUtils.rpcAsInput(XmlElement), ConverterUtils.rpcAsOutput(XmlElement)